web.xml詳解，web.xml配置詳解

web.xml詳解，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一定要確保順序，否則會出現一些特殊的異常。