【JavaWeb】搭建一个简单的javaweb项目及相关内容分析

文章目录

1、简单项目搭建
2、web.xml文件中相关配置及加载顺序

2.1、web.xml文件中相关配置
2.2、web.xml中内容的加载顺序

1、简单项目搭建

使用Eclipse创建一个简单的web项目，只创建一个Servlet、一个Filter以及相关前端的页面用于测试

（1）使用Eclipse创建一个 “Dynamic Web project” 项目，步骤省略
（2）创建一个Filter类，代码如下：

public class JwtFilter implements Filter {
	@Override
	public void destroy() {}
	@Override
	public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
			throws IOException, ServletException {
		System.out.println("JwtFilter拦截！");
		chain.doFilter(request, response);
	}

	@Override
	public void init(FilterConfig filterConfig) throws ServletException {
		System.out.println("初始化JwtFilter！");
	}
}

（3）创建一个Servlet，用于执行逻辑代码，如下：

public class MainServlet extends HttpServlet{

	private static final long serialVersionUID = 1L;
	@Override
	public void init(ServletConfig config) throws ServletException {
		System.out.println("初始化Servlet!");
	}
	@Override
	protected void doGet(HttpServletRequest req, HttpServletResponse resp) 
	throws ServletException, IOException{
		Object name=req.getServletContext().getInitParameter("name");
		System.out.println(name);
		System.out.println("已经执行过来");
		req.getRequestDispatcher("/WEB-INF/htmls/first.html").forward(req, resp);
	}
}

（4）创建网站首页，以及要进行跳转测试的页面，如下：
首页 index.html

<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>Hello</title>
</head>
<body>
	欢迎来到<a >首页</a>
<form action="/javaweb/mainServlet">
	<input type="submit" value="提交"/>
</form>
</body>
</html>

跳转测试页面：first.html

<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>第一个页面</title>
</head>
<body>
	这是第一个页面
</body>
</html>

（5）构建web.xml文件，从而使我们的Filter、Servlet等能够被访问到

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns="http://xmlns.jcp.org/xml/ns/javaee"
	xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
	id="WebApp_ID" version="3.1">
	<display-name>javaweb</display-name>
	<!--配置项目的起始页-->
	<welcome-file-list>
		<welcome-file>index.html</welcome-file>
	</welcome-file-list>
	<!--配置Filter-->
	<filter>
		<filter-name>jwtFilter</filter-name>
		<filter-class>javaweb.filter.JwtFilter</filter-class>
	</filter>
	<!--配置Servlet-->
	<servlet>
		<servlet-name>mainServlet</servlet-name>
		<servlet-class>javaweb.servlet.MainServlet</servlet-class>
	</servlet>
	<!--配置Servlet-mapping-->
	<servlet-mapping>
		<!--要与上边配置的Servlet名字保持一致-->
		<servlet-name>mainServlet</servlet-name>
		<!--当请求路径中为/mainServlet（名字可以随意起）时，即为访问servlet-name对应的Servlet-->
		<url-pattern>/mainServlet</url-pattern>
	</servlet-mapping>
	
	<!--配置filter-mapping-->
	<filter-mapping>
		<filter-name>jwtFilter</filter-name>
		<!--当请求名为mainServlet的Servlet时，Filter起作用-->
		<servlet-name>mainServlet</servlet-name>
	</filter-mapping>
	
	<!--配置context-param-->
	<context-param>
		<param-name>name</param-name>
		<param-value>zhangsan</param-value>
	</context-param>
</web-app>

完成以上的配置以后项目就可以启动运行了；最终的项目结构如下图所示：
在这里插入图片描述

注意： WEB-INF中的内容是不能够被客户端直接进行请求访问的，这里我们为了测试Servlet请求访问WEB-INF中的文件，将跳转的html（first.html）放在了WEB-INF下。

2、web.xml文件中相关配置及加载顺序

2.1、web.xml文件中相关配置

本小节内容来参考博客：javaweb web.xml文件详解

web.xml是JavaWeb中必不可少的一个文件，在web.xml中可以方便的进行Listener、Filter、Servlet等的配置，接下来我们会对xml文件中的内容进行详细的介绍：
（1）schema
　　web.xml的模式文件是由Sun公司定义的，每个web.xml文件的根元素中，都必须标明这个 web.xml使用的是哪个模式文件。其它的元素都放在之中。

