web.xml详解

问题场景

　　最近项目在发布的时候出现了一个莫名其妙的错误：在websphere8.5上面可以部署但是不能正常访问，但是在tomcat和websphere7.0上面却可以正常部署访问。所报错误如下：

 1 [16-1-12 9:44:59:706 CST] 000000b2 LocalTranCoor E   WLTC0017E: 资源回滚，因为调用 setRollbackOnly()。
 2 [16-1-12 9:44:59:706 CST] 000000b2 webapp        E com.ibm.ws.webcontainer.webapp.WebApp logServletError SRVE0293E: [Servlet 错误]-[GenericServletWrapper]: java.lang.NullPointerException
 3     at com.ibm.ws.webcontainer.filter.WebAppFilterManager.getFilterChainContents(WebAppFilterManager.java:736)
 4     at com.ibm.ws.webcontainer.filter.WebAppFilterManager.getFilterChain(WebAppFilterManager.java:367)
 5     at com.ibm.ws.webcontainer.filter.WebAppFilterManager.doFilter(WebAppFilterManager.java:892)
 6     at com.ibm.ws.webcontainer.filter.WebAppFilterManager.invokeFilters(WebAppFilterManager.java:1025)
 7     at com.ibm.ws.webcontainer.webapp.WebApp.handleRequest(WebApp.java:3761)
 8     at com.ibm.ws.webcontainer.webapp.WebGroup.handleRequest(WebGroup.java:304)
 9     at com.ibm.ws.webcontainer.WebContainer.handleRequest(WebContainer.java:976)
10     at com.ibm.ws.webcontainer.WSWebContainer.handleRequest(WSWebContainer.java:1662)
11     at com.ibm.ws.webcontainer.channel.WCChannelLink.ready(WCChannelLink.java:200)
12     at com.ibm.ws.http.channel.inbound.impl.HttpInboundLink.handleDiscrimination(HttpInboundLink.java:459)
13     at com.ibm.ws.http.channel.inbound.impl.HttpInboundLink.handleNewRequest(HttpInboundLink.java:526)
14     at com.ibm.ws.http.channel.inbound.impl.HttpInboundLink.processRequest(HttpInboundLink.java:312)
15     at com.ibm.ws.http.channel.inbound.impl.HttpInboundLink.ready(HttpInboundLink.java:283)
16     at com.ibm.ws.tcp.channel.impl.NewConnectionInitialReadCallback.sendToDiscriminators(NewConnectionInitialReadCallback.java:214)
17     at com.ibm.ws.tcp.channel.impl.NewConnectionInitialReadCallback.complete(NewConnectionInitialReadCallback.java:113)
18     at com.ibm.ws.tcp.channel.impl.AioReadCompletionListener.futureCompleted(AioReadCompletionListener.java:175)
19     at com.ibm.io.async.AbstractAsyncFuture.invokeCallback(AbstractAsyncFuture.java:217)
20     at com.ibm.io.async.AsyncChannelFuture.fireCompletionActions(AsyncChannelFuture.java:161)
21     at com.ibm.io.async.AsyncFuture.completed(AsyncFuture.java:138)
22     at com.ibm.io.async.ResultHandler.complete(ResultHandler.java:204)
23     at com.ibm.io.async.ResultHandler.runEventProcessingLoop(ResultHandler.java:775)
24     at com.ibm.io.async.ResultHandler$2.run(ResultHandler.java:905)
25     at com.ibm.ws.util.ThreadPool$Worker.run(ThreadPool.java:1862)

　　刚开始以为是版本兼容性的问题，于是到网上各种找答案，还是不能解决。后来顺着filter这条线索发现，应该是拦截器的问题，最后定位到了了系统的拦截器的问题。在web.xml中<filter-mapping>中为<filter>设置了一个servlet例如：

 1 <filter-mapping>
 2     <filter-name>SetCharacterEncoding</filter-name>
 3     <servlet-name>action</servlet-name>
 4 </filter-mapping>
 5 <filter-mapping>
 6     <filter-name>SetCharacterEncoding</filter-name>
 7     <servlet-name>download</servlet-name>
 8 </filter-mapping>
 9 <filter-mapping>
