web項目的web.xml配置詳細說明

web.xml元素介紹

我將自己知道的web.xml的元素整理了一下:

web.xml首先是肯定要包含它的schema.

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

其它的元素都放在<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資源。



通過此次整理,對web.xml中元素有了更清楚的瞭解,以後繼續努力...

轉自:http://www.blogjava.net/baoyaer/articles/107428.html

發佈了43 篇原創文章 · 獲贊 17 · 訪問量 23萬+
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章