web.xml文件详解（转）

原文链接：web.xml文件详解

参考：web.xml详解  利用maven/eclipse搭建ssm(spring+spring mvc+mybatis)

目录

 

一、web.xml文件介绍

二、web.xml配置元素

---

一、web.xml文件介绍

1.web.xml文件的作用

    web.xml主要用来配置Filter、Listener、Servlet等。但是要说明的是web.xml并不是必须的，一个web工程可以没有web.xml文件。

2.WEB容器的加载过程

    WEB容器的加载顺序是：ServletContext -> context-param -> listener -> filter -> servlet。在web.xml文件中最好按照这种顺序配置这些元素，以兼容较低版本的Tomcat。

3.WEB容器的启动过程

    WEB容器启动时，加载过程顺序如下：

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

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

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

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

        5.容器读取<filter></filter>，根据指定的类路径来实例化过滤器。

        以上都是在WEB项目还没有完全启动起来的时候就已经完成了的工作。如果系统中有Servlet，则Servlet是在第一次发起请求的时候被实例化的，而且一般不会被容器销毁，它可以服务于多个用户的请求。所以，Servlet的初始化都要比上面提到的那几个要迟。

        其中，如果web.xml中出现了相同的元素，则按照在配置文件中出现的先后顺序来加载。

二、web.xml配置元素

1.<web-app>根元素

    web.xml的模式文件是由Sun公司定义的，每个web.xml文件的根元素<web-app>中，都必须标明这个 web.xml使用的是哪个模式文件。其它的元素都放在<web-app></web-app>之中，<web-app>是根节点。

    <web-app version="3.0" xmlns="http://java.sun.com/xml/ns/javaee"
    	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    	xsi:schemaLocation="http://java.sun.com/xml/ns/javaee 
    	http://java.sun.com/xml/ns/javaee/web-app_3_0.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>

       <context-param>元素含有一对参数名和参数值，用作应用的Servlet上下文初始化参数，参数名在整个Web应用中必须是惟一的，在web应用的整个生命周期中上下文初始化参数都存在，任意的Servlet和jsp都可以随时随地访问它。<param-name>子元素包含有参数名，而<param-value>子元素包含的是参数值。作为选择，可用<description>子元素来描述参数。

      配置Spring，必须需要<listener>，而<context-param>可有可无，如果在web.xml中不写<context-param>配置信息，默认的路径是/WEB-INF/applicationContext.xml，在WEB-INF目录下创建的xml文件的名称必须是applicationContext.xml。如果是要自定义文件名可以在web.xml里加入contextConfigLocation这个context参数：在<param-value>里指定相应的xml文件名，如果有多个xml文件，可以写在一起并以“,”号分隔

 <context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>WEB-INF/applicationContext*.xml</param-value>
 </context-param>

6.<filter>过滤器（JavaWeb中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监听器）

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

8.<servlet>（web.xml和XXX-servlet.xml初始化上下文关系和区别）

      从Servlet3.0开始，配置Servlet有两种方式：

　　（1）在Servlet类中使用基于注解的方式进行配置：@WebServlet

　　（2）在web.xml文件中进行配置。

      我们用web.xml文件来配置Servlet，需要配置<servlet>和<servlet-mapping>。<servlet>用来声明一个Servlet。<icon>、<display-name>和<description>元素的用法和<filter>的用法相同。<init-param>元素与<context-param>元素具有相同的元素描述符，可以使用<init-param>子元素将初始化参数名和参数值传递给Servlet，访问Servlet配置参数通过ServletConfig对象来完成，ServletConfig提供如下方法：

　　java.lang.String.getInitParameter(java.lang.String name)：用于获取初始化参数

　　ServletConfig获取配置参数的方法和ServletContext获取配置参数的方法完全一样，只是ServletConfig是取得当前Servlet的配置参数，而ServletContext是获取整个web应用的配置参数。

    <servlet>           用来声明一个servlet的数据，主要有以下子元素：
    <servlet-name>      指定servlet的名称
    <servlet-class>     指定servlet的类名称
    <jsp-file>          指定web站台中的某个JSP网页的完整路径
    <init-param>        用来定义参数，可有多个init-param。
    <load-on-startup>   当值为正数或零时，从小到大加载。否则第一次访问时加载。
    <servlet-mapping>   用来定义servlet所对应的URL，包含两个子元素
    <servlet-name>      指定servlet的名称
    <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-list>

      <welcome-file-list>包含一个子元素<welcome-file>，<welcome-file>用来指定首页文件名称。

      <welcome-file-list>元素可以包含一个或多个<welcome-file>子元素。如果在第一个<welcome-file>元素中没有找到指定的文件，Web容器就会尝试显示第二个，以此类推。

12.<error-page>错误页面

    <!-- 1、通过错误码来配置error-page。当系统发生×××错误时，跳转到错误处理页面。 -->
    <error-page>
        <error-code>404</error-code>
        <location>/NotFound.jsp</location>
    </error-page>
    <!-- 2、通过异常的类型配置error-page。（即空指针异常）时，跳转到错误处理页面。 -->
    <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>元素在JSP1.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>

对于Web 应用程式来说，Scriptlet 是个不乐意被见到的东西，因为它会使得HTML 与Java 程式码交相混杂，对于程式的维护来说相当的麻烦，必要的时候，可以在web.xml 中加上<script-invalid> 标签，设定所有的JSP 网页都不可以使用Scriptlet。