Deployment Descriptor Web.xml

Deployment Descriptor部署描述符:

- 部署描述符是要部署到Web容器或EJB容器的Web应用程序或EJB应用程序的配置文件。

- 部署描述符应包含EJB应用程序中所有企业bean的标准结构信息。

- 文件名是ejb-jar.xml，EJB的描述符通知EJB服务器有关构成bean实现的类，主接口和远程接口。

- 标准部署描述符应包含每个企业bean的结构信息。

什么是部署描述符？

- Deployment Descriptor是一个扩展名为.xml的XML文档。

- 它基本上描述了应用程序或模块或组件的部署设置。

- 在运行时，J2EE服务器读取部署描述符并理解它，然后根据描述符中提到的信息对组件或模块进行操作。

- 例如，EJB模块有一个部署描述符ejb-jar.xml，我们在其中提到它是会话或实体还是消息驱动的bean以及Bean类所在的位置以及什么类型的事务等等。

- 简而言之，没有部署描述符Container（EJB / Servlet / JSP容器）不知道如何处理该模块。

- 部署描述符是定义以下类型信息的文件：

- EJB结构信息，例如EJB名称，类，home和远程接口，bean类型（会话或实体），环境条目，资源工厂引用，EJB引用，安全角色引用，以及基于bean类型的其他信息。

- 应用程序程序集信息，例如EJB引用，安全角色，安全角色引用，方法权限和容器事务属性。

- 指定程序集描述符信息是应用程序组装器执行的可选任务。

---------------------------

转自：https://www.careerride.com/Java-what-is-deployment-descriptor.aspx

web.xml文件详解:

1、WEB工程加载web.xml过程

　　经过个人测试，WEB工程加载顺序与元素节点在文件中的配置顺序无关。即不会因为 filter 写在 listener 的前面而会先加载 filter。WEB容器的加载顺序是：ServletContext -> context-param -> listener -> filter -> servlet。并且这些元素可以配置在文件中的任意位置。

　　加载过程顺序如下：

1. 启动一个WEB项目的时候，WEB容器会去读取它的配置文件web.xml，读取<listener>和<context-param>两个结点。 
2. 紧急着，容创建一个ServletContext（servlet上下文），这个web项目的所有部分都将共享这个上下文。 
3. 容器将<context-param>转换为键值对，并交给servletContext。 
4. 容器创建<listener>中的类实例，创建监听器。 

2、web.xml文件元素详解

　　1、schema

　　web.xml的模式文件是由Sun公司定义的，每个web.xml文件的根元素<web-app>中，都必须标明这个 web.xml使用的是哪个模式文件。其它的元素都放在<web-app></web-app>之中。

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

　　2、<icon>Web应用图标

　　指出IDE和GUI工具用来表示Web应用的大图标和小图标。

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

　　3、<display-name>Web应用名称

　　提供GUI工具可能会用来标记这个特定的Web应用的一个名称

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

　　4、<disciption>Web应用描述

　　给出于此相关的说明性文本

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

　　5、<context-param>上下文参数

　　声明应用范围内的初始化参数。它用于向 ServletContext提供键值对，即应用程序上下文信息。我们的listener, filter等在初始化时会用到这些上下文中的信息。在servlet里面可以通过getServletContext().getInitParameter("context/param")得到。

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

　　6、<filter>过滤器

　　将一个名字与一个实现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>UTF-8</param-value>
    </init-param>
</filter>
<filter-mapping>
    <filter-name>setCharacterEncoding</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

　　7、<listener>监听器

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

　　8、<servlet>

　　<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

<!-- 基本配置 -->
<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>

　　9、<session-config>会话超时配置

　　单位为分钟。

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

　　10、<mime-mapping>

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

　　11、<welcome-file-list>欢迎文件页

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

　　12、<error-page>错误页面

<!-- 1、通过错误码来配置error-page。当系统发生×××错误时，跳转到错误处理页面。 -->
<error-page>
    <error-code>404</error-code>
    <location>/NotFound.jsp</location>
</error-page>
<!-- 2、通过异常的类型配置error-page。当系统发生java.lang.NullException（即空指针异常）时，跳转到错误处理页面。 -->
<error-page>
    <exception-type>java.lang.NullException</exception-type>
    <location>/error.jsp</location>
</error-page>

　　13、<jsp-config>设置jsp

　　<jsp-config> 包括 <taglib> 和 <jsp-property-group> 两个子元素。其中<taglib> 元素在JSP 1.2 时就已经存在；而<jsp-property-group> 是JSP 2.0 新增的元素。

　　<jsp-property-group> 元素主要有八个子元素，它们分别为：

