web.xml 配置介绍

浏览数：18 / 时间：2015年06月09日

这个不是原创，有点早了，具体从哪里来的已经记不得了。但是东西是实实在在的。

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

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

3、容器将转换为键值对，并交给servletContext。

4、容器创建中的类实例，创建监听器。

二 Load-on-startup

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

在servlet的配置当中， 5 的含义是：

标记容器是否在启动的时候就加载这个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的元素整理了一下：

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

复制代码
1 2 xmlns:xsi=“http://www.w3.org/2001/XMLSchema-instance”
3 xsi:schemaLocation=“http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd”
4 version=“2.4”>
5
6
复制代码
其它的元素都放在之中。

是对站台的描述定义站台的名称是指定该站台是否可分布式处理

用来设定web站台的环境参数，它包含两个子元素：用来指定参数的名称用来设定参数值。比如：

1
2 my_param
3 hello
4
在此设定的参数，可以在servlet中用 getServletContext().getInitParameter(“my_param”) 来取得

是用来声明filter的相关设定，它包含以下子元素：

　　这当然就是指定filter的名字

　　这是用来定义filter的类的名称

用来定义参数，它有两个子元素：

　　用来指定参数的名称

　　用来设定参数值。

比如：

复制代码
1
2 setCharacterEncoding
3 com.myTest.setCharacterEncodingFilter
4
5 encoding
6 GB2312
7
8
复制代码
与同时使用的是用来定义filter所对应的URL，它有两个子元素：

　　指定filter的名字

　　指定filter所对应的URL。

比如：