10     <filter-name>SetCharacterEncoding</filter-name>
11     <servlet-name>import</servlet-name>
12 </filter-mapping>
13 .....
14 <servlet>
15     <servlet-name>download</servlet-name>
16     <servlet-class>类名</servlet-class>
17 </servlet>
18 <servlet-mapping>
19     <servlet-name>download</servlet-name>
20     <url-pattern>/download</url-pattern>
21 </servlet-mapping>
22 <servlet-mapping>
23     <servlet-name>download</servlet-name>
24     <url-pattern>/import</url-pattern>
25 </servlet-mapping

　　但是在<servlet>中却没有名为"import"的<servlet>的配置，所以导致了上面的错误。个人猜测可能是ws7.0和tomcat中对于请求，只有在需要的时候才会去加载filter下相应的<servlet>，而ws8.5在任何请求到来时都会加载filter下的所以<servlet>,所以导致了上面问题。后来看到这里，自己就对web.xml产生了浓厚的兴趣，然后对web.xml来一个彻底的研究。

简介

　　web.xml在项目启动的时候的加载顺序：1、web项目在启动的时候，会先加载web.xml的配置文件，来加载项目启动的配置信息。WEB容器会去读取它的配置文件web.xml，2、读取<listener>和<context-param>两个结点。 3、紧急着，容器创建一个ServletContext（servlet上下文），这个web项目的所有部分都将共享这个上下文。4、容器将<context-param>转换为键值对，并交给servletContext。5、创建<listener>中的类实例，创建监听器。 6、加载<filter>,初始化每个 filter 时，是按照 filter 配置节出现的顺序来初始化的，当请求资源匹配多个 filter-mapping 时，filter 拦截资源是按照 filter-mapping 配置节出现的顺序来依次调用 doFilter() 方法的。7、加载servlet，并且初始化相应的servlet。

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

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

　　相应的元素：

　　1、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>

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

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

　　3、Web 应用描述：给出于此相关的说明性文本

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

　　4、上下文参数：声明应用范围内的初始化参数。

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>

　　在servlet里面可以通过getServletContext().getInitParameter("context/param")得到。用来设定web站台的环境参数，它包含两个子元素：<param-name></param-name> 用来指定参数的名称和<param-value></param-value> 用来设定参数值。

　　5、过滤器配置：将一个名字与一个实现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>GB2312</param-value>    
 7         </init-param>    
 8 </filter>    
 9 <filter-mapping>    
