web.xml配置詳解 - langtianya－IT工程師數位筆記本

文章出處

Web.xml常用元素   
<web-app>   
<display-name></display-name>定義了WEB應用的名字   
<description></description> 聲明WEB應用的描述信息   
 
<context-param></context-param> context-param元素聲明應用范圍內的初始化參數。   
<filter></filter> 過濾器元素將一個名字與一個實現<a href="http://www.cnblogs.com/bukudekong/archive/2011/12/26/2302183.html">javax.servlet.Filter</a>接口的類相關聯。    
<filter-mapping></filter-mapping> 一旦命名了一個過濾器，就要利用filter-mapping元素把它與一個或多個servlet或JSP頁面相關聯。   
<listener></listener>servlet API的版本2.3增加了對事件監聽程序的支持，事件監聽程序在建立、修改和刪除會話或servlet環境時得到通知。   
                     Listener元素指出事件監聽程序類。   
<servlet></servlet> 在向servlet或JSP頁面制定初始化參數或定制URL時，必須首先命名servlet或JSP頁面。Servlet元素就是用來完成此項任務的。   
<servlet-mapping></servlet-mapping> 服務器一般為servlet提供一個缺省的URL：http://host/webAppPrefix/servlet/ServletName。   
            <span style="color: #008000;">  但是，常常會更改這個URL，以便servlet可以訪問初始化參數或更容易地處理相對URL。</span>在更改缺省URL時，使用servlet-mapping元素。   
 
<session-config></session-config> 如果某個會話在一定時間內未被訪問，服務器可以拋棄它以節省內存。   
          可通過使用HttpSession的setMaxInactiveInterval方法明確設置單個會話對象的超時值，或者可利用session-config元素制定缺省超時值。   
 
<mime-mapping></mime-mapping>如果Web應用具有想到特殊的文件，希望能保證給他們分配特定的MIME類型，則mime-mapping元素提供這種保證。   
<welcome-file-list></welcome-file-list> 指示服務器在收到引用一個目錄名而不是文件名的URL時，使用哪個文件。   
<error-page></error-page> 在返回特定HTTP狀態代碼時，或者特定類型的異常被拋出時，能夠制定將要顯示的頁面。   
<taglib></taglib> 對標記庫描述符文件（Tag Libraryu Descriptor file）指定別名。此功能使你能夠更改TLD文件的位置，   
                  而不用編輯使用這些文件的JSP頁面。   
<resource-env-ref></resource-env-ref>聲明與資源相關的一個管理對象。   
<resource-ref></resource-ref> 聲明一個資源工廠使用的外部資源。   
<security-constraint></security-constraint> 制定應該保護的URL。它與login-config元素聯合使用   
<login-config></login-config> 指定服務器應該怎樣給試圖訪問受保護頁面的用戶授權。它與sercurity-constraint元素聯合使用。   
<security-role></security-role>給出安全角色的一個列表，這些角色將出現在servlet元素內的security-role-ref元素   
                   的role-name子元素中。分別地聲明角色可使高級IDE處理安全信息更為容易。   
<env-entry></env-entry>聲明Web應用的環境項。   
<ejb-ref></ejb-ref>聲明一個EJB的主目錄的引用。   
< ejb-local-ref></ ejb-local-ref>聲明一個EJB的本地主目錄的應用。   
</web-app>

web.xml元素介紹
每一個站的WEB-INF下都有一個web.xml的設定文件，它提供了我們站臺的配置設定.

