关于Java Web应用中的配置描述符web.xml

一．web.xml概述

位于每个Web应用的WEB-INF路径下的web.xml文件被称为配置描述符，这个 web.xml文件对于Java Web应用十分重要，每个Java Web应用都必须包含一个web.xml文件，且必须放在WEB-INF路径下。

对于Java Web应用而言，WEB-INF是一个特殊的文件夹，Web容器会包含该文件夹下的内容，客户端浏览器无法访问WEB-INF路径下的任何内容。
Java Web应用的绝大部分内容都由web.xml文件来配置管理。我们后面介绍的如下内容都要通过web.xml文件进行配置管理：

（1）配置JSP。

（2）配置和管理Servlet。

（3）配置和管理Listener。

（4）配置和管理Filter。

（5）配置标签库。

（6）配置JSP属性。

除此之外，web.xml还负责配置、管理如下常用内容：

（7）配置和管理JAAS授权认证。

（8）配置和管理资源引用。

（9）配置Web应用首页。

比如，在web.xml文件中配置首页使用welcome-file-list元素，该元素能包含多个welcome-file子元素，其中每个welcome-file子元素配置一个首页。例如如下配置片段：

<!-- 配置Web应用的首页列表 -->
<welcome-file-list>
<welcome-file>index.html</welcome-file>
<welcome-file>index.htm</welcome-file>
<welcome-file>index.jsp</welcome-file>
</welcome-file-list>

上面配置信息指定该Web应用的首页依次是index.html、index.htm和index.jsp，意思是说：当Web应用中包含index.html页面时，如果浏览者直接访问该Web应用，系统将会把该页面呈现给浏览者；当index.html页面不存在时，则由index.htm页面充当首页，依此类推。

每个Web容器都会提供一个系统的web.xml文件，用于描述所有Web应用共同的配置属性。例如，Tomcat的系统web.xml放在Tomcat的conf路径下，而Jetty的系统web.xml文件放在Jetty的etc路径下，文件名为webdefault.xml。

 

二．具体元素描述

1 定义头和根元素
部署描述符文件就像所有XML文件一样，必须以一个XML头开始。这个头声明可以使用的XML版本并给出文件的字符编码。
DOCTYPE声明必须立即出现在此头之后。这个声明告诉服务器适用的servlet规范的版本（如2.2或2.3）并指定管理此文件其余部分内容的语法的DTD(Document Type Definition，文档类型定义)。
所有部署描述符文件的顶层（根）元素为web-app。请注意，XML元素不像HTML，他们是大小写敏感的。因此，web-App和WEB-APP都是不合法的，web-app必须用小写。

2 部署描述符文件内的元素次序

在web-app元素内，元素的次序也很重要。服务器不一定强制要求这种次序，但它们允许（实际上有些服务器就是这样做的）完全拒绝执行含有次序不正确的元素的Web应用。这表示使用非标准元素次序的web.xml文件是不可移植的。
下面的列表给出了所有可直接出现在web-app元素内的合法元素所必需的次序。例如，此列表说明servlet元素必须出现在所有servlet-mapping元素之前。请注意，所有这些元素都是可选的。因此，可以省略掉某一元素，但不能把它放于不正确的位置。

（1）       icon：icon元素指出IDE和GUI工具用来表示Web应用的一个和两个图像文件的位置。

（2）       display-name：display-name元素提供的GUI工具可能用来标记这个特定的Web应用的一个名称。

（3）       context-param：context-param元素声明应用范围内的初始化参数。

（4）       filter：filter过滤器元素将一个名字与一个实现javax.servlet.Filter接口的类相关联。

（5）       filter-mapping：一旦命名了一个过滤器，就要利用filter-mapping元素把它与一个或多个servlet或JSP页面相关联。

（6）       listener：servlet API的版本2.3增加了对事件监听程序的支持，事件监听程序在建立、修改和删除会话或servlet环境时得到通知。Listener元素指出事件监听程序类。

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

（8）       servlet-mapping：服务器一般为servlet提供一个缺省的URL：http://host/webAppPrefix/servlet/ServletName。但是，常常会更改这个URL，以便servlet可以访问初始化参数或更容易地处理相对URL。在更改缺省URL时，使用servlet-mapping元素。

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

（10）   mime-mapping：如果Web应用具有想到特殊的文件，希望能保证给他们分配特定的MIME类型，则mime-mapping元素提供这种保证。

（11）   welcom-file-list：welcome-file-list元素指示服务器在收到引用一个目录名而不是文件名的URL时，使用哪个文件。

（12）   error-page：error-page元素使得在返回特定HTTP状态代码时，或者特定类型的异常被抛出时，能够制定将要显示的页面。

（13）   taglib：taglib元素对标记库描述符文件（Tag Libraryu Descriptor file）指定别名。此功能使你能够更改TLD文件的位置，而不用编辑使用这些文件的JSP页面。

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

（15）   resource-ref：resource-ref元素声明一个资源工厂使用的外部资源。

（16）   security-constraint：security-constraint元素制定应该保护的URL。它与login-config元素联合使用。

（17）   login-config：用login-config元素来指定服务器应该怎样给试图访问受保护页面的用户授权。它与sercurity-constraint元素联合使用。

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

（19）   env-entry：env-entry元素声明Web应用的环境项。

（20）   ejb-ref：ejb-ref元素声明一个EJB的主目录的引用。

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