　<?xml version="1.0" encoding="UTF-8"?>
<web-app version="2.4" 
    xmlns="http://java.sun.com/xml/ns/j2ee" 
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee  http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd">
</web-app>

（2）icon Web应用图标
　　指出IDE和GUI工具用来表示Web应用的大图标和小图标。

<icon>
    <small-icon>/images/app_small.gif</small-icon>
    <large-icon>/images/app_large.gif</large-icon>
</icon>

（3）display-name Web应用名称
　　提供GUI工具可能会用来标记这个特定的Web应用的一个名称；

<display-name>Tomcat Example</display-name>

（4）disciption Web应用描述
　　给出于此相关的说明性文本

<disciption>Tomcat Example servlets and JSP pages.</disciption>

（5）context-param 上下文参数
　　声明应用范围内的初始化参数。它用于向 ServletContext提供键值对，即应用程序上下文信息。我们的listener, filter等在初始化时会用到这些上下文中的信息。
　　在servlet里面可以通过getServletContext().getInitParameter(“context/param”)得到。

<context-param>
    <param-name>ContextParameter</para-name>
    <param-value>test</param-value>
    <description>It is a test parameter.</description>
</context-param>

（6）filter 过滤器
　　将一个名字与一个实现javaxs.servlet.Filter接口的类相关联。

<filter>
    <filter-name>setCharacterEncoding</filter-name>
    <filter-class>com.myTest.setCharacterEncodingFilter</filter-class>
    <init-param>
        <param-name>encoding</param-name>
        <param-value>UTF-8</param-value>
    </init-param>
</filter>
<filter-mapping>
    <filter-name>setCharacterEncoding</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

（7）listener 监听器

<listener> 
    <listerner-class>com.listener.SessionListener</listener-class> 
</listener>

（8）servlet

<servlet></servlet> 用来声明一个servlet的数据，主要有以下子元素：
<servlet-name></servlet-name>指定servlet的名称
<servlet-class></servlet-class> 指定servlet的类名称
<jsp-file></jsp-file> 指定web站台中的某个JSP网页的完整路径
<init-param></init-param> 用来定义参数，可有多个init-param。在servlet类中通过getInitParamenter(String name)方法访问初始化参数
<load-on-startup></load-on-startup>指定当Web应用启动时，装载Servlet的次序。当值为正数或零时：Servlet容器先加载数值小的servlet，再依次加载其他数值大的servlet。当值为负或未定义：Servlet容器将在Web客户首次访问这个servlet时加载它。
<servlet-mapping></servlet-mapping> 用来定义servlet所对应的URL，包含两个子元素
<servlet-name></servlet-name> 指定servlet的名称
<url-pattern></url-pattern> 指定servlet所对应的URL

<!-- 基本配置 -->
<servlet>
    <servlet-name>snoop</servlet-name>
    <servlet-class>SnoopServlet</servlet-class>
</servlet>
<servlet-mapping>
    <servlet-name>snoop</servlet-name>
    <url-pattern>/snoop</url-pattern>
</servlet-mapping>
<!-- 高级配置 -->
<servlet>
    <servlet-name>snoop</servlet-name>
    <servlet-class>SnoopServlet</servlet-class>
    <init-param>
        <param-name>foo</param-name>
        <param-value>bar</param-value>
    </init-param>
    <run-as>
        <description>Security role for anonymous access</description>
        <role-name>tomcat</role-name>
    </run-as>
</servlet>
<servlet-mapping>
    <servlet-name>snoop</servlet-name>
    <url-pattern>/snoop</url-pattern>
</servlet-mapping>

（9）<session-config> 会话超时配置
　单位为分钟。

<session-config>
   <session-timeout>120</session-timeout>
</session-config>

（10）<mime-mapping>

 <mime-mapping>
   <extension>htm</extension>
   <mime-type>text/html</mime-type>
</mime-mapping>

（11）<welcome-file-list> 欢迎文件页

<welcome-file-list>
   <welcome-file>index.jsp</welcome-file>
   <welcome-file>index.html</welcome-file>
   <welcome-file>index.htm</welcome-file>
</welcome-file-list>

（12）<error-page> 错误页面

<!-- 1、通过错误码来配置error-page。当系统发生×××错误时，跳转到错误处理页面。 -->
<error-page>
   <error-code>404</error-code>
   <location>/NotFound.jsp</location>