1.<?xml version="1.0" encoding="ISO-8859-1"?>
部署描述符文件就像所有XML文件一樣，必須以一個XML頭開始。這個頭聲明可以使用的XML版本并給出文件的字符編碼。
2.<web-app xmlns="http://java.sun.com/xml/ns/j2ee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"
version="2.4">
<web-app>
這是一般在寫XML時所做的聲明,定義了XML的版本，編碼格式,還有重要的指明schema的來源,為http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd.
3.<description>站臺描述</discription>對站臺做出描述.
4.<display-name>站臺名稱</display-name>定義站臺的名稱.
<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.
范例:
<display-name>Develop Example</display-name>
<description>JSP 2.0 Tech Book's Examples</description>
<icon>
<small-icon>/images/small.gif</small-icon>
<large-icon>/images/large.gir</large-icon>
</icon>
5.<distributable>
distributable 元素為空標簽,它的存在與否可以指定站臺是否可分布式處理.如果web.xml中出現這個元素,則代表站臺在開發時已經
被設計為能在多個JSP Container 之間分散執行.
范例:
6.<context-param>
context-param 元素用來設定web站臺的環境參數(context),它包含兩個子元素:
param-name和param-value.
<param-name>參數名稱</param-name>
設定Context名稱
<param-value>值</param-value>
設定Context名稱的值
</context-param>
范例:
<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");
7.<filter>
filter元素用來聲明filter的相關設定.filter元素除了下面介紹的的子元素之外,還包括<servlet>介紹過的<icon>,<display-name>
,<description>,<init-param>,其用途一樣.
<filter-name>Filter的名稱</filter-name>
定義Filter的名稱.
<filter-class>Filter的類名稱</filter-class>
定義Filter的類名稱.例如:com.foo.hello
</filter>
范例:
<filter>
<filter-name>setCharacterEncoding</filter-name>
<filter-class>coreservlet.javaworld.CH11.SetCharacterEncodingFilter</filter-class>
<init-param>
<param-name>encoding</param-name>
<param-value>GB2312</param-value>
</init-param>
</filter>
8.<filter-mapping>
<filter-mapping>
filter-mapping 元素的兩個主要子元素filter-name和url-pattern.用來定義Filter所對應的URL.
<filter-name>Filter的名稱</filter-name>
定義Filter的名稱.
<url-pattern>URL</url-pattern>
Filter所對應的RUL.例如:<url-pattern>/Filter/Hello</url-pattern>
9.<servlet-name>Servlet的名稱<servlet-name>
定義servlet的名稱.
<dispatcher>REQUEST|INCLUDE|FORWARD|ERROR</disaptcher>
設定Filter對應的請求方式,有RQUEST,INCLUDE,FORWAR,ERROR四種,默認為REQUEST.
</filter-mapping>
范例:
<filter-mapping>
<filter-name>GZIPEncoding</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
10.<listener>
listener元素用來定義Listener接口,它的主要子元素為<listener-class>
<listen-class>Listener的類名稱</listener-class>
定義Listener的類名稱.例如: com.foo.hello
<listener>
范例:
<listener>
<listener-class>coreservlet.javaworld.CH11.ContenxtListener</listener-class>
</listener>
11.<servlet-mapping>
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/Hello</url-pattern>
</servlet-mapping>
范例:
<servlet-mapping>
<servlet-name>LoginChecker</servlet-name>
<url-pattern>/LoginChecker</url-pattern>
</servlet-mapping>
12.<session-cofing>
session-config包含一個子元素session-timeout.定義web站臺中的session參數.
<session-timeout>分鐘</session-timeout>
定義這個web站臺所有session的有效期限.單位為分鐘.
</session-config>
范例:
<session-config>
<session-timeout>20</session-timeout>
</session-config>
13.<mime-mapping>
mime-mapping包含兩個子元素extension和mime-type.定義某一個擴展名和某一MIME Type做對映.
<extension>擴展名名稱</extension>
擴展名稱
<mime-type>MIME格式</mime-type>
MIME格式.
</mime-mapping>
范例:
<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>
14.<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>
15.<error-page>
error-page元素包含三個子元素error-code,exception-type和location.將錯誤代碼(Error Code)或異常(Exception)的種類對應
到web站臺資源路徑.
<error-code>錯誤代碼</error-code>
HTTP Error code,例如: 404
<exception-type>Exception</exception-type>
一個完整名稱的Java異常類型
<location>/路徑</location>
在web站臺內的相關資源路徑
</error-page>
范例:
<error-page>
<error-code>404</error-code>
<location>/error404.jsp</location>
</error-page>
<error-page>
<exception-type>java.lang.Exception</exception-type>
<location>/except.jsp</location>
</error-page>
16.<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%>語法.
17.<page-encoding>encoding</page-encoding>
設定JSP網頁的編碼
18.<include-prelude>.jspf</include-prelude>
設置JSP網頁的抬頭,擴展名為.jspf
JSP segments(以前版本稱為JSP fragments)即jspf文件是不完整的JSPs,是用來被其他的JSP來包含的。
19.<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>
20.<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 of JSPBook</description>
<res-ref-name>jdbc/sample_db</res-ref-name>
<res-type>javax.sql.DataSoruce</res-type>
<res-auth>Container</res-auth>
</resource-ref>