1
2 setCharacterEncoding
3 /*
4
用来设定Listener接口，它的主要子元素为

　　定义Listener的类名称

比如：

1
2 com.myTest.ContextListener
3
用来声明一个servlet的数据，主要有以下子元素：

　　指定servlet的名称

　　指定servlet的类名称

　　指定web站台中的某个JSP网页的完整路径

　　用来定义参数，和前面的差不多

同样，与一起使用的是用来定义servlet所对应的URL，包含两个子元素：

　　指定servlet的名称

　　指定servlet所对应的URL

比如：

复制代码
1
2 ShoppingServlet
3 com.myTest.ShoppingServlet
4
5
6
7 ShoppingServlet
8 /shop/ShoppingServlet
9
复制代码
用来定义web站台中的session参数，包含一个子元素：

　　用来定义这个web站台所有session的有效期限，单位为分钟

定义某一个扩展名和某一个MIME Type做对映，包含两个子元素：

　　扩展名的名称

　　 MIME格式

比如：

复制代码
1
2 doc
3 application/vnd.ms-word
4
5
6 xls
7 application/vnd.ms-excel
8
复制代码
用来定义首页的列单，包含一个子元素：

　　指定首页的文件名称

比如：

1
2 index.jsp
3 index.html
4
用来处理错误代码或异常的页面，有三个子元素：

　　指定错误代码

　　指定一个JAVA异常类型

　　指定在web站台内的相关资源路径

比如：

复制代码
1
2 404
3 /error404.jsp
4
5
6 java.lang.Exception
7 /exception.jsp
8
复制代码
用来设定JSP网页所用到的Tag Library路径，有两个子元素：

　　定义TLD文件的URI，在JSP网页中用taglib指令便可取得该URI的TLD文件

　　指定TLD文件相对于web站台的存放位置

比如：

1
2 myTaglib
3 /WEB-INF/tlds/MyTaglib.tld
4
定义利用JNDI取得站台可利用的资源，有五个子元素：

　　资源说明

　　资源名称

　　资源种类

　　资源经由Application或Container来许可

　　资源是否可以共享，有Shareable和Unshareable两个值，默认为Shareable

比如，配置数据库连接池就可在此配置：

复制代码
1
2 JNDI JDBC DataSource of shop
3 jdbc/sample_db
4 javax.sql.DataSource
5 Container
6
复制代码
包括和两个子元素。

其中元素在JSP 1.2时就已经存在；而是JSP 2.0 新增的元素。

元素主要有八个子元素，它们分别为：

1. ：设定的说明；

2. ：设定名称；

3. ：设定值所影响的范围，如：/CH2 或 /*.jsp；

4. ：若为true，表示不支持EL 语法；

5. ：若为true，表示不支持<% scripting %>语法；

6. ：设定JSP 网页的编码；

7. ：设置JSP 网页的抬头，扩展名为.jspf；

8. ：设置JSP 网页的结尾，扩展名为.jspf。

一个简单的元素完整配置：

复制代码
1
2
3 Taglib
4 /WEB-INF/tlds/MyTaglib.tld
5
6
7 Special property group for JSP Configuration JSP example.
8 JSPConfiguration
9 /jsp/*
10 true
11 GB2312
12 true
13 /include/prelude.jspf
14 /include/coda.jspf
15
16
复制代码
配置web.xml来限制对某些servlet的请求

有时我们只希望通过认证的用户才能请求某些servlet的话，就可以在web.xml中来进行相应的配置，来达到此目的。

这就要用到元素。对于tomcat，中web.xml使用security-constraint元素需要在位于 /conf/tomcat-users.xml的XML文件中创建用户名和密码。比如下面的这个tomcat-users.xml文件：

复制代码
1
2
3
4
5
6
7
8
9
复制代码
此XML片段包括一个tomcat-users根元素，它包含一个或多个role和user元素。

然后在Web应用程序的web.xml中创建security-constraint、login-config和security-role元素。

复制代码
1
2
3 HelloServlet
4 /HelloServlet
5 GET
6 POST
7
8
9 This applies only to the “tomcat” security role
10 admin
11
12
13 NONE
14
15
16
17
18 BASIC
19
20
21 admin
22
复制代码
其中security-constraint元素包含一个或多个web-resource-collection元素，它是描述Web应用程序中的哪些web资源受到指定安全限制的保护。http-method元素指定安全限制覆盖的HTTP方法。上面的例子中，当我们对/HelloServlet的GET或POST请求时将触发配置的安全机制。 auth-constraint元素用于描述允许访问Web组件的安全角色。此例中安全角色的例子有tomcat、manager、admin。而只有当作为admin角色的用户才可以访问HelloServlet。

Web应用程序通过login-config元素来认证用户，并确认该用户是否为正确的角色。 longin-config包含的transport-guarantee子元素用来指定认证方法，BASIC是一种常见的Web认证方式，浏览器给用户提示一个对话框，要求输入用户名和密码，随后Tomcat将给出的用户名和密码与tomcat-users.xml中的用户名和密码进行比较，然后使用前面的security-constraint配置来确定用户是否可访问受保护的servlet。

（除BASIC外，还可以是FORM、CLIENT-CERT、DIGEST等）

其实这种认证方法实际上有两个步骤： 1、检查提供的用户名和密码是否正确。 2、判断用户是否映射到特定的安全角色。例如，用户可能提供了正确的用户名和密码，但没有映射到特定的安全角色，也将被禁止访问特定的Web资源。

五相应元素配置
1、Web应用图标：指出IDE和GUI工具用来表示Web应用的大图标和小图标

1
2 /images/app_small.gif
3 /images/app_large.gif
4
2、Web 应用名称：提供GUI工具可能会用来标记这个特定的Web应用的一个名称
< display-name>Tomcat Example
3、Web 应用描述：给出于此相关的说明性文本
< disciption>Tomcat Example servlets and JSP pages.
4、上下文参数：声明应用范围内的初始化参数。

1
2 ContextParameter
3 test
4 It is a test parameter.
5
在servlet里面可以通过getServletContext().getInitParameter(“context/param”)得到

5、过滤器配置：将一个名字与一个实现javaxs.servlet.Filter接口的类相关联。

复制代码
1
2 setCharacterEncoding
3 com.myTest.setCharacterEncodingFilter
4
5 encoding
6 GB2312
7
8
9
10 setCharacterEncoding
11 /*
12
复制代码
6、监听器配置

1
2 listener.SessionListener
3
7、Servlet配置

基本配置

复制代码
1
2 snoop
3 SnoopServlet
4
5
6 snoop
7 /snoop
8
复制代码
高级配置

复制代码
1
2 snoop
3 SnoopServlet
4
5 foo
6 bar
7
8
9 Security role for anonymous access
10 tomcat
11
12
13
14 snoop
15 /snoop
16
复制代码
元素说明

 <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

8、会话超时配置（单位为分钟）

1
2 120
3
9、MIME类型配置

1
2 htm
3 text/html
4
10、指定欢迎文件页配置

1
2 index.jsp
3 index.html
4 index.htm
5
11、配置错误页面
一、通过错误码来配置error-page

1
2 404
3 /NotFound.jsp
4
上面配置了当系统发生404错误时，跳转到错误处理页面NotFound.jsp。
二、通过异常的类型配置error-page

1
2 java.lang.NullException
3 /error.jsp
4
上面配置了当系统发生java.lang.NullException（即空指针异常）时，跳转到错误处理页面error.jsp
12、TLD配置

1
2 http://jakarta.apache.org/tomcat/debug-taglib
3 /WEB-INF/jsp/debug-taglib.tld
4
如果MyEclipse一直在报错,应该把放到中

复制代码
1
2
3 http://jakarta.apache.org/tomcat/debug-taglib
4 /WEB-INF/pager-taglib.tld
5
6
复制代码
13、资源管理对象配置

1
2 jms/StockQueue
3
14、资源工厂配置

1
2 mail/Session
3 javax.mail.Session
4 Container
5
配置数据库连接池就可在此配置：

复制代码
1
2 JNDI JDBC DataSource of shop
3 jdbc/sample_db
4 javax.sql.DataSource
5 Container
6
复制代码
15、安全限制配置

复制代码
1
2 Example Security Constraint
3
4 Protected Area
5 /jsp/security/protected/*
6 DELETE
7 GET
8 POST
9 PUT
10
11
12 tomcat
13 role1
14
15
复制代码
16、登陆验证配置

复制代码
1
2 FORM
3 Example-Based Authentiation Area
4
5 /jsp/security/protected/login.jsp
6 /jsp/security/protected/error.jsp
7
8
复制代码
17、安全角色：security-role元素给出安全角色的一个列表，这些角色将出现在servlet元素内的security-role-ref元素的role-name子元素中。分别地声明角色可使高级IDE处理安全信息更为容易。

1
2 tomcat
3
18、Web环境参数：env-entry元素声明Web应用的环境项

1
2 minExemptions
3 1
4 java.lang.Integer
5
19、EJB 声明

复制代码
1
2 Example EJB reference
3 ejb/Account
4 Entity
5 com.mycompany.mypackage.AccountHome
6 com.mycompany.mypackage.Account
7
复制代码
20、本地EJB声明

复制代码
1
2 Example Loacal EJB reference
3 ejb/ProcessOrder
4 Session
5 com.mycompany.mypackage.ProcessOrderHome
6 com.mycompany.mypackage.ProcessOrder
7
复制代码
21、配置DWR

复制代码
1
2 dwr-invoker
3 uk.ltd.getahead.dwr.DWRServlet
4
5
6 dwr-invoker
7 /dwr/*
8
复制代码
22、配置Struts

复制代码
1 Struts Blank Application
2
3 action
4
5 org.apache.struts.action.ActionServlet
6
7
8 detail
9 2
10
11
12 debug
13 2
14
15
16 config
17 /WEB-INF/struts-config.xml
18
19
20 application
21 ApplicationResources
22
23 2
24
25
26 action
27 *.do
28
29
30 index.jsp
31
32
33
34
35 struts-bean
36 /WEB-INF/tld/struts-bean.tld
37
38
39 struts-html
40 /WEB-INF/tld/struts-html.tld
41
42
43 struts-nested
44 /WEB-INF/tld/struts-nested.tld
45
46
47 struts-logic
48 /WEB-INF/tld/struts-logic.tld
49
50
51 struts-tiles
52 /WEB-INF/tld/struts-tiles.tld
53
复制代码
23、配置Spring（基本上都是在Struts中配置的）

复制代码
1
2
3 contextConfigLocation
4
5
6 /WEB-INF/applicationContext.xml, /WEB-INF/action-servlet.xml
7
8
9
10
11
12
13 org.springframework.web.context.ContextLoaderListener
14
15
16
17
18 org.springframework.web.context.request.RequestContextListener
19
20
复制代码
其他说明：

web.xml 文件中一般包括 servlet, spring, filter, listenr的配置。那么他们是按照一个什么顺序加载呢？加载顺序会影响对spring bean 的调用。
比如filter 需要用到 bean ，但是加载顺序是先加载filter 后加载spring，则filter中初始化操作中的bean为null；
首先可以肯定加载顺序与他们在web.xml 文件中的先后顺序无关。
web.xml 中 listener 和 serverlet 的加载顺序为先 listener 后serverlet
最终得出结果：先 listener ? filter ? servlet ? spring
所以，如果过滤器中要使用到 bean，可以将spring 的加载改成 Listener的方式
1
2
3 org.springframework.web.context.ContextLoaderListener
4
5
关于他们的内部执行顺序，也需要注意，如下面文章中遇到的问题

web.xml的filter执行顺序导致的乱码，切记！
发现引起bug的原因是web.xml的下面几行：
复制代码
1
2 SecurityFilter
3 .do
4
5
6
7 CharacterEncoding
8 .do
9
10
11
12 CharacterEncoding
13 .jsp
14
复制代码
根据servlet2.3规范filter执行是按照web.xml配置的filter-mapping先后顺序进行执行，所以上面的配置会导致遇见.do的url请求，先进行SecurityFilter的过滤器处理，这时候没有做编码处理，已经是乱码，到下面的filter处理时已经时乱码，再做编码处理已经没有用处。