web.xml配置詳解

標籤：har   cat   分享   special   timeout   int   oda   src   shareable   

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 的順序進行調用的。

 

1、web.xml學名叫部署描述符檔案，是在Servlet規範中定義的，是web應用的設定檔。

2、部署描述符檔案就像所有XML檔案一樣，必須以一個XML頭開始。這個頭聲明可以使用的XML版本並給出檔案的字元編碼。DOCYTPE聲明必須立即出現在此頭之後。這個聲明告訴伺服器適用的servlet規範的版本（如2.2或2.3）並指定管理此檔案其餘部分內容的文法的DTD(Document Type Definition，文件類型定義)。所有部署描述符檔案的頂層（根）元素為web-app。請注意，XML元素不像HTML，他們是大小寫敏感的。因此，web-App和WEB-APP都是不合法的，web-app必須用小寫。

      web.xml範例：

1. <?xml version="1.0" encoding="UTF-8"?>  
2. <!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN" "http://java.sun.com/dtd/web-app_2_3.dtd">  
3. <web-app>  
4. </web-app> 

 3、web.xml中XML 元素不僅是大小寫敏感的，而且它們還對出現在其他元素中的次序敏感。例如，XML頭必須是檔案中的第一項，DOCTYPE聲明必須是第二項，而web- app元素必須是第三項。在web-app元素內，元素的次序也很重要。伺服器不一定強制要求這種次序，但它們允許（實際上有些伺服器就是這樣做的）完全拒絕執行含有次序不正確的元素的Web應用。這表示使用非標準元素次序的web.xml檔案是不可移植的。

    元素順序列表：

      元素標籤詳解：

元素1：<icon>

含義

icon元素包含small-icon和large-icon兩個子項目.用來指定web月台中小表徵圖和大表徵圖的路徑.
<small-icon>/路徑/smallicon.gif</small-icon>
small-icon元素應指向web月台中某個小表徵圖的路徑,大小為16 X 16 pixel,但是圖象檔案必須為GIF或JPEG格式,副檔名必須為:.gif或.jpg.

<large-icon>/路徑/largeicon-jpg</large-icon>
large-icon元素應指向web月台中某個大圖表路徑,大小為32 X 32 pixel,但是圖象檔案必須為GIF或JPEG的格式,副檔名必須為; gif或jpg.

範例

<icon>
   <small-icon>/images/small.gif</small-icon>
   <large-icon>/images/large.gif</large-icon>
</icon>

元素2、3：<display-name>，<description>

含義

<display-name>應用程式名稱</display-name>
定義應用的名稱。

<description>應用描述</discription>
對應用做出描述。

範例

<display-name>test</display-name>

<description>測試應用V1.0</discription>

元素4：<context-param>

含義

context-param 元素用來設定web應用的環境參數(context),它包含兩個子項目:
param-name和param-value.
<param-name>參數名稱</param-name>
設定Context名稱
<param-value>值</param-value>
設定Context名稱的值

範例
<context-param>
   <param-name>param_name</param-name>
   <param-value>param_value</param-value>
</context-param>
此所設定的參數,在JSP網頁中可以使用下列方法來取得:
${initParam.param_name}
若在Servlet可以使用下列方法來獲得:
String param_name=getServletContext().getInitParamter("param_name");

元素5，6：<filter>，<filter-mapping>

含義

filter元素用來設定web應用的過濾器，它的兩個主要子項目filter-name和filter-class用來定義Filter所對應的class

<filter-name>Filter的名稱</filter-name>
定義Filter的名稱
<filter-class>Filter的類名稱</filter-class>
定義Filter的類名稱

