Java Web的web.xml文件作用及基本配置(轉)


其實web.xml就是asp.net的web.config一個道理。

說明:

一個web中完全可以沒有web.xml文件,也就是說,web.xml文件並不是web工程必須的。

web.xml文件是用來配置:歡迎頁、servlet、filter等的。當你的web工程沒用到這些時,你可以不用web.xml文件來配置你的web工程。

web.xml能做的事情:

其實,web.xml的模式(Schema)文件中定義了多少種標簽元素,web.xml中就可以出現它的模式文件所定義的標簽元素,它就能擁有定義出來的那些功能。

web.xml的模式文件是由Sun公司定義的,每個web.xml文件的根元素<web-app>中,都必須標明這個web.xml使用的是哪個模式文件。如:

<?xml version="1.0" encoding="UTF-8"?>
<web-app version="2.5"
xmlns="http://Java.sun.com/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">
</web-app>

而且web.xml的模式文件中定義的標簽並不是定死的,模式文件也是可以改變的,一般來說,隨着web.mxl模式文件的版本升級,里面定義的功能會越來越復雜,也即標簽元素的種類會越來越多,但有些是不常用的,我們只需記住一些常用的就可以了。

下面列出web.xml常用的標簽元素及這些標簽元素的功能:

1、指定歡迎頁面,例如:

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

上面的例子指定了2個歡迎頁面,顯示時按順序從第一個找起,如果第一個存在,就顯示第一個,后面的不起作用。如果第一個不存在,就找第二個,以此類推。

關於歡迎頁面:

訪問一個網站時,默認看到的第一個頁面就叫歡迎頁,一般情況下是由首頁來充當歡迎頁的。一般情況下,我們會在web.xml中指定歡迎頁。但web.xml並不是一個Web的必要文件,沒有web.xml,網站仍然是可以正常工作的。只不過網站的功能復雜起來后,web.xml的確有非常大用處,所以,默認創建的動態web工程在WEB-INF文件夾下面都有一個web.xml文件。

對於tomcat來說,當你只指定一個web的根名,沒有指定具體頁面,去訪問時一個web時,如果web.xml文件中配置了歡迎頁,那么就返回指定的那個頁面作為歡迎頁,而在文中沒有web.xml文件,或雖然有web.xml,但web.xml也沒指定歡迎頁的情況下,它默認先查找index.html文件,如果找到了,就把index.html作為歡迎頁還回給瀏覽器。如果沒找到index.html,tomcat就去找index.jsp。找到index.jsp就把它作為歡迎頁面返回。而如果index.html和index.jsp都沒找到,又沒有用web.xml文件指定歡迎頁面,那此時tomcat就不知道該返回哪個文件了,它就顯示The requested resource (/XXX) is not available的頁面。其中XXX表示web的根名。但如果你指定了具體頁面,是可以正常訪問的。

2、命名與定制URL。我們可以為Servlet和JSP文件命名並定制URL,其中定制URL是依賴一命名的,命名必須在定制URL前。下面拿serlet來舉例:

(1)、為Servlet命名:

<servlet>
<servlet-name>servlet1</servlet-name>
<servlet-class>net.test.TestServlet</servlet-class>
</servlet>

(2)、為Servlet定制URL、

<servlet-mapping>
<servlet-name>servlet1</servlet-name>
<url-pattern>*.do</url-pattern>
</servlet-mapping>

3、定制初始化參數:可以定制servlet、JSP、Context的初始化參數,然后可以再servlet、JSP、Context中獲取這些參數值。下面哪servlet來舉例:

<servlet>
<servlet-name>servlet1</servlet-name>
<servlet-class>net.test.TestServlet</servlet-class>
<init-param>
<param-name>userName</param-name>
<param-value>Tommy</param-value>
</init-param>
<init-param>
<param-name>E-mail</param-name>
<param-value>Tommy@163.com</param-value>
</init-param>
</servlet>

經過上面的配置,在servlet中能夠調用getServletConfig().getInitParameter("param1")獲得參數名對應的值。

