java web部署描述符web.xml详解

web.xml是一个java web应用的核心文件。它控制整个web应用的行为方式和方法。下面介绍一个标准的web配置文件：
 
1、头元素：指定版本和文字编码。
<?xml version="1.0" encoding="UTF-8"?>
 
2、文档类型：指定dtd文档的位置：
<!DOCTYPE web-app
PUBLIC "-//Sun Microsystem,Inc.//DTD Web Application 2.3//EN"
"http://java.sun.com/dtd/web-app_2.3.dtd">
<web-app>

 
3、Web应用图标：指出IDE和GUI工具用来表示Web应用的大图标和小图标。
<icon>
   <small-icon>/images/app_small.gif</small-icon>
   <large-icon>/images/app_large.gif</large-icon>
</icon>

 
4、Web应用的名称：提供GUI工具可能会用到的标记这个特定的Web应用的一个名称。
<display-name>Tomcat Examples</display-name>

 
5、Web应用描述：给出与此有关的说明性文本。

<description>Tomcat Example servlet and JSP pages.</description>

 
6、分布式属性：Tomcat集群参数
<distributable/>

 
7、上下文参数：声明应用范围内的初始化参数。
<context-param>
   <param-name>ContextParameter</param-name>
   <param-value>test</param_value>
   <description>it is a test parameter.</description>
</context-param>

 
8、过滤器定义：将一个名字与一个实现javax.servlet.Filter接口的类相关联。
<filter>
   <filter-name>Set Character Encoding</filter-name>
   <filter-calss>filters.SetCharacterEncodingFilter</filter-class>
   <init-param>
       <param-name>encoding</param-name>
       <param-value>EUC_JP</param-value>
   </init-param>
</filter>

 
9、过滤器映射：一旦命名了一个过滤器，就要利用filter-mapping元素把他和一个活多个servlet或JSP页面相关联。
<filter-mapping>
   <filter-name>Set Chaeacter Encoding<filter-name>
   <url-pattern>/*</url-pattern>
</filter-mapping>

 
10、监听器：servlet2.3增加了对事件监听程序的支持，事件监听程序在建立、修改和删除回话或Servlet环境时得到通知。listener元素指出事件的监听程序类。
<listener>
    <listener-calss>listener.SessionListener</listener-calss>
</listener>

 
11、Servlet定义：在向Servlet或JSP页面制定初始化参数或定制URl时，必须首先命名Servlet或JSP页面。servlet元素就是用来完成此项任务的。

<servlet>
    <servlet-name>snoop</servlet-name>
    <servlet-class>SoonpServlet<//servlet-class>
    <init-param>
        <param-name>foo</param-name>
        <param-value>bar</param-value>
    </init-param>
    <run-as>
        <description>Security role for annoymous access</description>
        <role-name>tomcat</role-name>
    </run-as>
</servlet>

 
12、servlet映射：服务器一般为servlet提供一个默认的URl：

http://host/webAppPrefix/servlet/ServletName。但是，常常会更改这个URL，以便servlet可以访问初始化参数或更容易地处理相对URL。在更改默认URL时，使用servlet-mapping元素。

<servlet-mapping>
    <servlet-name>snoop</servlet-name>
    <url-parttern>/snoop</url-pattern>
</servlet-mapping>

 
13、控制回话超时：如果某个会话在一定时间内未被访问，服务器可以抛弃它以节省内存。可以通过使用HttpSession的setMaxInactiveInterval方法明确设置单个会话对象的超时值，或者利用session-config元素制定默认超时值。

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

 
14、MIME类型映射：如果web应用想给特殊的文件分配特定的MIME类型，那么mime-mapping元素提供这种保证。

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

 
15、指定欢迎文件页：welcome-file-list元素指示服务器在收到引用一个目录名而不是文件名的URl时，使用哪个文件。

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

 
16、错误处理页：error-page元素使得在返回特定HTTP状态代码时，或者特定类型的异常被抛出时，能够指定将要显示的页面。

 <error-page>
     <error-code>404</error-code>
     <location>/NotFound.jsp</location>
 </error-page>
 <error-page>
     <exception-type>packageName.className</exception-type>
     <location>/SomeURl</location>
 </error-page>

 
17、定位TLD：taglib元素对标记库描述文件指定别名。此功能是你能够更改TLD文件的位置，而不用编辑使用这些文件的JSP页面。

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

 
18、资源管理对象：resource-env-ref元素声明与资源相关的一个管理对象。

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

 
19、资源工厂使用的资源：resource-ref元素声明一个资源工厂使用的外部资源。
<resource-ref>
    <res-ref-name>mail/Session</res-ref-name>
    <res-type>javax.mail.Session</res-type>
    <res-auth>Container</res-auth>
</resource-ref>

 
20、安全限制：security-constraint指定应该保护的URL。它与login-config元素联合使用。

<security-constraint>
    <display-name>Example Security Constraint</display-name>
    <web-resource-collection>
        <web-resource-name>Protected Area</web-resource-name>
        <url-pattern>jsp/secutity/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>

 
21、登录验证：用login-config元素来指定服务器应该怎样给试图访问受保护页面的用户授权。它与security-constraint元素联合使用。

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

 
22、安全角色：security-role元素给出安全角色的一个列表，这些角色将出现在servlet元素内的security-role-ref元素的role-name自元素中。分别地声明角色可使高级IDE处理安全信息更容易

<security-role>
    <role-name>tomact</role-name>
</security-role>

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

 
24 EJB声明：ejb-ref元素声明一个EJB的主目录的引用。
<ejb-ref>
    <description>Example EJB Reference</description>
    <ejb-ref-name>ejb/Acount</ejb-ref-name>
    <ejb-ref-type>Entity</ejb-ref-type>
    <home>com.mycompany.maypackage.AccountHome</home>
    <remote>com.mycompany.mypackage.Account</remote>
</ejb-ref>

 
25、本地ejb声明：ejb-local-ref元素声明一个EJB的本地主目录的应用。

<ejb-local-ref>
    <description>Example Local EJB Reference</description>
    <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>

</web-app>

 
上面是web.xml文件中定义的25个有基本意义的配置项，其中除了前两项之外，其余23项均需包含在<web-app></web-app>之间。