web.xml解析（1）

一、节点说明

1、根节点

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

</web-app>

 

2、web应用名称

<display-name>test-web</display-name>

 <display-name>：定义了web应用的名称，项目运行时可以在在http://localhost:8080/manager/html中显示

 

3、contex-param

<context-param>
	<param-name>webAppRootKey</param-name>
	<param-value>webApp.root</param-value>
</context-param>

<context-param></context-param>为整个web项目的上下文初始化参数，存在于项目的整个生命周期中。

param-name ：上下文的参数名称，必须是唯一名称。

param-value ：参数名称的值。

 

4、listener

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

Listener即监听器，可以监听客户端的请求、服务端的操作等。通过监听器，可以自动激发一些操作。配置Listener只需在web.xml中使用<listener>即可，listener-class指定实现类，服务器启动时会自动实例化Listerner。

Listener根据实现的接口不同，具有不同的功能，基本可以分为三类ServletContext，HttpSession，ServletRequest。

 

其中比较重要且常用的接口方法：

①、HttpSessionListener

sessionCreated()：监听session的创建

sessionDestroyed()：监听session的销毁

两个方法均包含类型为HttpSessionEvent的参数。通过其getSession()方法可以获得当前session对象

②、HttpSessionAttributeListener

attributeAdded ()：监听session属性的添加

attributeReplaced()：监听session属性的替换

attributeRemoved()：监听session属性的移除

三个方法均包含类型为HttpSessionBindingEvent的参数。通过其getName()方法可以获得属性名称；通过getValue()方法可以获得属性值。

 

5、filter

<filter>
	<filter-name>characterEncodingFilter</filter-name>
	<filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
	<init-param>
		<param-name>encoding</param-name>
		<param-value>UTF-8</param-value>
	</init-param>
	<init-param>
		<param-name>forceEncoding</param-name>
		<param-value>true</param-value>
	</init-param>
</filter>
<filter-mapping>
	<filter-name>characterEncodingFilter</filter-name>
	<url-pattern>/*</url-pattern>
</filter-mapping>

Filter即过滤器，过滤器在request到达Servlet之前，拦截request，根据需要检查或修改request。并且在response到达客户端之前，拦截response，检查或修改response。

<filter-name>：指定过滤器名字，必须是唯一的。

<filter-class>：指定过滤器的全限定名，即实现类。

<init-param>：过滤器的配置参数，可以有多组参数，都通过<param-name>与 <param-value>来指定参数名和参数值。

<filter-mapping>：过滤器的映射，映射中的<filter-name>与过滤器中的名称相同，为对应关系。<url-pattern>指定了过滤器拦截的路径。

 

所有Servlet过滤器类必须实现javax.servlet.Filter接口。

该接口有3个必须实现的方法：

①init(FilterConfig)：过滤器初始化方法，服务器启动时创建过滤器实例时自动调用该方法，并且只执行一次。方法可以读取web.xml文件中过滤器的初始化参数。

②doFilter(ServletRequest,ServletResponse,FilterChain)：完成实际的过滤操作，每次有客户端请求时都会被调用。如果该请求不合法则阻塞该请求；如果该请求合法则可通过FilterChain参数将request递交给FilterChain中下一个Filter，如果所有的Filter都走完了则交给Servlet处理。

③destroy()：服务器停止时在销毁过滤器实例前调用，释放过滤器占用的资源。

 

6、servlet

<servlet>
	<servlet-name>appServlet</servlet-name>
	<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
	<init-param>
		<param-name>contextConfigLocation</param-name>
		<param-value>classpath:META-INF/servlet-context.xml</param-value>
	</init-param>
	<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
	<servlet-name>appServlet</servlet-name>
	<url-pattern>/</url-pattern>
</servlet-mapping>

实现了servlet接口的Java类，称之为Servlet。

<servlet-name>：指定servlet名称，必须是唯一的。

<servlet-class>：指定servlet全限定名，即实现类。

<init-param>：servlet的配置参数，参数名与参数值的对应关系，与过滤器相同。<param-name>为参数名，<param-value>为对应的配置文件路径。

<load-on-startup>：标记容器是否在启动的时候就加载这个servlet，当值为大于等于0的整数是，则启动时加载。反之则在servlet被选择时再进行加载。

<servlet-mapping>：servlet的映射，<servlet-name>必须与之前配置的servlet一致，<url-pattern>指定相对于Servlet的URL的路径。该路径相对于web应用程序上下文的根路径。<servlet-mapping>将URL模式映射到某个Servlet，即该Servlet处理的URL。

 

Servlet接口中有3个方法代表了Servlet的生命周期：

①init(ServletConfig servletConfig)：初始化Servlet对象。在服务器装入Servlet实例时执行。在Servlet的生命周期中仅执行一次。无论有多少客户端访问Servlet，都不会重复执行。

②service(ServletRequest servletrequest, ServletResponse servletresponse)：负责处理请求，无论请求方式是get还是post ，每次请求提交过来都会经过service方法来处理，然后转向到doGet或是doPost方法。

③：destroy()：负责释放资源，在关闭Web应用之时销毁Servlet。方法仅执行一次，在服务器停止且卸载Servlet时执行。

 

二、配置加载顺序

知道了配置文件中各个节点的含义与作用，还需要知道它到底是怎样发挥作用、通过什么顺序来加载运行的。

 

1、启动web项目时，容器(tomcat等)会读取项目配置文件，也就是web.xml。若配置文件加载成功，则项目正常启动。

2、读取配置文件时，<context-param>与<listener>这两个节点会被最先读取。

3、容器创建一个ServletContext（Application），存在于项目的整个生命周期中，初始化参数名称与值即为<context-param>的<param-name>与<param-value>。

4、容器创建<listener>实例，根据我们配置的<listener-class>来创建监听器；接着容器会创建<filter>实例，根据我们配置的<filter-class>来创建过滤器。

5、在项目未完全启动时上述配置就已经加载完成，若<servlet>进行了配置，则会在项目启动时一并加载对应servlet，否则将在第一次发起请求时初始化servlet。

6、若存在多个相同节点时，则按照他们在配置文件中的先后顺序加载；且相关的映射应出现在对应配置的后面，如<filter-mapping>与<servlet-mapping>；当请求匹配到多个映射关系时，按照映射出现的顺序初始化。

7、总结：web.xml配置加载顺序：<context-param>——<listener>——<filter>——<servlet>，相同节点按先后顺序加载。