4、指定錯誤處理頁面,可以通過“異常類型”或“錯誤碼”來指定錯誤處理頁面。

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

5、設置過濾器:比如設置一個編碼過濾器,過濾所有資源

<filter>
<filter-name>XXXCharaSetFilter</filter-name>
<filter-class>net.test.CharSetFilter</filter-class>
</filter>
<filter-mapping>
<filter-name>XXXCharaSetFilter</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>

6、設置監聽器:

<listener>
<listener-class>net.test.XXXLisenet</listener-class>
</listener>

7、設置會話(Session)過期時間,其中時間以分鍾為單位,假如設置60分鍾超時:

<session-config>
<session-timeout>60</session-timeout>
</session-config>

除了這些標簽元素之外,還可以往web.xml中添加那些標簽元素呢,那些標簽元素都能起什么作用呢?我們只要去查看web.xml的模式文件就能知道。直接看模式文件看不懂,可以找一些中文教程來看看。

Web.xml加載順序
一、

1、啟動一個WEB項目的時候,WEB容器會去讀取它的配置文件web.xml,讀取<listener>和<context-param>兩個結點。

2、緊急着,容創建一個ServletContext(servlet上下文),這個web項目的所有部分都將共享這個上下文。

3、容器將<context-param>轉換為鍵值對,並交給servletContext。

4、容器創建<listener>中的類實例,創建監聽器。

二、
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。

最終得出的結論是: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 的加載順序是:context-param -> listener -> filter-> servlet ,而同個類型之間的實際程序調用的時候的順序是根據對應的 mapping 的順序進行調用的。

web.xml文件詳解

一、Web.xml常用元素 

<web-app>
<display-name></display-name>定義了WEB應用的名字 
<description></description> 聲明WEB應用的描述信息 
<context-param></context-param> context-param元素聲明應用范圍內的初始化參數。 
<filter></filter> 過濾器元素將一個名字與一個實現javax.servlet.Filter接口的類相關聯。 
<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。 但是,常常會更改這個URL,以便servlet可以訪問初始化參數或更容易地處理相對URL。在更改缺省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> 

二、相應元素配置
1、Web應用圖標:指出IDE和GUI工具用來表示Web應用的大圖標和小圖標

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

2、Web 應用名稱:提供GUI工具可能會用來標記這個特定的Web應用的一個名稱

<display-name>Tomcat Example</display-name> 

3、Web 應用描述:給出於此相關的說明性文本

<disciption>Tomcat Example servlets and JSP pages.</disciption> 

4、上下文參數:聲明應用范圍內的初始化參數。

<context-param> 
<param-name>ContextParameter</para-name> 
<param-value>test</param-value> 
<description>It is a test parameter.</description> 
</context-param> 

在servlet里面可以通過getServletContext().getInitParameter("context/param")得到

5、過濾器配置:將一個名字與一個實現javaxs.servlet.Filter接口的類相關聯。

