javaweb项目中关于配置文件web.xml的解析

一、.启动tomcat，加载项目中的web.xml文件，创建servercontext上下文对象。

可以通过servercontext对象在应用中获取web.xml文件中的值。

web应用加载的顺序与元素节点在文件中的配置顺序无关，web容器的加载顺序是ServletContext -> context-param -> listener -> filter -> servlet

加载过程顺序如下：

1. 启动一个WEB项目的时候，WEB容器会去读取它的配置文件web.xml，读取<listener>和<context-param>两个结点。
2. 紧急着，容创建一个ServletContext（servlet上下文），这个web项目的所有部分都将共享这个上下文。
3. 容器将<context-param>转换为键值对，并交给servletContext。
4. 容器创建<listener>中的类实例，创建监听器。

二、web.xml文件中各节点的解析

1、schema

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

<?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>

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

3、Mapping规则

　　当一个请求发送到servlet容器的时候，容器先会将请求的url减去当前应用上下文的路径作为servlet的映射url，比如我访问的是http://localhost/test/aaa.html，我的应用上下文是test，容器会将http://localhost/test去掉，剩下的/aaa.html部分拿来做servlet的映射匹配。这个映射匹配过程是有顺序的，而且当有一个servlet匹配成功以后，就不会去理会剩下的servlet了。

　　其匹配规则和顺序如下：

1. 精确路径匹配。例子：比如servletA 的url-pattern为 /test，servletB的url-pattern为 /* ，这个时候，如果我访问的url为http://localhost/test ，这个时候容器就会先 进行精确路径匹配，发现/test正好被servletA精确匹配，那么就去调用servletA，也不会去理会其他的servlet了。
2. 最长路径匹配。例子：servletA的url-pattern为/test/*，而servletB的url-pattern为/test/a/*，此时访问http://localhost/test/a时，容器会选择路径最长的servlet来匹配，也就是这里的servletB。
3. 扩展匹配，如果url最后一段包含扩展，容器将会根据扩展选择合适的servlet。例子：servletA的url-pattern：*.action

　　以”/’开头和以”/*”结尾的是用来做路径映射的。以前缀”*.”开头的是用来做扩展映射的。所以，为什么定义”/*.action”这样一个看起来很正常的匹配会错？因为这个匹配即属于路径映射，也属于扩展映射，导致容器无法判断。

三、web.xml实例

<?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>AdminToolWebService</display-name>
　　<servlet>
　　　　<servlet-name>Tiles Dispatch Servlet</servlet-name>
　　　　<servlet-class>org.apache.tiles.web.util.TilesDispatchServlet</servlet-class>
　　</servlet>
　　<servlet-mapping>
　　　　<servlet-name>Tiles Dispatch Servlet</servlet-name>
　　　　<url-pattern>*.tiles</url-pattern>
　　</servlet-mapping>

　　<servlet>
　　　　<servlet-name>ImageServlet</servlet-name>
　　　　<servlet-class>net.sf.jasperreports.j2ee.servlets.ImageServlet</servlet-class>
　　</servlet>
　　<servlet-mapping>
　　　　<servlet-name>ImageServlet</servlet-name>
　　　　<url-pattern>/service/reportImages</url-pattern>
　　</servlet-mapping> 

　　<!-- Srping MVC -->
　　<servlet>
　　　　<servlet-name>spring</servlet-name>
　　　　<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
　　　　<load-on-startup>1</load-on-startup>
　　</servlet>
　　<servlet-mapping>
　　　　<servlet-name>spring</servlet-name>
　　　　<url-pattern>/</url-pattern>
　　</servlet-mapping>
　　<context-param>
　　　　<param-name>logbackConfigLocation</param-name>
　　　　<param-value>classpath:logback.xml</param-value>
　　</context-param>
　　<listener>
　　　　<listener-class>ch.qos.logback.ext.spring.web.LogbackConfigListener</listener-class>
　　</listener>
　　<!--
　　<listener>
　　　　<listener-class>com.ricoh.rapp.ezcx.admintoolweb.listener.ContextDestroyListener</listener-class>
　　</listener>
　　-->
　　<listener>
　　　　<listener-class>com.ricoh.rapp.ezcx.admintoolweb.interceptor.CusSessionListener</listener-class>
　　</listener>

　　<!-- Do not use default webapp.root, it will be duplicated with AdminTool Web Service -->
　　<context-param>
　　　　<param-name>webAppRootKey</param-name>
　　　　<param-value>admintoolwebservice.root</param-value>
　　</context-param>

　　<filter>
　　　　<filter-name>encodingFilter</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>encodingFilter</filter-name>
　　　　<url-pattern>/*</url-pattern>
　　</filter-mapping>
　　<welcome-file-list>
　　　　<welcome-file>index.jsp</welcome-file>
　　</welcome-file-list>

　　<servlet-mapping>
　　　　<servlet-name>default</servlet-name>
　　　　<url-pattern>*.css</url-pattern>
　　</servlet-mapping>
　　<servlet-mapping>
　　　　<servlet-name>default</servlet-name>
　　　　<url-pattern>*.js</url-pattern>
　　</servlet-mapping>

　　<error-page>
　　　　<error-code>405</error-code>
　　　　<location>/index.jsp</location>
　　</error-page>
</web-app>