10         <filter-name>setCharacterEncoding</filter-name>    
11         <url-pattern>/*</url-pattern>    
12 </filter-mapping>

　　6、监听器配置

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

　　7、Servlet配置
　　基本配置

1 <servlet>    
2       <servlet-name>snoop</servlet-name>    
3       <servlet-class>SnoopServlet</servlet-class>    
4 </servlet>    
5 <servlet-mapping>    
6       <servlet-name>snoop</servlet-name>    
7       <url-pattern>/snoop</url-pattern>    
8 </servlet-mapping>

　　高级配置

 1 <servlet>    
 2       <servlet-name>snoop</servlet-name>    
 3       <servlet-class>SnoopServlet</servlet-class>    
 4       <init-param>    
 5          <param-name>foo</param-name>    
 6          <param-value>bar</param-value>    
 7       </init-param>    
 8       <run-as>    
 9          <description>Security role for anonymous access</description>    
10          <role-name>tomcat</role-name>    
11       </run-as>    
12 </servlet>    
13 <servlet-mapping>    
14       <servlet-name>snoop</servlet-name>    
15       <url-pattern>/snoop</url-pattern>    
16 </servlet-mapping>

   　　元素说明
     <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 <session-config>    
2       　<session-timeout>120</session-timeout>    
3 </session-config>

　　9、MIME类型配置

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

　　<mime-mapping></mime-mapping> 定义某一个扩展名和某一个MIME Type做对映，包含两个子元素：<extension></extension> 扩展名的名称和<mime-type></mime-type> MIME格式。

　　10、指定欢迎文件页配置

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

　　11、配置错误页面
　　一、通过错误码来配置error-page

1 <error-page>    
2      　 <error-code>404</error-code>    
3       　<location>/NotFound.jsp</location>    
4 </error-page>

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

1 <error-page>    
2       　 <exception-type>java.lang.NullException</exception-type>    
3        　<location>/error.jsp</location>    
4 </error-page>

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

1 <taglib>    
2        　<taglib-uri>http://jakarta.apache.org/tomcat/debug-taglib</taglib-uri>    
3        　<taglib-location>/WEB-INF/jsp/debug-taglib.tld</taglib-location>    
4 </taglib>

　<taglib></taglib> 用来设定JSP网页所用到的Tag Library路径，有两个子元素：<taglib-uri></taglib-uri> 定义TLD文件的URI，在JSP网页中用taglib指令便可取得该URI的TLD文件，<taglib-location></taglib-location> 指定TLD文件相对于web站台的存放位置。

　　如果MyEclipse一直在报错,应该把<taglib> 放到 <jsp-config>中

1 <jsp-config>    
2       <taglib>    
3           <taglib-uri>http://jakarta.apache.org/tomcat/debug-taglib</taglib-uri>    
4           <taglib-location>/WEB-INF/pager-taglib.tld</taglib-location>    
5       </taglib>    
6 </jsp-config>

　　13、资源管理对象配置

1 <resource-env-ref>    
2        <resource-env-ref-name>jms/StockQueue</resource-env-ref-name>    
3 </resource-env-ref>

　　14、资源工厂配置

1 <resource-ref>    
2        <res-ref-name>mail/Session</res-ref-name>    
3        <res-type>javax.mail.Session</res-type>    
4        <res-auth>Container</res-auth>    
5 </resource-ref>

　<resource-ref></resource-ref> 定义利用JNDI取得站台可利用的资源，有五个子元素：

    　　<description></description> 资源说明
    　　<rec-ref-name></rec-ref-name> 资源名称
    　　<res-type></res-type> 资源种类
    　　<res-auth></res-auth> 资源经由Application或Container来许可
    <res-sharing-scope></res-sharing-scope> 资源是否可以共享，有Shareable和Unshareable两个值，默认为Shareable

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

1 <resource-ref>    
2        <description>JNDI JDBC DataSource of shop</description>    
3        <res-ref-name>jdbc/sample_db</res-ref-name>    
4        <res-type>javax.sql.DataSource</res-type>    
5        <res-auth>Container</res-auth>    
6 </resource-ref>

　　15、安全限制配置
　

 1 <security-constraint>    
 2       <display-name>Example Security Constraint</display-name>    
 3       <web-resource-collection>    
 4          <web-resource-name>Protected Area</web-resource-name>    
 5          <url-pattern>/jsp/security/protected/*</url-pattern>    
 6          <http-method>DELETE</http-method>    
 7          <http-method>GET</http-method>    
 8          <http-method>POST</http-method>    
 9          <http-method>PUT</http-method>    
10       </web-resource-collection>    
11       <auth-constraint>    
12         <role-name>tomcat</role-name>    
13         <role-name>role1</role-name>    
14       </auth-constraint>    
15 </security-constraint>

　　16、登陆验证配置
　

1 <login-config>    
2      　<auth-method>FORM</auth-method>    
3      　<realm-name>Example-Based Authentiation Area</realm-name>    
4      　<form-login-config>    
5         <form-login-page>/jsp/security/protected/login.jsp</form-login-page>    
6         <form-error-page>/jsp/security/protected/error.jsp</form-error-page>    
7      　</form-login-config>    
8 </login-config>

　　17、安全角色：security-role元素给出安全角色的一个列表，这些角色将出现在servlet元素内的security-role-ref元素的role-name子元素中。
分别地声明角色可使高级IDE处理安全信息更为容易。

1 <security-role>    
2      　<role-name>tomcat</role-name>    
3 </security-role>

　　其中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资源。

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

1 <env-entry>    
2      　<env-entry-name>minExemptions</env-entry-name>    
3      　<env-entry-value>1</env-entry-value>    
4      　<env-entry-type>java.lang.Integer</env-entry-type>    
5 </env-entry>

　　19、EJB 声明

<ejb-ref>    
     　<description>Example EJB reference</decription>    
     　<ejb-ref-name>ejb/Account</ejb-ref-name>    
     　<ejb-ref-type>Entity</ejb-ref-type>    
     　<home>com.mycompany.mypackage.AccountHome</home>    
     　<remote>com.mycompany.mypackage.Account</remote>    
</ejb-ref>

　　20、本地EJB声明

1 <ejb-local-ref>    
2      　<description>Example Loacal EJB reference</decription>    
3      　<ejb-ref-name>ejb/ProcessOrder</ejb-ref-name>    
4      　<ejb-ref-type>Session</ejb-ref-type>    
5      　<local-home>com.mycompany.mypackage.ProcessOrderHome</local-home>    
6      　<local>com.mycompany.mypackage.ProcessOrder</local>    
7 </ejb-local-ref>

　　21、配置DWR

1 <servlet>    
2       <servlet-name>dwr-invoker</servlet-name>    
3       <servlet-class>uk.ltd.getahead.dwr.DWRServlet</servlet-class>    
4 </servlet>    
5 <servlet-mapping>    
6       <servlet-name>dwr-invoker</servlet-name>    
7       <url-pattern>/dwr/*</url-pattern>    
8 </servlet-mapping>

　　22、配置Struts

 1 <display-name>Struts Blank Application</display-name>    
 2     <servlet>    
 3         <servlet-name>action</servlet-name>    
 4         <servlet-class>    
 5             org.apache.struts.action.ActionServlet    
 6         </servlet-class>    
 7         <init-param>    
 8             <param-name>detail</param-name>    
 9             <param-value>2</param-value>    
10         </init-param>    
11         <init-param>    
12             <param-name>debug</param-name>    
13             <param-value>2</param-value>    
14         </init-param>    
15         <init-param>    
16             <param-name>config</param-name>    
17             <param-value>/WEB-INF/struts-config.xml</param-value>    
18         </init-param>    
19         <init-param>    
20             <param-name>application</param-name>    
21             <param-value>ApplicationResources</param-value>    
22         </init-param>    
23         <load-on-startup>2</load-on-startup>    
24     </servlet>    
25     <servlet-mapping>    
26         <servlet-name>action</servlet-name>    
27         <url-pattern>*.do</url-pattern>    
28     </servlet-mapping>    
29     <welcome-file-list>    
30         <welcome-file>index.jsp</welcome-file>    
31     </welcome-file-list>    
32 
33     <!-- Struts Tag Library Descriptors -->    
34     <taglib>    
35         <taglib-uri>struts-bean</taglib-uri>    
36         <taglib-location>/WEB-INF/tld/struts-bean.tld</taglib-location>    
37     </taglib>    
38     <taglib>    
39         <taglib-uri>struts-html</taglib-uri>    
40         <taglib-location>/WEB-INF/tld/struts-html.tld</taglib-location>    
41     </taglib>    
42     <taglib>    
43     <taglib-uri>struts-nested</taglib-uri>    
44     <taglib-location>/WEB-INF/tld/struts-nested.tld</taglib-location>    
45     </taglib>    
46     <taglib>    
47         <taglib-uri>struts-logic</taglib-uri>    
48         <taglib-location>/WEB-INF/tld/struts-logic.tld</taglib-location>    
49     </taglib>    
50     <taglib>    
51         <taglib-uri>struts-tiles</taglib-uri>    
52         <taglib-location>/WEB-INF/tld/struts-tiles.tld</taglib-location>    
53     </taglib>

　　23、配置Spring（基本上都是在Struts中配置的）

 1  <!-- 指定spring配置文件位置 -->    
 2    <context-param>    
 3       <param-name>contextConfigLocation</param-name>    
 4       <param-value>    
 5        <!--加载多个spring配置文件 -->    
 6         /WEB-INF/applicationContext.xml, /WEB-INF/action-servlet.xml    
 7       </param-value>    
 8    </context-param>    
 9 
10    <!-- 定义SPRING监听器，加载spring -->    
11 
12 <listener>    
13      <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>    
14 </listener>    
15 
16 <listener>    
17      <listener-class>    
18        org.springframework.web.context.request.RequestContextListener    
19      </listener-class>    
20 </listener>

　　web.xml 文件中一般包括 servlet, spring, filter, listenr的配置。比如filter 需要用到 bean ，但是加载顺序是先加载filter 后加载spring，则filter中初始化操作中的bean为null；

所以，如果过滤器中要使用到 bean，可以将spring 的加载改成 Listener的方式。

1 <listener>
2         <listener-class>
3             org.springframework.web.context.ContextLoaderListener
4         </listener-class>
5 </listener>

　　另外，servlet2.3规范filter执行是按照web.xml配置的filter-mapping先后顺序进行执行，所以，如果有多个filter-mapping一定要确保顺序，否则会出现一些特殊的异常。