web.xml

 

 

一、web.xml学名叫部署描述符文件，是在Servlet规范中定义的，是web应用的配置文件。

 

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

 

[html] view plain copy

 1.  <?xml version="1.0" encoding="UTF-8"?>  

2.  <!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN" "http://java.sun.com/dtd/web-app_2_3.dtd">  

3.  <web-app>  

4.  </web-app>  

三、web.xml中XML 元素不只是大小写敏感的，并且它们还对出如今其余元素中的次序敏感。例如，XML头必须是文件中的第一项，DOCTYPE声明必须是第二项，而web- app元素必须是第三项。在web-app元素内，元素的次序也很重要。服务器不必定强制要求这种次序，但它们容许（实际上有些服务器就是这样作的）彻底拒绝执行含有次序不正确的元素的Web应用。这表示使用非标准元素次序的web.xml文件是不可移植的。

    icon icon元素指出IDE和GUI工具用来表示Web应用的一个和两个图像文件的位置。
   display-name display-name元素提供GUI工具可能会用来标记这个特定的Web应用的一个名称。
   description description元素给出与此有关的说明性文本。
   context-param context-param元素声明应用范围内的初始化参数。
   filter 过滤器元素将一个名字与一个实现javax.servlet.Filter接口的类相关联。
   filter-mapping 一旦命名了一个过滤器，就要利用filter-mapping元素把它与一个或多个servlet或JSP页面相关联。
   listener servlet API的版本2.3增长了对事件监听程序的支持，事件监听程序在创建、修改和删除会话或servlet环境时获得通知。Listener元素指出事件监听程序类。
  servlet在向servlet或JSP页面制定初始化参数或定制URL时，必须首先命名servlet或JSP页面。Servlet元素就是用来完成此项任务的。
   servlet-mapping 服务器通常为servlet提供一个缺省的URL：http://host/webAppPrefix/servlet/ServletName。可是，经常会更改这个URL，以便servlet能够访问初始化参数或更容易地处理相对URL。在更改缺省URL时，使用servlet-mapping元素。
   session-config 若是某个会话在必定时间内未被访问，服务器能够抛弃它以节省内存。可经过使用HttpSession的setMaxInactiveInterval方法明确设置单个会话对象的超时值，或者可利用session-config元素制定缺省超时值。
   mime-mapping 若是Web应用具备想到特殊的文件，但愿能保证给他们分配特定的MIME类型，则mime-mapping元素提供这种保证。
   welcom-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的本地主目录的应用。

元素<icon>

含义

icon元素包含small-icon和large-icon两个子元素.用来指定web站台中小图标和大图标的路径.
<small-icon>/路径/smallicon.gif</small-icon>
small-icon元素应指向web站台中某个小图标的路径,大小为16 X 16 pixel,可是图象文件必须为GIF或JPEG格式,扩展名必须为:.gif或.jpg.

<large-icon>/路径/largeicon-jpg</large-icon>
large-icon元素应指向web站台中某个大图表路径,大小为32 X 32 pixel,可是图象文件必须为GIF或JPEG的格式,扩展名必须为; gif或jpg.

范例

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

元素<display-name>，<description>

含义

<display-name>应用名称</display-name>
定义应用的名称。

<description>应用描述</discription>
对应用作出描述。

范例

<display-name>test</display-name>

<description>测试应用V1.0</discription>

元素<context-param>

含义

context-param 元素用来设定web应用的环境参数(context),它包含两个子元素:
param-name和param-value.
<param-name>参数名称</param-name>
设定Context名称
<param-value>值</param-value>
设定Context名称的值

filter元素

filter元素用于指定Web容器中的过滤器。在请求和响应对象被servlet处理以前或以后，可使用过滤器对这两个对象进行操做。利用下一节介绍的filter-mapping元素，过滤器被映射到一个servlet或一个URL模式。这个过滤器的filter元素和filter-mapping元素必须具备相同的名称。

<!ELEMENT filter (icon?, filter-name, display-name?, description?,

filter-class, init-param*)>

