1. 程式人生 > >Web.xml常用標籤詳解

Web.xml常用標籤詳解

每一個專案WEB-INF下都有一個web.xml的設定檔案,它提供了專案配置設定.
web.xml定義:
 .專案的說明
 .針對環境引數(Context)做初始化工作
 .Servlet的名稱和對映
 .Session的設定
 .Tag library的對映
 .JSP網頁設定
 .Mime Type處理
 .錯誤處理
 .利用JDNI取得站臺資源

要了解web.xml的設定值,必須瞭解它的schema,從web.xml中知道它的schema是由Sum Microsystems公司定製的,如

果你想更為詳細的瞭解它,
可以到http://java.sun.com/xml/ns/j2ee/web-mapp_2_4.xsd網頁,那裡有更為詳細的介紹。這裡我介紹我們平常

見得最都的.
  
<?xml version="1.0" encoding="ISO-8859-1"?>

<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.


<description>,<display-name>,<icon>
---------------------------------------------------------

<description>站臺描述</discription>
對站臺做出描述.

<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>


<distributable>
---------------------------------------------------------

<distributable>
distributable 元素為空標籤,它的存在與否可以指定站臺是否可分散式處理.如果web.xml中出現這個元素,則代表

站臺在開發時已經
被設計為能在多個JSP Container 之間分散執行.
範例:
<distributable/>

 

<context-param>
---------------------------------------------------------

<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");

 

<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>


<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>

<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>

 

<listener>
---------------------------------------------------------
<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>

 

<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>


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


<mime-mapping>
---------------------------------------------------------
<mima-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>


<welcome-file-list>
---------------------------------------------------------
<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>

 

<error-page>
---------------------------------------------------------
<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>

 

<jsp-config>
---------------------------------------------------------
<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>

 

<resource-ref>
---------------------------------------------------------
<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>