1. 程式人生 > >web.xml 詳細介紹

web.xml 詳細介紹

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

2、緊急著,容建立一個ServletContext(servlet上下文),這個web專案的所有部分都將共享這個上下文。 

3、容器將<context-param>轉換為鍵值對,並交給servletContext。 

4、容器建立<listener>中的類例項,建立監聽器。 

二  Load-on-startup

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。最終得出的結論是: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.

</web-app>

其它的元素都放在<web-app></web-app>之中。

<discription></discription> 是對站臺的描述
<display-name></display-name> 定義站臺的名稱
<distributable/> 是指定該站臺是否可分散式處理


<context-param></context-param> 用來設定web站臺的環境引數,它包含兩個子元素:
    <param-name></param-name> 用來指定引數的名稱
    <param-value></param-value> 用來設定引數值

比如:
<context-param>
    <param-name>my_param</param-name>
    <param-value>hello</param-value>
</context-param>

在此設定的引數,可以在servlet中用 getServletContext().getInitParameter("my_param") 來取得


<filter></filter> 是用來宣告filter的相關設定,它包含以下子元素:
    <filter-name></filter-name> 這當然就是指定filter的名字
    <filter-class></filter-class> 這是用來定義filter的類的名稱
    <init-param></init-param> 用來定義引數,它有兩個子元素:
        <param-name></param-name> 用來指定引數的名稱
        <param-value></param-value> 用來設定引數值

比如:
<filter>
        <filter-name>setCharacterEncoding</filter-name>
        <filter-class>com.myTest.setCharacterEncodingFilter</filter-class>
        <init-param>
            <param-name>encoding</param-name>
            <param-value>GB2312</param-value>
        </init-param>
</filter>

與<filter></filter>同時使用的是<filter-mapping></filter-mapping> 用來定義filter所對應的URL,它有兩個子元素:
    <filter-name></filter-name> 指定filter的名字
    <url-pattern></url-pattern> 指定filter所對應的URL