filter-mapping 元素的兩個主要子項目filter-name和url-pattern.用來定義Filter所對應的URL.
<filter-name>Filter的名稱</filter-name>
定義Filter的名稱.
<url-pattern>URL</url-pattern>
Filter所對應的RUL.例如:<url-pattern>/Filter/*</url-pattern>

範例

<filter>
  <filter-name>Encoding</filter-name>
  <filter-class>ghjf.test.filter.SetCharacterEncodingFilter</filter-class>
  <init-param>
     <param-name>encoding</param-name>
     <param-value>GBK</param-value>
  </init-param>
</filter>

<filter-mapping>
   <filter-name>Encoding</filter-name>
   <url-pattern>/*</url-pattern>
</filter-mapping>

元素7：<listener>

含義

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

範例

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

元素8、9：<servlet>、<servlet-mapping>

含義

servlet元素的兩個主要子項目servlet-name和servlet-class用來定義servlet所對應的class

<servlet-name>servlet的名稱</servlet-name>
定義servlet的名稱
<servlet-class>servlet的類名稱</servlet-class>
定義servlet的類名稱

servlet-mapping元素包含兩個子項目servlet-name和url-pattern.用來定義servlet所對應URL.
<servlet-name>Servlet的名稱</servlet-name>
定義Servlet的名稱.
<url-pattern>Servlet URL</url-pattern>
定義Servlet所對應的RUL.例如:<url-pattern>/Servlet/*</url-pattern>
</servlet-mapping>

範例

<servlet>
 <servlet-name>dwr-invoker</servlet-name>
 <display-name>DWR Servlet</display-name>
 <description>Direct Web Remoter Servlet</description>
 <servlet-class>uk.ltd.getahead.dwr.DWRServlet</servlet-class>
 <init-param>
     <param-name>debug</param-name>
     <param-value>true</param-value>
 </init-param>
</servlet>

<servlet-mapping>
 <servlet-name>dwr-invoker</servlet-name>
 <url-pattern>/dwr/*</url-pattern>
</servlet-mapping>

元素10：<session-cofing>

含義

session-config包含一個子項目session-timeout.定義web應用中的session參數.
<session-timeout>分鐘</session-timeout>
定義這個web月台所有session的有效期間限.單位為分鐘.

範例

<session-config>
   <session-timeout>30</session-timeout>
</session-config>

元素11：<mime-mapping>

含義

mime-mapping包含兩個子項目extension和mime-type.定義某一個副檔名和某一MIME Type做對映.
<extension>副檔名名稱</extension>
副檔名稱
<mime-type>MIME格式</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>
<mime-mapping>
   <extension>ppt</extesnion>
   <mime-type>application/vnd.ms-powerpoint</mime-type>
</mime-mapping>

元素12：<welcome-file-list>

含義

welcome-file-list包含一個子項目welcome-file.用來定義首頁列單.
<welcome-file>用來指定首頁檔案名稱</welcome-flie>
welcome-file用來指定首頁檔案名稱.我們可以用<welcome-file>指定幾個首頁,而伺服器會依照設定的順序來找首頁.

範例

<welcome-file-list>
  <welcome-file>index.jsp</welcome-file>
  <welcome-file>index.htm</welcome-file>
</welcome-file-list>

元素13：<error-page>

含義

error-page元素包含三個子項目error-code,exception-type和location.將錯誤碼(Error Code)或異常(Exception)的種類對應到web應用資源路徑.
<error-code>錯誤碼</error-code>
HTTP Error code,例如: 404、403
<exception-type>Exception</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>

元素14：<jsp-config>

含義

jsp-config元素主要用來設定JSP的相關配置,<jsp:config>包括<taglib>和<jsp-property-group>兩個子項目.其中<taglib>元素
在JSP 1.2時就已經存在了;而<jsp-property-group>是JSP 2.0新增的元素.

<taglib>
taglib元素包含兩個子項目taglib-uri和taglib-location.用來設定JSP網頁用到的Tag Library路徑.
<taglib-uri>URI</taglib-uri>
   taglib-uri定義TLD檔案的URI,JSP網頁的taglib指令可以經由這個URI存取到TLD檔案.
<taglib-location>/WEB-INF/lib/xxx.tld</taglib-laction>
   TLD檔案對應Web月台的存放位置.
</taglib>

<jsp-property-group>
jsp-property-group元素包含8個元素,分別為:
<description>Description</descrition>
此設定的說明

<display-name>Name</display-name>
此設定的名稱

<url-pattern>URL</url-pattern>
設定值所影響的範圍,如:/CH2 或者/*.jsp

<el-ignored>true|false</el-ignored>
若為true,表示不支援EL文法.

<scripting-invalid>true|false</scripting-invalid>
若為true表示不支援<%scription%>文法.

<page-encoding>encoding</page-encoding>
設定JSP網頁的編碼

<include-prelude>.jspf</include-prelude>
設定JSP網頁的抬頭,副檔名為.jspf

<include-coda>.jspf</include-coda>
設定JSP網頁的結尾,副檔名為.jspf
</jsp-property-group>
</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>
   <uri-pattern>/*</uri-pattern>
   <el-ignored>true</el-ignored>
   <page-encoding>GB2312</page-encoding>
   <scripting-inivalid>true</scripting-inivalid>
</jsp-property-group>
</jsp-config>

元素15：<resource-env-ref>

含義

resource-env-ref有兩個子項目：
<resource-env-ref-name>資源名</resource-env-ref-name>  
資源的名稱 相對於java:comp/env
<resource-env-ref-type>尋找資源時返回的資源類名</resource-env-ref-type>
當web應用尋找該資源的時候，返回的Java類名的全稱

範例

 <resource-env-ref>  
  <resource-env-ref-name>jdbc/mssql</resource-env-ref-name>  
  <resource-env-ref-type>javax.sql.DataSource</resource-env-ref-type>  
 </resource-env-ref> 

元素16：<resource-ref>

含義

resource-ref元素包括五個子項目description,res-ref-name,res-type,res-auth,res-sharing-scope.利用JNDI取得應用可利用資源.
<description>說明</description>
資源說明
<rec-ref-name>資源名稱</rec-ref-name>
資源名稱
<res-type>資源種類</res-type>
資源種類
<res-auth>Application|Container</res-auth>
資源由Application或Container來許可
<res-sharing-scope>Shareable|Unshareable</res-sharing-scope>
 資源是否可以共用.預設值為 Shareable

範例

<resource-ref>
   <description>JNDI JDBC DataSource</description>
   <res-ref-name>jdbc/data</res-ref-name>
   <res-type>javax.sql.DataSoruce</res-type>
   <res-auth>Container</res-auth>
</resource-ref>

web.xml配置詳解