web.xml文件详解

转自：http://www.cnblogs.com/hellojava/archive/2012/12/28/2835730.html

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>中的类实例，创建监听器。 

二、web.xml配置元素

1.<web-app>根元素

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

1. <web-app version="3.0" xmlns="http://java.sun.com/xml/ns/javaee"
2. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
3. xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
4. http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd">
5. </web-app>

2.<icon>Web应用图标

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

1. <icon>
2. <small-icon>/images/app_small.gif</small-icon>
3. <large-icon>/images/app_large.gif</large-icon>
4. </icon>

3.<display-name>Web应用名称

    提供GUI工具可能会用来标记这个特定的Web应用的一个名称。

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

4.<disciption>Web应用描述

    给出于此相关的说明性文本。

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

5.<context-param>上下文参数

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

1. <context-param>
2. <param-name>ContextParameter</para-name>
3. <param-value>test</param-value>
4. <description>It is a test parameter.</description>
5. </context-param>

6.<filter>过滤器

    将一个名字与一个实现javaxs.servlet.Filter接口的类相关联。

1. <filter>
2. <filter-name>setCharacterEncoding</filter-name>
3. <filter-class>com.myTest.setCharacterEncodingFilter</filter-class>
4. <init-param>
5. <param-name>encoding</param-name>
6. <param-value>UTF-8</param-value>
7. </init-param>
8. </filter>
9. <filter-mapping>
10. <filter-name>setCharacterEncoding</filter-name>
11. <url-pattern>/*</url-pattern>
12. </filter-mapping>

7.<listener>监听器

1. <listener>
2. <listener-class>com.listener.SessionListener</listener-class>
3. </listener>

8.<servlet>

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

 

1. <!-- 基本配置 -->
2. <servlet>
3. <servlet-name>snoop</servlet-name>
4. <servlet-class>SnoopServlet</servlet-class>
5. </servlet>
6. <servlet-mapping>
7. <servlet-name>snoop</servlet-name>
8. <url-pattern>/snoop</url-pattern>
9. </servlet-mapping>
10. <!-- 高级配置 -->
11. <servlet>
12. <servlet-name>snoop</servlet-name>
13. <servlet-class>SnoopServlet</servlet-class>
14. <init-param>
15. <param-name>foo</param-name>
16. <param-value>bar</param-value>
17. </init-param>
18. <run-as>
19. <description>Security role for anonymous access</description>
20. <role-name>tomcat</role-name>
21. </run-as>
22. </servlet>
23. <servlet-mapping>
24. <servlet-name>snoop</servlet-name>
25. <url-pattern>/snoop</url-pattern>
26. </servlet-mapping>

9.<session-config>会话超时配置

1. <session-config>
2. <session-timeout>120</session-timeout><!-- 单位为分钟 -->
3. </session-config>

10.<mime-mapping>

1. <mime-mapping>
2. <extension>htm</extension>
3. <mime-type>text/html</mime-type>
4. </mime-mapping>

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

1. <welcome-file-list>
2. <welcome-file>index.jsp</welcome-file>
3. <welcome-file>index.html</welcome-file>
4. </welcome-file-list>

12.<error-page>错误页面

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

13.<jsp-config>设置jsp

1. <jsp-config> 包括 <taglib>和<jsp-property-group>两个子元素。其中<taglib>元素在JSP1.2时就已经存在；而<jsp-property-group> 是JSP 2.0 新增的元素。
2. <jsp-property-group> 元素主要有八个子元素，它们分别为：
3. <description> 设定的说明
4. <display-name> 设定名称
5. <url-pattern> 设定值所影响的范围，如： /CH2 或 /*.jsp
6. <el-ignored> 若为 true，表示不支持 EL 语法
7. <scripting-invalid> 若为 true，表示不支持 <% scripting %>语法
8. <page-encoding> 设定 JSP 网页的编码
9. <include-prelude> 设置 JSP 网页的抬头，扩展名为 .jspf
10. <include-coda> 设置 JSP 网页的结尾，扩展名为 .jspf

 

1. <jsp-config>
2. <taglib>
3. <taglib-uri>Taglib</taglib-uri>
4. <taglib-location>/WEB-INF/tlds/MyTaglib.tld</taglib-location>
5. </taglib>
6. <jsp-property-group>
7. <description>Special property group for JSP Configuration JSP example.</description>
8. <display-name>JSPConfiguration</display-name>
9. <url-pattern>/jsp/* </url-pattern>
10. <el-ignored>true</el-ignored>
11. <page-encoding>GB2312</page-encoding>
12. <scripting-invalid>true</scripting-invalid>
13. <include-prelude>/include/prelude.jspf</include-prelude>
14. <include-coda>/include/coda.jspf</include-coda>
15. </jsp-property-group>
16. </jsp-config>

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

-------------------------------------------------------------------------------------------------------------------------------