Maven系列--web.xml 配置详解

一 、web.xml介绍

1. 启动一个WEB项目的时候，WEB容器会去读取它的配置文件web.xml，读取<listener>和<context-param>两个结点。 

2. 紧接着，容器创建一个ServletContext（servlet上下文），这个web项目的所有部分都将共享这个上下文。 

3. 容器将<context-param>转换为键值对，并交给servletContext。 

4. 容器创建<listener>中的类实例，创建监听器。 

二、Load-on-startup

       Load-on-startup 元素在web应用启动的时候指定了servlet被加载的顺序，它的值必须是一个整数。如果它的值是一个负整数或是这个元素不存在，那么容器会在该servlet被调用的时候，加载这个servlet 。如果值是正整数或零，容器在配置的时候就加载并初始化这个servlet，容器必须保证值小的先被加载。如果值相等，容器可以自动选择先加载谁。

     在servlet的配置当中，<load-on-startup>5</load-on-startup>的含义是： 

     标记容器是否在启动的时候就加载这个servlet。

     当值为0或者大于0时，表示容器在应用启动时就加载这个servlet；当是一个负数时或者没有指定时，则指示容器在该servlet被选择时才加载。 

     正数的值越小，启动该servlet的优先级越高。 

三、加载顺序

       首先可以肯定的是，加载顺序与它们在 web.xml 文件中的先后顺序无关。即不会因为 filter 写在 listener 的前面而会先加载 filter。最终得出的结论是：ServletContext -> listener -> filter -> servlet

       同时还存在着这样一种配置节：context-param，它用于向 ServletContext 提供键值对，即应用程序上下文信息。我们的 listener, filter 等在初始化时会用到这些上下文中的信息，那么 context-param 配置节是不是应该写在 listener 配置节前呢？实际上 context-param 配置节可写在任意位置，因此真正的加载顺序为：context-param -> listener -> filter -> servlet

       对于某类配置节而言，与它们出现的顺序是有关的。以 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() 方法的。

       servlet 同 filter 类似，此处不再赘述。

      由此，可以看出，web.xml 的加载顺序是：ServletContext -> context-param -> listener -> filter -> servlet ，而同个类型之间的实际程序调用的时候的顺序是根据对应的 mapping 的顺序进行调用的。

四 、web.xml文件详解 

web.xml首先是肯定要包含它的schema：

<web-app 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/web-app_2_4.xsd"
    version="2.4">
</web-app>

其它的元素都放在<web-app></web-app>之中。

    <discription></discription>             ：是对站台的描述
    <display-name></display-name>    ：定义站台的名称
    <distributable/>                                ：是指定该站台是否可分布式处理
    <context-param></context-param>：用来设定web站台的环境参数，它包含两个子元素：
        <param-name></param-name>   ：用来指定参数的名称
        <param-value></param-value>    ：用来设定参数值

代码如下：

<context-param>
    <param-name>my_param</param-name>
    <param-value>hello</param-value>
</context-param>

在此设定的参数，可以在servlet中用 getServletContext().getInitParameter("my_param") 来取得

    <filter></filter>    ： 是用来声明filter的相关设定，它包含以下子元素：
        <filter-name></filter-name>    ： 这当然就是指定filter的名字
        <filter-class></filter-class>       ：这是用来定义filter的类的名称
    <init-param></init-param>： 用来定义参数，它有两个子元素：
        <param-name></param-name>： 用来指定参数的名称
        <param-value></param-value> ：用来设定参数值

代码如下：

<filter>
    <filter-name>setCharacterEncoding</filter-name>
    <filter-class>com.myTest.setCharacterEncodingFilter</filter-class>
    <init-param>
         <param-name>encoding</param-name>
         <param-value>GB2312</param-value>
    </init-param>
</filter>

与<filter></filter>同时使用的是<filter-mapping></filter-mapping> 用来定义filter所对应的URL，它有两个子元素：
    <filter-name></filter-name>：指定filter的名字
    <url-pattern></url-pattern>：指定filter所对应的URL

代码如下：

<filter-mapping>
        <filter-name>setCharacterEncoding</filter-name>
        <url-pattern>/*</url-pattern>
</filter-mapping>

       <listener></listener>：用来设定Listener接口，它的主要子元素为

            <listener-class></listener-class>：定义Listener的类名称

代码如下：

<listener>
    <listener-class>com.myTest.ContextListener</listener-class> 
</listener>

    <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></servlet>一起使用的是<servlet-mapping></servlet-mapping> 用来定义servlet所对应的URL，包含两个子元素：
        <servlet-name></s