</error-page>
<!-- 2、通过异常的类型配置error-page。当系统发生java.lang.NullException（即空指针异常）时，跳转到错误处理页面。 -->
<error-page>
   <exception-type>java.lang.NullException</exception-type>
   <location>/error.jsp</location>
</error-page>

（13）<jsp-config>设置jsp
　　<jsp-config> 包括 <taglib> 和 <jsp-property-group> 两个子元素。其中<taglib> 元素在JSP 1.2 时就已经存在；而<jsp-property-group> 是JSP 2.0 新增的元素。
　　
<jsp-property-group> 元素主要有八个子元素，它们分别为：

<description>：设定的说明
<display-name>：设定名称
<url-pattern>：设定值所影响的范围，如： /CH2 或 /*.jsp
<el-ignored>：若为 true，表示不支持 EL 语法
<scripting-invalid>：若为 true，表示不支持 <% scripting %>语法
<page-encoding>：设定 JSP 网页的编码
<include-prelude>：设置 JSP 网页的抬头，扩展名为 .jspf
<include-coda>：设置 JSP 网页的结尾，扩展名为 .jspf

<jsp-config>
    <taglib>
        <taglib-uri>Taglib</taglib-uri>
        <taglib-location>/WEB-INF/tlds/MyTaglib.tld</taglib-location>
    </taglib>
    <jsp-property-group>
        <description>Special property group for JSP Configuration JSP example.</description>
        <display-name>JSPConfiguration</display-name>
        <url-pattern>/jsp/* </url-pattern>
        <el-ignored>true</el-ignored>
        <page-encoding>GB2312</page-encoding>
        <scripting-invalid>true</scripting-invalid>
        <include-prelude>/include/prelude.jspf</include-prelude>
        <include-coda>/include/coda.jspf</include-coda>
    </jsp-property-group>
</jsp-config>

2.2、web.xml中内容的加载顺序

本小节内容参考：java web项目启动加载顺序

先上结论：
WEB工程加载顺序与元素节点在文件中的配置顺序无关，不会因为 filter 写在 listener 的前面而会先加载 filter，如果使用了Spring框架，spring中容器的加载会在Servlet之后；WEB容器的加载顺序是：ServletContext -> context-param -> listener -> filter -> servlet->spring。

web.xml加载过程：

启动WEB项目的时候,容器(如:Tomcat)会去读它的配置文件web.xml.读两个节点:
<listener></listener> 和 <context-param></context-param>
紧接着,容器创建一个ServletContext(上下文)，这个WEB项目所有部分都将共享这个上下文.
容器将<context-param></context-param>转化为键值对,并交给ServletContext.
容器创建<listener></listener>中的类实例，即创建监听.
在监听中会有contextInitialized(ServletContextEvent args)初始化方法，在这个方法中获得：
ServletContext = ServletContextEvent.getServletContext();
context-param的值 = ServletContext.getInitParameter(“context-param的键”);
得到这个context-param的值之后，你就可以做一些操作了。注意，这个时候你的WEB项目还没有完全启动完成，这个动作会比所有的Servlet都要早。换句话说，这个时候,你对<context-param>中的键值做的操作,将在你的WEB项目完全启动之前被执行。
- 举例：你可能想在项目启动之前就打开数据库；那么这里就可以在<context-param>中设置数据库的连接方式,在监听类中初始化数据库的连接；这个监听是自己写的一个类,除了初始化方法,它还有销毁方法.用于关闭应用前释放资源.比如说数据库连接的关闭。

【加载spring】
比如filter 需要用到 bean ，但加载顺序是：先加载filter 后加载spring，则filter中初始化操作中的bean为null； 所以，如果过滤器中要使用到 bean，可以将spring的加载改成 Listener的方式 :

<listener>  
        <listener-class>  
             org.springframework.web.context.ContextLoaderListener   
        </listener-class>  
</listener>

对于某类配置节而言，与它们出现的顺序是有关的。以 filter 为例，web.xml 中当然可以定义多个 filter，与 filter 相关的一个配置节是 filter-mapping，这里一定要注意，对于拥有相同 filter-name 的 filter 和 filter-mapping 配置节而言，filter-mapping 必须出现在 filter 之后，否则当解析到 filter-mapping 时，它所对应的 filter-name 还未定义。web 容器启动时初始化每个 filter 时，是按照 filter 配置节出现的顺序来初始化的，当请求资源匹配多个 filter-mapping 时，filter 拦截资源是按照 filter-mapping 配置节出现的顺序来依次调用 doFilter() 方法的。