<!ELEMENT filter-name (#PCDATA)>

<!ELEMENT filter-class (#PCDATA)>

icon、display-name和description元素的用法和上一节介绍的用法相同。init-param元素与context-param元素具备相同的元素描述符。filter-name元素用来定义过滤器的名称，该名称在整个应用中都必须是唯一的。filter-class元素指定过滤器类的彻底限定的名称。

下面是一个使用filter元素的部署描述符的例子：

<?xml version=”1.0” encoding=”ISO-8859-1”?>

<!DOCTYPE web-app

PUBLIC “-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN”

“http://java.sun.com/dtd/web-app_2_3.dtd”>

<web-app>

<filter>

<filter-name>Encryption Filter</filter-name>

<filter-class>com.branysoftware.EncryptionFilter</filter-class>

</filter>

</web-app>

filter-mapping元素

filter-mapping元素用来声明Web应用中的过滤器映射。过滤器可被映射到一个servlet或一个URL模式。将过滤器映射到一个servlet中会形成过滤器做用于servlet上。将过滤器映射到一个URL模式中则能够将过滤器应用于任何资源，只要该资源的URL与URL模式匹配。过滤是按照部署描述符的filter-mapping元素出现的顺序执行的。

<!ELEMENT filter-mapping (filter-name, (url-pattern | servlet-name))>

<!ELEMENT filter-name (#PCDATA)>

<!ELEMENT url-pattern (#PCDATA)>

<!ELEMENT servlet-name (#PCDATA)>

filter-name值必须对应filter元素中声明的其中一个过滤器名称。下面是一个含有filter-mapping元素的部署描述符：

<?xml version=”1.0” encoding=”ISO-8859-1”>

<!DOCTYPE web-app

PUBLIC “-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN”

“http://java.sun.com/dtd/web-app_2_3.dtd”>

<web-app>

<filter>

<filter-name>Encryption Filter</filter-name>

<filter-class>com.brainysoftware.EncryptionFilter</filter-class>

</filter>

<filter-mapping>

<filter-name>Encryption Filter</filter-name>

<servlet-name>EncryptionFilteredServlet</servlet-name>

</filter-mapping>

</web-app>

listener元素

listener元素用来注册一个监听器类，能够在Web应用中包含该类。使用listener元素，能够收到事件何时发生以及用什么做为响应的通知。

<!ELEMENT listener (listener-class)>

<!ELEMENT listener-class (#PCDATA)>

下面是一个含有listener元素的有效部署描述符：

<?xml version=”1.0” encoding=”ISO-8859-1”?>

<!DOCTYPE web-app

PUBLIC “-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN”

“http://java.sun.com/dtd/web-app_2_3.dtd”>

<web-app>

<listener>

<listener-class>MyAppListener</listener-class>

</listener>

</web-app>

 servlet元素

servlet元素用来声明一个servlet。

<!ELEMENT servlet (icon?, servlet-name, display-name?, description?,

(servlet-class|jsp-file), init-param*, load-on-startup?, run-as?,

security-role-ref*)>

<!ELEMENT servlet-name (#PCDATA)>

<!ELEMENT servlet-class (#PCDATA)>

<!ELEMENT jsp-file (#PCDATA)>

<!ELEMENT init-param (param-name, param-value, description?)>

<!ELEMENT load-on-startup (#PCDATA)>

<!ELEMENT run-as (description?, role-name)>

<!ELEMENT role-name (#PCDATA)>

icon、display-name和description元素的用法和上一节介绍的用法相同。init-param元素与context-param元素具备相同的元素描述符。可使用init-param子元素将初始化参数名和参数值传递给servlet。

(1) servlet-name、servlet-class和jsp-file元素

servlet元素必须含有servlet-name元素和servlet-class元素，或者servlet-name元素和jsp-file元素。描述以下：

●       servlet-name元素用来定义servlet的名称，该名称在整个应用中必须是唯一的。

●       servlet-class元素用来指定servlet的彻底限定的名称。

●       jsp-file元素用来指定应用中JSP文件的完整路径。这个完整路径必须由a/开始。

(2) load-on-startup元素

当启动Web容器时，用load-on-startup元素自动将servlet加入内存。加载servlet就意味着实例化这个servlet，并调用它的init方法。可使用这个元素来避免第一个servlet请求的响应由于servlet载入内存所致使的任何延迟。若是load-on-startup元素存在，并且也指定了jsp-file元素，则JSP文件会被从新编译成servlet，同时产生的servlet也被载入内存。

load-on-startup元素的内容能够为空，或者是一个整数。这个值表示由Web容器载入内存的顺序。举个例子，若是有两个servlet元素都含有load-on-startup子元素，则load-on-startup子元素值较小的servlet将先被加载。若是load-on-startup子元素值为空或负值，则由Web容器决定何时加载servlet。若是两个servlet的load-on-startup子元素值相同，则由Web容器决定先加载哪个servlet。

(3) run-as元素

若是定义了run-as元素，它会重写用于调用Web应用中servlet所设定的Enterprise JavaBean(EJB)的安全身份。Role-name是为当前Web应用定义的一个安全角色的名称。

(4) security-role-ref元素

security-role-ref元素定义一个映射，该映射在servlet中用isUserInRole (String name)调用的角色名与为Web应用定义的安全角色名之间进行。security-role-ref元素的描述以下：

<!ELEMENT security-role-ref (description?, role-name, role-link)>

<!ELEMENT description (#PCDATA)>

<!ELEMENT role-name (#PCDATA)>

<!ELEMENT role-link (#PCDATA)>

role-link元素用来将安全角色引用连接到已定义的安全角色。role-link元素必须含有已经在security-role元素中定义的一个安全角色的名称。

(5) Faces Servlet的servlet元素

在 JSF应用中，须要为Faces Servlet定义一个servlet元素，以下所示：

<?xml version=”1.0”?>

<!DOCTYPE web-app PUBLIC

“-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN”

“http://java.sun.com/dtd/web-app_2_3.dtd”>

<web-app>

<!– Faces Servlet –>

<servlet>

<servlet-name>Faces Servlet</servlet-name>

<servlet-class>javax.faces.webapp.FacesServlet</servlet-class>

<load-on-startup> 1 </load-on-startup>

</servlet>

<!– Faces Servlet Mapping –>

<servlet-mapping>

<servlet-name>Faces Servlet</servlet-name>

<url-pattern>/faces/*</url-pattern>

</servlet-mapping>

</web-app>

seervlet-mapping 元素

seervlet-mapping 元素将URL模式映射到某个servlet。

<!ELEMENT servlet-mapping (servlet-name, url-pattern)>

<!ELEMENT servlet-name (#PCDATA)>

<!ELEMENT url-pattern (#PCDATA)>