tomcat web.xml加載順序

一、整體流程

1、啟動一個WEB項目的時候，WEB容器會去讀取它的配置檔案web.xml，讀取<listener>和<context-param>兩個結點。

2、緊急着，容建立一個ServletContext（servlet上下文），這個web項目的所有部分都将共享這個上下文。

3、容器将<context-param>轉換為鍵值對，并交給servletContext。

4、容器建立<listener>中的類執行個體，建立監聽器。

二、從源碼說明

有時候面試時會被問tomcat啟動時web.xml中節點（類似listener,filter等）被加載的順序，死記硬背那多沒品，正好手裡有tomcat7的源碼，找了點時間翻了翻。

讓我們先來喵一眼tomcat的架構，大緻了解下tomcat啟動的順序，那我們目前關心的僅僅是web.xml中的加載順序，按照架構來講肯定是在Context中，架構如下圖：

TomcatArchitecture from http://imtiger.net/

那我們就來到Context中尋找線索，按照tomcat架構設計Context的實作類是StandardContext，全稱org.apache.catalina.core.StandardContext

看到其實作Lifecycle接口，我們在StandardContext中笑而不語的找到startInternal方法，看看我把暫時無語的代碼去掉後的注釋版

[java]  view plain copy

1. @Override  
2. protectedsynchronized void startInternal() throwsLifecycleException {  
3.  //設定webappLoader 代碼省略  
4.  // Standard container startup 代碼省略  
5. try{  
6. // Set up the context init params 初始化context-param節點資料  
7. mergeParameters();  
8. // Configure and call application event listeners  
9. //配置和調用listeners 也就是說開始監聽  
10. if(ok) {  
11. if(!listenerStart()) {  
12. log.error("Error listenerStart");  
13. ok = false;  
14. }  
15. }  
16. // Configure and call application filters  
17. //配置和調用filters filters開始起作用  
18. if(ok) {  
19. if(!filterStart()) {  
20. log.error("Error filterStart");  
21. ok = false;  
22. }  
23. }  
24. // Load and initialize all "load on startup" servlets  
25. //加載和初始化配置在load on startup的servlets  
26. if(ok) {  
27. loadOnStartup(findChildren());  
28. }  
29. // Start ContainerBackgroundProcessor thread  
30. super.threadStart();  
31. }finally{  
32. // Unbinding thread  
33. unbindThread(oldCCL);  
34. }  
35. }  

是以代碼就是最好的文檔就是這樣，我們歸納一下代碼

1：首先是context-param節點

2：接着配置和調用listeners 并開始監聽

3：然後配置和調用filters filters開始起作用

4：最後加載和初始化配置在load on startup的servlets

另外贈送一枚彩蛋，也就是load on startup中的啟動順序是按照配置參數從小到大加載執行個體化的（小于0的忽略），

源代碼中是用一個TreeMap，其中鍵為Integer，那麼就是按照配置參數預設從小到大排列啟動。

load-on-startup 元素在web應用啟動的時候指定了servlet被加載的順序，它的值必須是一個整數。如果它的值是一個負整數或是這個元素不存在，那麼容器會在該servlet被調用的時候，加載這個servlet 。如果值是正整數或零，容器在配置的時候就加載并初始化這個servlet，容器必須保證值小的先被加載。如果值相等，容器可以自動選擇先加載誰。 

在servlet的配置當中，<load-on-startup>5</load-on-startup>的含義是：

标記容器是否在啟動的時候就加載這個servlet。

當值為0或者大于0時，表示容器在應用啟動時就加載這個servlet；

當是一個負數時或者沒有指定時，則訓示容器在該servlet被選擇時才加載。

正數的值越小，啟動該servlet的優先級越高。

三、詳細加載順序

在項目中總會遇到一些關于加載的優先級問題，近期也同樣遇到過類似的，是以自己查找資料總結了下，下面有些是轉載其他人的，畢竟人家寫的不錯，自己也就不重複造輪子了，隻是略加點了自己的修飾。

        首先可以肯定的是，加載順序與它們在 web.xml 檔案中的先後順序無關。即不會因為 filter 寫在 listener 的前面而會先加載 filter。最終得出的結論是：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 的加載順序是：context-param -> listener -> filter -> servlet ，而同個類型之間的實際程式調用的時候的順序是根據對應的 mapping 的順序進行調用的。