比如:
<filter-mapping>
        <filter-name>setCharacterEncoding</filter-name>
        <url-pattern>/*</url-pattern>
</filter-mapping>


<listener></listener> 用來設定Listener介面,它的主要子元素為
    <listener-class></listener-class> 定義Listener的類名稱

比如:
<listener>
    <listener-class>com.myTest.ContextListener</listener-class> 
</listener>


<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></servlet>一起使用的是<servlet-mapping></servlet-mapping> 用來定義servlet所對應的URL,包含兩個子元素:
    <servlet-name></servlet-name> 指定servlet的名稱
    <url-pattern></url-pattern> 指定servlet所對應的URL

比如:
<servlet>
        <servlet-name>ShoppingServlet</servlet-name>
        <servlet-class>com.myTest.ShoppingServlet</servlet-class>
</servlet>
    
<servlet-mapping>
        <servlet-name>ShoppingServlet</servlet-name>
        <url-pattern>/shop/ShoppingServlet</url-pattern>
</servlet-mapping>


<session-config></session-config> 用來定義web站臺中的session引數,包含一個子元素:
    <session-timeout></session-timeout> 用來定義這個web站臺所有session的有效期限,單位為                                                              分鐘


<mime-mapping></mime-mapping> 定義某一個副檔名和某一個MIME Type做對映,包含兩個                                                        子元素:
    <extension></extension> 副檔名的名稱
    <mime-type></mime-type> MIME格式

比如:
<mime-mapping>
    <extension>doc</extension>
    <mime-type>application/vnd.ms-word</mime-type>
</mime-mapping> 
<mime-mapping>
    <extension>xls</extension>
    <mime-type>application/vnd.ms-excel</mime-type>
</mime-mapping>


<welcome-file-list></welcom-file-list> 用來定義首頁的列單,包含一個子元素:
    <welcome-file></welcome-file> 指定首頁的檔名稱

比如:
<welcome-file-list>
    <welcome-file>index.jsp</welcome-file>
    <welcome-file>index.html</welcome-file>
</welcom-file-list>


<error-page></error-page> 用來處理錯誤程式碼或異常的頁面,有三個子元素:
    <error-code></error-code> 指定錯誤程式碼
    <exception-type></exception-type> 指定一個JAVA異常型別
    <location></location> 指定在web站臺內的相關資源路徑

比如:
<error-page>
    <error-code>404</error-code>
    <location>/error404.jsp</location>
</error-page>
<error-page>
    <exception-type>java.lang.Exception</exception-type>
    <location>/exception.jsp</location>
</error-page>


<taglib></taglib> 用來設定JSP網頁所用到的Tag Library路徑,有兩個子元素:
    <taglib-uri></taglib-uri> 定義TLD檔案的URI,在JSP網頁中用taglib指令便可取得該URI的                                              TLD檔案
    <taglib-location></taglib-location> 指定TLD檔案相對於web站臺的存放位置

比如:
<taglib>
      <taglib-uri>myTaglib</taglib-uri>
      <taglib-location>/WEB-INF/tlds/MyTaglib.tld</taglib-location>
</taglib>


<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

比如,配置資料庫連線池就可在此配置:
<resource-ref>
        <description>JNDI JDBC DataSource of shop</description>
        <res-ref-name>jdbc/sample_db</res-ref-name>
        <res-type>javax.sql.DataSource</res-type>
        <res-auth>Container</res-auth>
</resource-ref>


<jsp-config> 包括<taglib> 和<jsp-property-group> 兩個子元素。
    
    其中<taglib>元素在JSP 1.2時就已經存在;而<jsp-property-group>是JSP 2.0 新增的元素。
    <jsp-property-group>元素主要有八個子元素,它們分別為:
    
    1.<description>:設定的說明;
    2.<display-name>:設定名稱;
    3.<url-pattern>:設定值所影響的範圍,如:/CH2 或 /*.jsp;
    4.<el-ignored>:若為true,表示不支援EL 語法;
    5.<scripting-invalid>:若為true,表示不支援<% scripting %>語法;
    6.<page-encoding>:設定JSP 網頁的編碼;
    7.<include-prelude>:設定JSP 網頁的擡頭,副檔名為.jspf;
    8.<include-coda>:設定JSP 網頁的結尾,副檔名為.jspf。


一個簡單的<jsp-config>元素完整配置:

<jsp-config>
    <taglib>
        <taglib-uri>Taglib</taglib-uri>
        <taglib-location>/WEB-INF/tlds/MyTaglib.tld</taglib-location>
    </taglib>
    <jsp-property-group>
        <description>Special property group for JSP Configuration JSP example.</description>
        <display-name>JSPConfiguration</display-name>
        <url-pattern>/jsp/* </url-pattern>
        <el-ignored>true</el-ignored>
        <page-encoding>GB2312</page-encoding>
        <scripting-invalid>true</scripting-invalid>
        <include-prelude>/include/prelude.jspf</include-prelude>
        <include-coda>/include/coda.jspf</include-coda>
    </jsp-property-group>
</jsp-config>  


配置web.xml來限制對某些servlet的請求

有時我們只希望通過認證的使用者才能請求某些servlet的話,就可以在web.xml中來進行相應的配置,來達到此目的。

這就要用到<security-constraint></security-constraint>元素。
對於tomcat,中web.xml使用security-constraint元素需要在位於<Tomcat-installation-directory>/conf/tomcat-users.xml的XML檔案中建立使用者名稱和密碼。比如下面的這個tomcat-users.xml檔案:

<?xml version='1.0' encoding='utf-8'?>
<tomcat-users>
  <role rolename="tomcat"/>
  <role rolename="manager"/>
  <role rolename="admin"/>
  <user username="tomcat" password="tomcat" roles="tomcat"/>
  <user username="both" password="tomcat" roles="tomcat,manager"/>
  <user username="admin" password="admin" roles="admin"/>
</tomcat-users>

此XML片段包括一個tomcat-users根元素,它包含一個或多個role和user元素。


然後在Web應用程式的web.xml中建立security-constraint、login-config和security-role元素。

<security-constraint>
      <web-resource-collection>
          <web-resource-name>HelloServlet</web-resource-name>
          <url-pattern>/HelloServlet</url-pattern>
          <http-method>GET</http-method>
          <http-method>POST</http-method>
      </web-resource-collection>
      <auth-constraint>
          <description>This applies only to the "tomcat" security role</description>
          <role-name>admin</role-name>
      </auth-constraint>
      <user-data-constraint>
          <transport-guarantee>NONE</transport-guarantee>
      </user-data-constraint>
  </security-constraint>
  
  <login-config>
      <auth-method>BASIC</auth-method>
  </login-config>
  <security-role>
      <role-name>admin</role-name>
  </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資源。


五 相應元素配置    

1、Web應用圖示:指出IDE和GUI工具用來表示Web應用的大圖示和小圖示    
<icon>    
<small-icon>/images/app_small.gif</small-icon>    
<large-icon>/images/app_large.gif</large-icon>    
</icon>    
2、Web 應用名稱:提供GUI工具可能會用來標記這個特定的Web應用的一個名稱    
<display-name>Tomcat Example</display-name>    
3、Web 應用描述: 給出於此相關的說明性文字    
<disciption>Tomcat Example servlets and JSP pages.</disciption>    
4、上下文引數:宣告應用範圍內的初始化引數。    
<context-param>    
    <param-name>ContextParameter</para-name>    
    <param-value>test</param-value>    
    <description>It is a test parameter.</description>    
</context-param>    
在servlet裡面可以通過getServletContext().getInitParameter("context/param")得到    

5、過濾器配置:將一個名字與一個實現javaxs.servlet.Filter介面的類相關聯。    
<filter>    
        <filter-name>setCharacterEncoding</filter-name>    
        <filter-class>com.myTest.setCharacterEncodingFilter</filter-class>    
        <init-param>    
            <param-name>encoding</param-name>    
            <param-value>GB2312</param-value>    
        </init-param>    
</filter>    
<filter-mapping>    
        <filter-name>setCharacterEncoding</filter-name>    
        <url-pattern>/*</url-pattern>    
</filter-mapping>    
6、監聽器配置    
<listener>    
      <listerner-class>listener.SessionListener</listener-class>    
</listener>    
7、Servlet配置    
   基本配置    
   <servlet>    
      <servlet-name>snoop</servlet-name>    
      <servlet-class>SnoopServlet</servlet-class>    
   </servlet>    
   <servlet-mapping>    
      <servlet-name>snoop</servlet-name>    
      <url-pattern>/snoop</url-pattern>    
   </servlet-mapping>    
   高階配置    
   <servlet>    
      <servlet-name>snoop</servlet-name>    
      <servlet-class>SnoopServlet</servlet-class>    
      <init-param>    
         <param-name>foo</param-name>    
         <param-value>bar</param-value>    
      </init-param>    
      <run-as>    
         <description>Security role for anonymous access</description>    
         <role-name>tomcat</role-name>    
      </run-as>    
   </servlet>    
   <servlet-mapping>    
      <servlet-name>snoop</servlet-name>    
      <url-pattern>/snoop</url-pattern>    
   </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、會話超時配置(單位為分鐘)    
   <session-config>    
      <session-timeout>120</session-timeout>    
   </session-config>    
9、MIME型別配置    
   <mime-mapping>    
      <extension>htm</extension>    
      <mime-type>text/html</mime-type>    
   </mime-mapping>    
10、指定歡迎檔案頁配置    
   <welcome-file-list>    
      <welcome-file>index.jsp</welcome-file>    
      <welcome-file>index.html</welcome-file>    
      <welcome-file>index.htm</welcome-file>    
   </welcome-file-list>    
11、配置錯誤頁面    
一、 通過錯誤碼來配置error-page    
   <error-page>    
      <error-code>404</error-code>    
      <location>/NotFound.jsp</location>    
   </error-page>    
上面配置了當系統發生404錯誤時,跳轉到錯誤處理頁面NotFound.jsp。    
二、通過異常的型別配置error-page    
   <error-page>    
       <exception-type>java.lang.NullException</exception-type>    
       <location>/error.jsp</location>    
   </error-page>    
上面配置了當系統發生java.lang.NullException(即空指標異常)時,跳轉到錯誤處理頁面error.jsp    
12、TLD配置    
   <taglib>    
       <taglib-uri>http://jakarta.apache.org/tomcat/debug-taglib</taglib-uri>    
       <taglib-location>/WEB-INF/jsp/debug-taglib.tld</taglib-location>    
   </taglib>    
   如果MyEclipse一直在報錯,應該把<taglib> 放到 <jsp-config>中    
   <jsp-config>    
      <taglib>    
          <taglib-uri>http://jakarta.apache.org/tomcat/debug-taglib</taglib-uri>    
          <taglib-location>/WEB-INF/pager-taglib.tld</taglib-location>    
      </taglib>    
   </jsp-config>    
13、資源管理物件配置    
   <resource-env-ref>    
       <resource-env-ref-name>jms/StockQueue</resource-env-ref-name>    
   </resource-env-ref>    
14、資源工廠配置    
   <resource-ref>    
       <res-ref-name>mail/Session</res-ref-name>    
       <res-type>javax.mail.Session</res-type>    
       <res-auth>Container</res-auth>    
   </resource-ref>    
   配置資料庫連線池就可在此配置:    
   <resource-ref>    
       <description>JNDI JDBC DataSource of shop</description>    
       <res-ref-name>jdbc/sample_db</res-ref-name>    
       <res-type>javax.sql.DataSource</res-type>    
       <res-auth>Container</res-auth>    
   </resource-ref>    
15、安全限制配置    
   <security-constraint>    
      <display-name>Example Security Constraint</display-name>    
      <web-resource-collection>    
         <web-resource-name>Protected Area</web-resource-name>    
         <url-pattern>/jsp/security/protected/*</url-pattern>    
         <http-method>DELETE</http-method>    
         <http-method>GET</http-method>    
         <http-method>POST</http-method>    
         <http-method>PUT</http-method>    
      </web-resource-collection>    
      <auth-constraint>    
        <role-name>tomcat</role-name>    
        <role-name>role1</role-name>    
      </auth-constraint>    
   </security-constraint>    
16、登陸驗證配置    
   <login-config>    
     <auth-method>FORM</auth-method>    
     <realm-name>Example-Based Authentiation Area</realm-name>    
     <form-login-config>    
        <form-login-page>/jsp/security/protected/login.jsp</form-login-page>    
        <form-error-page>/jsp/security/protected/error.jsp</form-error-page>    
     </form-login-config>    
   </login-config>    
17、安全形色:security-role元素給出安全形色的一個列表,這些角色將出現在servlet元素內的security-role-ref元素的role-name子元素中。    
    分別地宣告角色可使高階IDE處理安全資訊更為容易。    
<security-role>    
     <role-name>tomcat</role-name>    
</security-role>    
18、Web環境引數:env-entry元素宣告Web應用的環境項    
<env-entry>    
     <env-entry-name>minExemptions</env-entry-name>    
     <env-entry-value>1</env-entry-value>    
     <env-entry-type>java.lang.Integer</env-entry-type>    
</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宣告    
<ejb-local-ref>    
     <description>Example Loacal EJB reference</decription>    
     <ejb-ref-name>ejb/ProcessOrder</ejb-ref-name>    
     <ejb-ref-type>Session</ejb-ref-type>    
     <local-home>com.mycompany.mypackage.ProcessOrderHome</local-home>    
     <local>com.mycompany.mypackage.ProcessOrder</local>    
</ejb-local-ref>    
21、配置DWR    
<servlet>    
      <servlet-name>dwr-invoker</servlet-name>    
      <servlet-class>uk.ltd.getahead.dwr.DWRServlet</servlet-class>    
</servlet>    
<servlet-mapping>    
      <servlet-name>dwr-invoker</servlet-name>    
      <url-pattern>/dwr/*</url-pattern>    
</servlet-mapping>    
22、配置Struts    
    <display-name>Struts Blank Application</display-name>    
    <servlet>    
        <servlet-name>action</servlet-name>    
        <servlet-class>    
            org.apache.struts.action.ActionServlet    
        </servlet-class>    
        <init-param>    
            <param-name>detail</param-name>    
            <param-value>2</param-value>    
        </init-param>    
        <init-param>    
            <param-name>debug</param-name>    
            <param-value>2</param-value>    
        </init-param>    
        <init-param>    
            <param-name>config</param-name>    
            <param-value>/WEB-INF/struts-config.xml</param-value>    
        </init-param>    
        <init-param>    
            <param-name>application</param-name>    
            <param-value>ApplicationResources</param-value>    
        </init-param>    
        <load-on-startup>2</load-on-startup>    
    </servlet>    
    <servlet-mapping>    
        <servlet-name>action</servlet-name>    
        <url-pattern>*.do</url-pattern>    
    </servlet-mapping>    
    <welcome-file-list>    
        <welcome-file>index.jsp</welcome-file>    
    </welcome-file-list>    

    <!-- Struts Tag Library Descriptors -->    
    <taglib>    
        <taglib-uri>struts-bean</taglib-uri>    
        <taglib-location>/WEB-INF/tld/struts-bean.tld</taglib-location>    
    </taglib>    
    <taglib>    
        <taglib-uri>struts-html</taglib-uri>    
        <taglib-location>/WEB-INF/tld/struts-html.tld</taglib-location>    
    </taglib>    
    <taglib>    
    <taglib-uri>struts-nested</taglib-uri>    
    <taglib-location>/WEB-INF/tld/struts-nested.tld</taglib-location>    
    </taglib>    
    <taglib>    
        <taglib-uri>struts-logic</taglib-uri>    
        <taglib-location>/WEB-INF/tld/struts-logic.tld</taglib-location>    
    </taglib>    
    <taglib>    
        <taglib-uri>struts-tiles</taglib-uri>    
        <taglib-location>/WEB-INF/tld/struts-tiles.tld</taglib-location>    
    </taglib>    
23、配置Spring(基本上都是在Struts中配置的)    

   <!-- 指定spring配置檔案位置 -->    
   <context-param>    
      <param-name>contextConfigLocation</param-name>    
      <param-value>    
       <!--載入多個spring配置檔案 -->    
        /WEB-INF/applicationContext.xml, /WEB-INF/action-servlet.xml    
      </param-value>    
   </context-param>    

   <!-- 定義SPRING監聽器,載入spring -->    

<listener>    
     <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>    
</listener>    

<listener>    
     <listener-class>    
       org.springframework.web.context.request.RequestContextListener    
     </listener-class>    
</listener>