• <description>：设定的说明 
• <display-name>：设定名称 
• <url-pattern>：设定值所影响的范围，如： /CH2 或 /*.jsp
• <el-ignored>：若为 true，表示不支持 EL 语法 
• <scripting-invalid>：若为 true，表示不支持 <% scripting %>语法 
• <page-encoding>：设定 JSP 网页的编码 
• <include-prelude>：设置 JSP 网页的抬头，扩展名为 .jspf
• <include-coda>：设置 JSP 网页的结尾，扩展名为 .jspf

<jsp-config>
    <taglib>
        <taglib-uri>Taglib</taglib-uri>
        <taglib-location>/WEB-INF/tlds/MyTaglib.tld</taglib-location>
    </taglib>
    <jsp-property-group>
        <description>Special property group for JSP Configuration JSP example.</description>
        <display-name>JSPConfiguration</display-name>
        <url-pattern>/jsp/* </url-pattern>
        <el-ignored>true</el-ignored>
        <page-encoding>GB2312</page-encoding>
        <scripting-invalid>true</scripting-invalid>
        <include-prelude>/include/prelude.jspf</include-prelude>
        <include-coda>/include/coda.jspf</include-coda>
    </jsp-property-group>
</jsp-config>

　　对于Web 应用程式来说，Scriptlet 是个不乐意被见到的东西，因为它会使得HTML 与Java 程式码交相混杂，对于程式的维护来说相当的麻烦，必要的时候，可以在web.xml 中加上<script-invalid> 标签，设定所有的JSP 网页都不可以使用Scriptlet。

----------------------------

转自：https://www.cnblogs.com/hellojava/archive/2012/12/28/2835730.html

2、web.xml文件元素详解

　　1、schema

　　web.xml的模式文件是由Sun公司定义的，每个web.xml文件的根元素<web-app>中，都必须标明这个 web.xml使用的是哪个模式文件。其它的元素都放在<web-app></web-app>之中。

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

　　2、<icon>Web应用图标

　　指出IDE和GUI工具用来表示Web应用的大图标和小图标。

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

　　3、<display-name>Web应用名称

　　提供GUI工具可能会用来标记这个特定的Web应用的一个名称

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

　　4、<disciption>Web应用描述

　　给出于此相关的说明性文本

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

　　5、<context-param>上下文参数

　　声明应用范围内的初始化参数。它用于向 ServletContext提供键值对，即应用程序上下文信息。我们的listener, filter等在初始化时会用到这些上下文中的信息。在servlet里面可以通过getServletContext().getInitParameter("context/param")得到。

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

　　6、<filter>过滤器

　　将一个名字与一个实现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>UTF-8</param-value>
    </init-param>
</filter>
<filter-mapping>
    <filter-name>setCharacterEncoding</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

　　7、<listener>监听器

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

　　8、<servlet>

　　<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

<!-- 基本配置 -->
<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>

　　9、<session-config>会话超时配置

　　单位为分钟。

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

　　10、<mime-mapping>

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

　　11、<welcome-file-list>欢迎文件页

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

　　12、<error-page>错误页面

<!-- 1、通过错误码来配置error-page。当系统发生×××错误时，跳转到错误处理页面。 -->
<error-page>
    <error-code>404</error-code>
    <location>/NotFound.jsp</location>
</error-page>
<!-- 2、通过异常的类型配置error-page。当系统发生java.lang.NullException（即空指针异常）时，跳转到错误处理页面。 -->
<error-page>
    <exception-type>java.lang.NullException</exception-type>
    <location>/error.jsp</location>
</error-page>

　　13、<jsp-config>设置jsp

　　<jsp-config> 包括 <taglib> 和 <jsp-property-group> 两个子元素。其中<taglib> 元素在JSP 1.2 时就已经存在；而<jsp-property-group> 是JSP 2.0 新增的元素。

　　<jsp-property-group> 元素主要有八个子元素，它们分别为：

• <description>：设定的说明 
• <display-name>：设定名称 
• <url-pattern>：设定值所影响的范围，如： /CH2 或 /*.jsp
• <el-ignored>：若为 true，表示不支持 EL 语法 
• <scripting-invalid>：若为 true，表示不支持 <% scripting %>语法 
• <page-encoding>：设定 JSP 网页的编码 
• <include-prelude>：设置 JSP 网页的抬头，扩展名为 .jspf
• <include-coda>：设置 JSP 网页的结尾，扩展名为 .jspf

<jsp-config>
    <taglib>
        <taglib-uri>Taglib</taglib-uri>
        <taglib-location>/WEB-INF/tlds/MyTaglib.tld</taglib-location>
    </taglib>
    <jsp-property-group>
        <description>Special property group for JSP Configuration JSP example.</description>
        <display-name>JSPConfiguration</display-name>
        <url-pattern>/jsp/* </url-pattern>
        <el-ignored>true</el-ignored>
        <page-encoding>GB2312</page-encoding>
        <scripting-invalid>true</scripting-invalid>
        <include-prelude>/include/prelude.jspf</include-prelude>
        <include-coda>/include/coda.jspf</include-coda>
    </jsp-property-group>
</jsp-config>

　　对于Web 应用程式来说，Scriptlet 是个不乐意被见到的东西，因为它会使得HTML 与Java 程式码交相混杂，对于程式的维护来说相当的麻烦，必要的时候，可以在web.xml 中加上<script-invalid> 标签，设定所有的JSP 网页都不可以使用Scriptlet。