web.xml檔案詳解

Xml代碼  

1. Web.xml常用元素   
2. <web-app>   
3. <display-name></display-name>定義了WEB應用的名字   
4. <description></description> 聲明WEB應用的描述資訊   
5. <context-param></context-param> context-param元素聲明應用範圍内的初始化參數。   
6. <filter></filter> 過濾器元素将一個名字與一個實作javax.servlet.Filter接口的類相關聯。   
7. <filter-mapping></filter-mapping> 一旦命名了一個過濾器，就要利用filter-mapping元素把它與一個或多個servlet或JSP頁面相關聯。   
8. <listener></listener>servlet API的版本2.3增加了對事件監聽程式的支援，事件監聽程式在建立、修改和删除會話或servlet環境時得到通知。   
9.                      Listener元素指出事件監聽程式類。   
10. <servlet></servlet> 在向servlet或JSP頁面制定初始化參數或定制URL時，必須首先命名servlet或JSP頁面。Servlet元素就是用來完成此項任務的。   
11. <servlet-mapping></servlet-mapping> 伺服器一般為servlet提供一個預設的URL：http://host/webAppPrefix/servlet/ServletName。   
12.               但是，常常會更改這個URL，以便servlet可以通路初始化參數或更容易地處理相對URL。在更改預設URL時，使用servlet-mapping元素。   
13. <session-config></session-config> 如果某個會話在一定時間内未被通路，伺服器可以抛棄它以節省記憶體。   
14.           可通過使用HttpSession的setMaxInactiveInterval方法明确設定單個會話對象的逾時值，或者可利用session-config元素制定預設逾時值。   
15. <mime-mapping></mime-mapping>如果Web應用具有想到特殊的檔案，希望能保證給他們配置設定特定的MIME類型，則mime-mapping元素提供這種保證。   
16. <welcome-file-list></welcome-file-list> 訓示伺服器在收到引用一個目錄名而不是檔案名的URL時，使用哪個檔案。   
17. <error-page></error-page> 在傳回特定HTTP狀态代碼時，或者特定類型的異常被抛出時，能夠制定将要顯示的頁面。   
18. <taglib></taglib> 對标記庫描述符檔案（Tag Libraryu Descriptor file）指定别名。此功能使你能夠更改TLD檔案的位置，   
19.                   而不用編輯使用這些檔案的JSP頁面。   
20. <resource-env-ref></resource-env-ref>聲明與資源相關的一個管理對象。   
21. <resource-ref></resource-ref> 聲明一個資源工廠使用的外部資源。   
22. <security-constraint></security-constraint> 制定應該保護的URL。它與login-config元素聯合使用   
23. <login-config></login-config> 指定伺服器應該怎樣給試圖通路受保護頁面的使用者授權。它與sercurity-constraint元素聯合使用。   
24. <security-role></security-role>給出安全角色的一個清單，這些角色将出現在servlet元素内的security-role-ref元素   
25.                    的role-name子元素中。分别地聲明角色可使進階IDE處理安全資訊更為容易。   
26. <env-entry></env-entry>聲明Web應用的環境項。   
27. <ejb-ref></ejb-ref>聲明一個EJB的主目錄的引用。   
28. < ejb-local-ref></ ejb-local-ref>聲明一個EJB的本地主目錄的應用。   
29. </web-app>   
30. 相應元素配置   
31. 1、Web應用圖示：指出IDE和GUI工具用來表示Web應用的大圖示和小圖示   
32. <icon>   
33. <small-icon>/images/app_small.gif</small-icon>   
34. <large-icon>/images/app_large.gif</large-icon>   
35. </icon>   
36. 2、Web 應用名稱：提供GUI工具可能會用來标記這個特定的Web應用的一個名稱   
37. <display-name>Tomcat Example</display-name>   
38. 3、Web 應用描述： 給出于此相關的說明性文本   
39. <disciption>Tomcat Example servlets and JSP pages.</disciption>   
40. 4、上下文參數：聲明應用範圍内的初始化參數。   
41.   <context-param>   
42.     <param-name>ContextParameter</para-name>   
43.     <param-value>test</param-value>   
44.     <description>It is a test parameter.</description>   
45.   </context-param>   
46.   在servlet裡面可以通過getServletContext().getInitParameter("context/param")得到   
47. 5、過濾器配置：将一個名字與一個實作javaxs.servlet.Filter接口的類相關聯。   
48.   <filter>   
49.         <filter-name>setCharacterEncoding</filter-name>   
50.         <filter-class>com.myTest.setCharacterEncodingFilter</filter-class>   
51.         <init-param>   
52.             <param-name>encoding</param-name>   
53.             <param-value>GB2312</param-value>   
54.         </init-param>   
55.   </filter>   
56.   <filter-mapping>   
57.         <filter-name>setCharacterEncoding</filter-name>   
58.         <url-pattern>/*</url-pattern>   
59.   </filter-mapping>   
60. 6、監聽器配置   
61.   <listener>   
62.       <listerner-class>listener.SessionListener</listener-class>   
63.   </listener>   
64. 7、Servlet配置   
65.    基本配置   
66.    <servlet>   
67.       <servlet-name>snoop</servlet-name>   
68.       <servlet-class>SnoopServlet</servlet-class>   
69.    </servlet>   
70.    <servlet-mapping>   
71.       <servlet-name>snoop</servlet-name>   
72.       <url-pattern>/snoop</url-pattern>   
73.    </servlet-mapping>   
74.    進階配置   
75.    <servlet>   
76.       <servlet-name>snoop</servlet-name>   
77.       <servlet-class>SnoopServlet</servlet-class>   
78.       <init-param>   
79.          <param-name>foo</param-name>   
80.          <param-value>bar</param-value>   
81.       </init-param>   
82.       <run-as>   
83.          <description>Security role for anonymous access</description>   
84.          <role-name>tomcat</role-name>   
85.       </run-as>   
86.    </servlet>   
87.    <servlet-mapping>   
88.       <servlet-name>snoop</servlet-name>   
89.       <url-pattern>/snoop</url-pattern>   
90.    </servlet-mapping>   
91.    元素說明   
92.      <servlet></servlet> 用來聲明一個servlet的資料，主要有以下子元素：   
93.      <servlet-name></servlet-name> 指定servlet的名稱   
94.      <servlet-class></servlet-class> 指定servlet的類名稱   
95.      <jsp-file></jsp-file> 指定web站台中的某個JSP網頁的完整路徑   
96.      <init-param></init-param> 用來定義參數，可有多個init-param。在servlet類中通過getInitParamenter(String name)方法通路初始化參數   
97.      <load-on-startup></load-on-startup>指定當Web應用啟動時，裝載Servlet的次序。   
98.                                  當值為正數或零時：Servlet容器先加載數值小的servlet，再依次加載其他數值大的servlet.   
99.                                  當值為負或未定義：Servlet容器将在Web客戶首次通路這個servlet時加載它   
100.      <servlet-mapping></servlet-mapping> 用來定義servlet所對應的URL，包含兩個子元素   
101.        <servlet-name></servlet-name> 指定servlet的名稱   
102.        <url-pattern></url-pattern> 指定servlet所對應的URL   
103. 8、會話逾時配置（機關為分鐘）   
104.    <session-config>   
105.       <session-timeout>120</session-timeout>   
106.    </session-config>   
107. 9、MIME類型配置   
108.    <mime-mapping>   
109.       <extension>htm</extension>   
110.       <mime-type>text/html</mime-type>   
111.    </mime-mapping>   
112. 10、指定歡迎檔案頁配置   
113.    <welcome-file-list>   
114.       <welcome-file>index.jsp</welcome-file>   
115.       <welcome-file>index.html</welcome-file>   
116.       <welcome-file>index.htm</welcome-file>   
117.    </welcome-file-list>   
118. 11、配置錯誤頁面   
119.   一、 通過錯誤碼來配置error-page   
120.    <error-page>   
121.       <error-code>404</error-code>   
122.       <location>/NotFound.jsp</location>   
123.    </error-page>   
124.   上面配置了當系統發生404錯誤時，跳轉到錯誤處理頁面NotFound.jsp。   
125. 二、通過異常的類型配置error-page   
126.    <error-page>   
127.        <exception-type>java.lang.NullException</exception-type>   
128.        <location>/error.jsp</location>   
129.    </error-page>   
130.   上面配置了當系統發生java.lang.NullException（即空指針異常）時，跳轉到錯誤處理頁面error.jsp   
131. 12、TLD配置   
132.    <taglib>   
133.        <taglib-uri>http://jakarta.apache.org/tomcat/debug-taglib</taglib-uri>   
134.        <taglib-location>/WEB-INF/jsp/debug-taglib.tld</taglib-location>   
135.    </taglib>   
136.    如果MyEclipse一直在報錯,應該把<taglib> 放到 <jsp-config>中   
137.    <jsp-config>   
138.       <taglib>   
139.           <taglib-uri>http://jakarta.apache.org/tomcat/debug-taglib</taglib-uri>   
140.           <taglib-location>/WEB-INF/pager-taglib.tld</taglib-location>   
141.       </taglib>   
142.    </jsp-config>   
143. 13、資源管理對象配置   
144.    <resource-env-ref>   
145.        <resource-env-ref-name>jms/StockQueue</resource-env-ref-name>   
146.    </resource-env-ref>   
147. 14、資源工廠配置   
148.    <resource-ref>   
149.        <res-ref-name>mail/Session</res-ref-name>   
150.        <res-type>javax.mail.Session</res-type>   
151.        <res-auth>Container</res-auth>   
152.    </resource-ref>   
153.    配置資料庫連接配接池就可在此配置：   
154.    <resource-ref>   
155.        <description>JNDI JDBC DataSource of shop</description>   
156.        <res-ref-name>jdbc/sample_db</res-ref-name>   
157.        <res-type>javax.sql.DataSource</res-type>   
158.        <res-auth>Container</res-auth>   
159.    </resource-ref>   
160. 15、安全限制配置   
161.    <security-constraint>   
162.       <display-name>Example Security Constraint</display-name>   
163.       <web-resource-collection>   
164.          <web-resource-name>Protected Area</web-resource-name>   
165.          <url-pattern>/jsp/security/protected/*</url-pattern>   
166.          <http-method>DELETE</http-method>   
167.          <http-method>GET</http-method>   
168.          <http-method>POST</http-method>   
169.          <http-method>PUT</http-method>   
170.       </web-resource-collection>   
171.       <auth-constraint>   
172.         <role-name>tomcat</role-name>   
173.         <role-name>role1</role-name>   
174.       </auth-constraint>   
175.    </security-constraint>   
176. 16、登陸驗證配置   
177.    <login-config>   
178.      <auth-method>FORM</auth-method>   
179.      <realm-name>Example-Based Authentiation Area</realm-name>   
180.      <form-login-config>   
181.         <form-login-page>/jsp/security/protected/login.jsp</form-login-page>   
182.         <form-error-page>/jsp/security/protected/error.jsp</form-error-page>   
183.      </form-login-config>   
184.    </login-config>   
185. 17、安全角色：security-role元素給出安全角色的一個清單，這些角色将出現在servlet元素内的security-role-ref元素的role-name子元素中。   
186.     分别地聲明角色可使進階IDE處理安全資訊更為容易。   
187.   <security-role>   
188.      <role-name>tomcat</role-name>   
189.   </security-role>   
190. 18、Web環境參數：env-entry元素聲明Web應用的環境項   
191.   <env-entry>   
192.      <env-entry-name>minExemptions</env-entry-name>   
193.      <env-entry-value>1</env-entry-value>   
194.      <env-entry-type>java.lang.Integer</env-entry-type>   
195.   </env-entry>   
196. 19、EJB 聲明   
197.   <ejb-ref>   
198.      <description>Example EJB reference</decription>   
199.      <ejb-ref-name>ejb/Account</ejb-ref-name>   
200.      <ejb-ref-type>Entity</ejb-ref-type>   
201.      <home>com.mycompany.mypackage.AccountHome</home>   
202.      <remote>com.mycompany.mypackage.Account</remote>   
203.   </ejb-ref>   
204. 20、本地EJB聲明   
205.   <ejb-local-ref>   
206.      <description>Example Loacal EJB reference</decription>   
207.      <ejb-ref-name>ejb/ProcessOrder</ejb-ref-name>   
208.      <ejb-ref-type>Session</ejb-ref-type>   
209.      <local-home>com.mycompany.mypackage.ProcessOrderHome</local-home>   
210.      <local>com.mycompany.mypackage.ProcessOrder</local>   
211.   </ejb-local-ref>   
212. 21、配置DWR   
213.   <servlet>   
214.       <servlet-name>dwr-invoker</servlet-name>   
215.       <servlet-class>uk.ltd.getahead.dwr.DWRServlet</servlet-class>   
216.   </servlet>   
217.   <servlet-mapping>   
218.       <servlet-name>dwr-invoker</servlet-name>   
219.       <url-pattern>/dwr/*</url-pattern>   
220.   </servlet-mapping>   
221. 22、配置Struts   
222.     <display-name>Struts Blank Application</display-name>   
223.     <servlet>   
224.         <servlet-name>action</servlet-name>   
225.         <servlet-class>   
226.             org.apache.struts.action.ActionServlet   
227.         </servlet-class>   
228.         <init-param>   
229.             <param-name>detail</param-name>   
230.             <param-value>2</param-value>   
231.         </init-param>   
232.         <init-param>   
233.             <param-name>debug</param-name>   
234.             <param-value>2</param-value>   
235.         </init-param>   
236.         <init-param>   
237.             <param-name>config</param-name>   
238.             <param-value>/WEB-INF/struts-config.xml</param-value>   
239.         </init-param>   
240.         <init-param>   
241.             <param-name>application</param-name>   
242.             <param-value>ApplicationResources</param-value>   
243.         </init-param>   
244.         <load-on-startup>2</load-on-startup>   
245.     </servlet>   
246.     <servlet-mapping>   
247.         <servlet-name>action</servlet-name>   
248.         <url-pattern>*.do</url-pattern>   
249.     </servlet-mapping>   
250.     <welcome-file-list>   
251.         <welcome-file>index.jsp</welcome-file>   
252.     </welcome-file-list>   
253.     <!-- Struts Tag Library Descriptors -->   
254.     <taglib>   
255.         <taglib-uri>struts-bean</taglib-uri>   
256.         <taglib-location>/WEB-INF/tld/struts-bean.tld</taglib-location>   
257.     </taglib>   
258.     <taglib>   
259.         <taglib-uri>struts-html</taglib-uri>   
260.         <taglib-location>/WEB-INF/tld/struts-html.tld</taglib-location>   
261.     </taglib>   
262.     <taglib>   
263.     <taglib-uri>struts-nested</taglib-uri>   
264.     <taglib-location>/WEB-INF/tld/struts-nested.tld</taglib-location>   
265.     </taglib>   
266.     <taglib>   
267.         <taglib-uri>struts-logic</taglib-uri>   
268.         <taglib-location>/WEB-INF/tld/struts-logic.tld</taglib-location>   
269.     </taglib>   
270.     <taglib>   
271.         <taglib-uri>struts-tiles</taglib-uri>   
272.         <taglib-location>/WEB-INF/tld/struts-tiles.tld</taglib-location>   
273.     </taglib>   
274. 23、配置Spring（基本上都是在Struts中配置的）   
275.    <!-- 指定spring配置檔案位置 -->   
276.    <context-param>   
277.       <param-name>contextConfigLocation</param-name>   
278.       <param-value>   
279.        <!--加載多個spring配置檔案 -->   
280.         /WEB-INF/applicationContext.xml, /WEB-INF/action-servlet.xml   
281.       </param-value>   
282.    </context-param>   
283.    <!-- 定義SPRING監聽器，加載spring -->   
284.   <listener>   
285.      <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>   
286.   </listener>   
287.   <listener>   
288.      <listener-class>   
289.        org.springframework.web.context.request.RequestContextListener   
290.      </listener-class>   
291.   </listener>