web.xml 中的listener、 filter、servlet 加載順序及其詳解

原文地址:http://sunxboy.javaeye.com/blog/419033

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

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