關於deployment descripter(web.xml)的認識
web.xml文件詳解
我將自己知道的web.xml的元素整理了一下:
web.xml首先是肯定要包含它的schema.
1 <web-app xmlns="http://java.sun.com/xml/ns/j2ee" 2 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 3 xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd" 4 version="2.4"> 5 6 </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> 用來設定參數值。比如:
1 <context-param> 2 <param-name>my_param</param-name> 3 <param-value>hello</param-value> 4 </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> 用來設定參數值。
比如:
1 <filter> 2 <filter-name>setCharacterEncoding</filter-name> 3 <filter-class>com.myTest.setCharacterEncodingFilter</filter-class> 4 <init-param> 5 <param-name>encoding</param-name> 6 <param-value>GB2312</param-value> 7 </init-param> 8 </filter>
與<filter></filter>同時使用的是<filter-mapping></filter-mapping> 用來定義filter所對應的URL,它有兩個子元素:
<filter-name></filter-name> 指定filter的名字
<url-pattern></url-pattern> 指定filter所對應的URL。
比如:
1 <filter-mapping> 2 <filter-name>setCharacterEncoding</filter-name> 3 <url-pattern>/*</url-pattern> 4 </filter-mapping>
<listener></listener> 用來設定Listener接口,它的主要子元素為
<listener-class></listener-class> 定義Listener的類名稱
比如:
1 <listener> 2 <listener-class>com.myTest.ContextListener</listener-class> 3 </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
比如:
1 <servlet> 2 <servlet-name>ShoppingServlet</servlet-name> 3 <servlet-class>com.myTest.ShoppingServlet</servlet-class> 4 </servlet> 5 6 <servlet-mapping> 7 <servlet-name>ShoppingServlet</servlet-name> 8 <url-pattern>/shop/ShoppingServlet</url-pattern> 9 </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格式
比如:
1 <mime-mapping> 2 <extension>doc</extension> 3 <mime-type>application/vnd.ms-word</mime-type> 4 </mime-mapping> 5 <mime-mapping> 6 <extension>xls</extension> 7 <mime-type>application/vnd.ms-excel</mime-type> 8 </mime-mapping>
<welcome-file-list></welcom-file-list> 用來定義首頁的列單,包含一個子元素:
<welcome-file></welcome-file> 指定首頁的文件名稱
比如:
1 <welcome-file-list> 2 <welcome-file>index.jsp</welcome-file> 3 <welcome-file>index.html</welcome-file> 4 </welcom-file-list>
<error-page></error-page> 用來處理錯誤代碼或異常的頁面,有三個子元素:
<error-code></error-code> 指定錯誤代碼
<exception-type></exception-type> 指定一個JAVA異常類型
<location></location> 指定在web站臺內的相關資源路徑
比如:
1 <error-page> 2 <error-code>404</error-code> 3 <location>/error404.jsp</location> 4 </error-page> 5 <error-page> 6 <exception-type>java.lang.Exception</exception-type> 7 <location>/exception.jsp</location> 8 </error-page>
<taglib></taglib> 用來設定JSP網頁所用到的Tag Library路徑,有兩個子元素:
<taglib-uri></taglib-uri> 定義TLD文件的URI,在JSP網頁中用taglib指令便可取得該URI的TLD文件
<taglib-location></taglib-location> 指定TLD文件相對於web站臺的存放位置
比如:
1 <taglib> 2 <taglib-uri>myTaglib</taglib-uri> 3 <taglib-location>/WEB-INF/tlds/MyTaglib.tld</taglib-location> 4 </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
比如,配置數據庫連接池就可在此配置:
1 <resource-ref> 2 <description>JNDI JDBC DataSource of shop</description> 3 <res-ref-name>jdbc/sample_db</res-ref-name> 4 <res-type>javax.sql.DataSource</res-type> 5 <res-auth>Container</res-auth> 6 </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>元素完整配置:
1 <jsp-config> 2 <taglib> 3 <taglib-uri>Taglib</taglib-uri> 4 <taglib-location>/WEB-INF/tlds/MyTaglib.tld</taglib-location> 5 </taglib> 6 <jsp-property-group> 7 <description>Special property group for JSP Configuration JSP example.</description> 8 <display-name>JSPConfiguration</display-name> 9 <url-pattern>/jsp/* </url-pattern> 10 <el-ignored>true</el-ignored> 11 <page-encoding>GB2312</page-encoding> 12 <scripting-invalid>true</scripting-invalid> 13 <include-prelude>/include/prelude.jspf</include-prelude> 14 <include-coda>/include/coda.jspf</include-coda> 15 </jsp-property-group> 16 </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文件:
1 <?xml version=‘1.0‘ encoding=‘utf-8‘?> 2 <tomcat-users> 3 <role rolename="tomcat"/> 4 <role rolename="manager"/> 5 <role rolename="admin"/> 6 <user username="tomcat" password="tomcat" roles="tomcat"/> 7 <user username="both" password="tomcat" roles="tomcat,manager"/> 8 <user username="admin" password="admin" roles="admin"/> 9 </tomcat-users>
此XML片段包括一個tomcat-users根元素,它包含一個或多個role和user元素。
然後在Web應用程序的web.xml中創建security-constraint、login-config和security-role元素。
1 <security-constraint> 2 <web-resource-collection> 3 <web-resource-name>HelloServlet</web-resource-name> 4 <url-pattern>/HelloServlet</url-pattern> 5 <http-method>GET</http-method> 6 <http-method>POST</http-method> 7 </web-resource-collection> 8 <auth-constraint> 9 <description>This applies only to the "tomcat" security role</description> 10 <role-name>admin</role-name> 11 </auth-constraint> 12 <user-data-constraint> 13 <transport-guarantee>NONE</transport-guarantee> 14 </user-data-constraint> 15 </security-constraint> 16 17 <login-config> 18 <auth-method>BASIC</auth-method> 19 </login-config> 20 <security-role> 21 <role-name>admin</role-name> 22 </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資源。
部分轉自:https://www.cnblogs.com/morlin/p/4301063.html(web.xml配置介紹)
關於deployment descripter(web.xml)的認識