web.xml文件的作用及基本配置

Java的web工程中的web.xml文件有什麼作用呢?它是每個web工程都必須的嗎?

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

那什麼時候需要,什麼時候可以不需要呢?

要想回答上面的問題,得先了解web.xml文件是用來幹什麼的。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文件。        當你只指定一個web的根名,沒有指定具體頁面,去訪問時一個web時, 如果web.xml文件中配置了歡迎頁,那麼就返回指定的那個頁面作爲歡迎頁,而在文中沒有web.xml文件,或雖然有web.xml,但web.xml也沒指定歡迎頁的情況下,那麼不同的應用服務器可能會有不同的行爲,對於tomcat來說,它默認先查找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的根名。但如果你指定了具體頁面,是可以正常訪問的。(如果web根名下存在index.html和index.jsp,而某些應用服務器在web.xml中沒指定歡迎頁的情況下默認先查找index.jsp的話,其行爲跟tomcat就不一樣了,因此可能造成沒配置web.xml歡迎頁的項目,部署到不同的應用服務器看到不一樣的首頁的現象)。

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>[email protected]</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.XXXListener</listener-class> </listener>

7、設置會話(Session)過期時間,其中時間以分鐘爲單位,假如設置60分鐘超時: <session-config> <session-timeout>60</session-timeout> </session-config>

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

下面再列出一些網友總結的web.xml常用配置元素:

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>  

 如果是用myeclipse編輯web.xml,在設計模式下能看到web.xml中都可以編輯哪些元素,很方便,如下圖。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章