<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-mapping> 
<filter-name>setCharacterEncoding</filter-name> 
<url-pattern>/*</url-pattern> 
</filter-mapping> 

6、監聽器配置

<listener> 
<listerner-class>listener.SessionListener</listener-class> 
</listener> 

7、Servlet配置

基本配置

<servlet> 
<servlet-name>snoop</servlet-name> 
<servlet-class>SnoopServlet</servlet-class> 
</servlet> 
<servlet-mapping> 
<servlet-name>snoop</servlet-name> 
<url-pattern>/snoop</url-pattern> 
</servlet-mapping> 

高級配置

<servlet> 
<servlet-name>snoop</servlet-name> 
<servlet-class>SnoopServlet</servlet-class> 
<init-param> 
<param-name>foo</param-name> 
<param-value>bar</param-value> 
</init-param> 
<run-as> 
<description>Security role for anonymous access</description> 
<role-name>tomcat</role-name> 
</run-as> 
</servlet> 
<servlet-mapping> 
<servlet-name>snoop</servlet-name> 
<url-pattern>/snoop</url-pattern> 
</servlet-mapping> 

元素說明

<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類中通過getInitParamenter(String name)方法訪問初始化參數 
<load-on-startup></load-on-startup>指定當Web應用啟動時,裝載Servlet的次序。 當值為正數或零時:Servlet容器先加載數值小的servlet,再依次加載其他數值大的servlet. 當值為負或未定義:Servlet容器將在Web客戶首次訪問這個servlet時加載它 
<servlet-mapping></servlet-mapping> 用來定義servlet所對應的URL,包含兩個子元素 
<servlet-name></servlet-name> 指定servlet的名稱 
<url-pattern></url-pattern> 指定servlet所對應的URL 

8、會話超時配置(單位為分鍾) 

<session-config>
<session-timeout>120</session-timeout> 
</session-config> 

 

9、MIME類型配置

<mime-mapping> 
<extension>htm</extension> 
<mime-type>text/html</mime-type> 
</mime-mapping> 

10、指定歡迎文件頁配置

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

11、配置錯誤頁面

一、通過錯誤碼來配置error-page

<error-page> 
<error-code>404</error-code> 
<location>/NotFound.jsp</location> 
</error-page> 

上面配置了當系統發生404錯誤時,跳轉到錯誤處理頁面NotFound.jsp。

二、通過異常的類型配置error-page

<error-page> 
<exception-type>java.lang.NullException</exception-type> 
<location>/error.jsp</location> 
</error-page> 

上面配置了當系統發生java.lang.NullException(即空指針異常)時,跳轉到錯誤處理頁面error.jsp

12、TLD配置

<taglib> 
<taglib-uri>http://jakarta.apache.org/tomcat/debug-taglib</taglib-uri> 
<taglib-location>/WEB-INF/jsp/debug-taglib.tld</taglib-location> 
</taglib> 

如果MyEclipse一直在報錯,應該把<taglib> 放到 <jsp-config>中

<jsp-config> 
<taglib> 
<taglib-uri>http://jakarta.apache.org/tomcat/debug-taglib</taglib-uri> 
<taglib-location>/WEB-INF/pager-taglib.tld</taglib-location> 
</taglib> 
</jsp-config> 

13、資源管理對象配置

<resource-env-ref> 
<resource-env-ref-name>jms/StockQueue</resource-env-ref-name> 
</resource-env-ref>

14、資源工廠配置

<resource-ref> 
<res-ref-name>mail/Session</res-ref-name> 
<res-type>javax.mail.Session</res-type> 
<res-auth>Container</res-auth> 
</resource-ref> 

配置數據庫連接池就可在此配置:

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

15、安全限制配置

<security-constraint> 
<display-name>Example Security Constraint</display-name> 
<web-resource-collection> 
<web-resource-name>Protected Area</web-resource-name> 
<url-pattern>/jsp/security/protected/*</url-pattern> 
<http-method>DELETE</http-method> 
<http-method>GET</http-method> 
<http-method>POST</http-method> 
<http-method>PUT</http-method> 
</web-resource-collection> 
<auth-constraint> 
<role-name>tomcat</role-name> 
<role-name>role1</role-name> 
</auth-constraint> 
</security-constraint> 

16、登陸驗證配置

<login-config> 
<auth-method>FORM</auth-method> 
<realm-name>Example-Based Authentiation Area</realm-name> 
<form-login-config> 
<form-login-page>/jsp/security/protected/login.jsp</form-login-page>
<form-error-page>/jsp/security/protected/error.jsp</form-error-page>
</form-login-config> 
</login-config> 

17、安全角色:security-role元素給出安全角色的一個列表,這些角色將出現在servlet元素內的security-role-ref元素的role-name子元素中。 分別地聲明角色可使高級IDE處理安全信息更為容易。 

<security-role>
<role-name>tomcat</role-name> 
</security-role> 

 

18、Web環境參數:env-entry元素聲明Web應用的環境項

<env-entry> 
<env-entry-name>minExemptions</env-entry-name> 
<env-entry-value>1</env-entry-value> 
<env-entry-type>java.lang.Integer</env-entry-type> 
</env-entry> 

19、EJB 聲明

<ejb-ref> 
<description>Example EJB reference</decription> 
<ejb-ref-name>ejb/Account</ejb-ref-name> 
<ejb-ref-type>Entity</ejb-ref-type> 
<home>com.mycompany.mypackage.AccountHome</home> 
<remote>com.mycompany.mypackage.Account</remote> 
</ejb-ref> 

20、本地EJB聲明

<ejb-local-ref> 
<description>Example Loacal EJB reference</decription> 
<ejb-ref-name>ejb/ProcessOrder</ejb-ref-name> 
<ejb-ref-type>Session</ejb-ref-type> 
<local-home>com.mycompany.mypackage.ProcessOrderHome</local-home> 
<local>com.mycompany.mypackage.ProcessOrder</local> 
</ejb-local-ref> 

21、配置DWR

<servlet> 
<servlet-name>dwr-invoker</servlet-name> 
<servlet-class>uk.ltd.getahead.dwr.DWRServlet</servlet-class> 
</servlet> 
<servlet-mapping> 
<servlet-name>dwr-invoker</servlet-name> 
<url-pattern>/dwr/*</url-pattern> 
</servlet-mapping> 

22、配置Struts

<display-name>Struts Blank Application</display-name> 
<servlet> 
<servlet-name>action</servlet-name> 
<servlet-class> 
org.apache.struts.action.ActionServlet 
</servlet-class> 
<init-param> 
<param-name>detail</param-name> 
<param-value>2</param-value>
</init-param> 
<init-param> 
<param-name>debug</param-name> 
<param-value>2</param-value> 
</init-param> 
<init-param> 
<param-name>config</param-name> 
<param-value>/WEB-INF/struts-config.xml</param-value> 
</init-param> 
<init-param> 
<param-name>application</param-name> 
<param-value>ApplicationResources</param-value> 
</init-param> 
<load-on-startup>2</load-on-startup> 
</servlet> 
<servlet-mapping> 
<servlet-name>action</servlet-name> 
<url-pattern>*.do</url-pattern> 
</servlet-mapping> 
<welcome-file-list> 
<welcome-file>index.jsp</welcome-file> 
</welcome-file-list> 

<!-- Struts Tag Library Descriptors --> 
<taglib> 
<taglib-uri>struts-bean</taglib-uri> 
<taglib-location>/WEB-INF/tld/struts-bean.tld</taglib-location> 
</taglib> 
<taglib> 
<taglib-uri>struts-html</taglib-uri> 
<taglib-location>/WEB-INF/tld/struts-html.tld</taglib-location> 
</taglib> 
<taglib> 
<taglib-uri>struts-nested</taglib-uri> 
<taglib-location>/WEB-INF/tld/struts-nested.tld</taglib-location> 
</taglib> 
<taglib> 
<taglib-uri>struts-logic</taglib-uri> 
<taglib-location>/WEB-INF/tld/struts-logic.tld</taglib-location> 
</taglib> 
<taglib> 
<taglib-uri>struts-tiles</taglib-uri> 
<taglib-location>/WEB-INF/tld/struts-tiles.tld</taglib-location> 
</taglib>

23、配置spring(基本上都是在Struts中配置的)

<!-- 指定spring配置文件位置 --> 
<context-param> 
<param-name>contextConfigLocation</param-name> 
<param-value> 
<!--加載多個spring配置文件 --> 
/WEB-INF/applicationContext.xml, /WEB-INF/action-servlet.xml 
</param-value> 
</context-param> 
<!-- 定義SPRING監聽器,加載spring --> 
<listener> 
<listener-class>org.springframework.web.context.ContextLoaderListener
</listener-class> 
</listener> 
<listener> 
<listener-class> 
org.springframework.web.context.request.RequestContextListener 
</listener-class> 
</listener>

 

 

 原文:http://blog.csdn.net/shanliangliuxing/article/details/7458492

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM