web.xml文件详解

前言:一般的web工程中都会用到web.xml,web.xml主要用来配置,可以方便的开发web工程。web.xml主要用来配置Filter、Listener、Servlet等。但是要说明的是web.xml并不是必须的,一个web工程可以没有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。

3、Mapping规则

当一个请求发送到servlet容器的时候,容器先会将请求的url减去当前应用上下文的路径作为servlet的映射url,比如我访问的是http://localhost/test/aaa.html,我的应用上下文是test,容器会将http://localhost/test去掉,剩下的/aaa.html部分拿来做servlet的映射匹配。这个映射匹配过程是有顺序的,而且当有一个servlet匹配成功以后,就不会去理会剩下的servlet了。

其匹配规则和顺序如下:

  1. 精确路径匹配。例子:比如servletA 的url-pattern为 /test,servletB的url-pattern为 /* ,这个时候,如果我访问的url为http://localhost/test ,这个时候容器就会先 进行精确路径匹配,发现/test正好被servletA精确匹配,那么就去调用servletA,也不会去理会其他的servlet了。
  2. 最长路径匹配。例子:servletA的url-pattern为/test/*,而servletB的url-pattern为/test/a/*,此时访问http://localhost/test/a时,容器会选择路径最长的servlet来匹配,也就是这里的servletB。
  3. 扩展匹配,如果url最后一段包含扩展,容器将会根据扩展选择合适的servlet。例子:servletA的url-pattern:*.action

以”/’开头和以”/*”结尾的是用来做路径映射的。以前缀”*.”开头的是用来做扩展映射的。所以,为什么定义”/*.action”这样一个看起来很正常的匹配会错?因为这个匹配即属于路径映射,也属于扩展映射,导致容器无法判断。

 

 

在java工程中,web.xml用来初始化工程配置信息,比如说welcome页面,filter,listener,servlet,servlet-mapping,启动加载级别等等。

每一个xml文件都有定义他书写规范的schema文件,web.xml所对应的xml Schema文件中定义了多少种标签元素,web.xml中就可以出现它所定义的标签元素,也就具备哪些特定的功能。web.xml的模式文件是由Sun 公司定义的,每个web.xml文件的根元素为<web-app>中,必须标明这个web.xml使用的是哪个模式文件。

web.xml的根元素定义如下所示:

  1. <?xml version=“1.0” encoding=“UTF-8”?>
  2. <web-app version=“2.5”
  3. xmlns=“http://java.sun.com/xml/ns/javaee”
  4. xmlns:xsi=“http://www.w3.org/2001/XMLSchema-instance”
  5. xsi:schemaLocation=”http://java.sun.com/xml/ns/javaee
  6. http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd”>
  7. </web-app>

下面就来介绍一下web.xml中常用的标签及其功能

1.<description>,<display-name>,<icon>

<description>项目描述</discription>  对项目做出描述.

<display-name>项目名称</display-name> 定义项目的名称.

<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.

例如:

  1. <display-name>Develop Example</display-name>
  2. <description>JSP 2.0 Tech Book’s Examples</description>
  3.  <icon>
  4.    <small-icon>/images/small.gif</small-icon>
  5.    <large-icon>/images/large.gir</large-icon>
  6.  </icon>

2.<context-param>

    <context-param>元素含有一对参数名和参数值,用作应用的servlet上下文初始化参数。参数名在整个Web应用中必须是惟一的。
context-param 元素用来设定web应用的环境参数(context),它包含两个子元素: param-name和param-value.
<param-name>参数名称</param-name> 设定Context名称
<param-value>值</param-value> 设定Context名称的值 </context-param>
例如:
  1. <context-param>
  2.    <param-name>param_name</param-name>
  3.    <param-value>param_value</param-value>
  4. </context-param>

此所设定的参数,在JSP网页中可以使用下列方法来取得:${initParam.param_name}
若在Servlet可以使用下列方法来获得:
String param_name=getServletContext().getInitParamter(“param_name”);

3.<filter>

filter元素用于指定Web容器中的过滤器。

在请求和响应对象被servlet处理之前或之后,可以使用过滤器对这两个对象进行操作。

利用下一节介绍 的filter-mapping元素,过滤器被映射到一个servlet或一个URL模式。

这个过滤器的filter元素和filter-mapping 元素必须具有相同的名称。

filter元素用来声明filter的相关设定.filter元素除了下面介绍的的子元素之外,还包括之前介绍过的<icon>,<display-name>,<description>,<init-param>,其用途一样.

    下面介绍filter-name,filter-class和init-param元素
init-param元素与context-param 元素具有相同的元素描述符。
        filter-name元素用来定义过滤器的名称,该名称在整个应用中都必须是惟一的。
        filter-class元素指定过滤 器类的完全限定的名称。

<filter-name>Filter的名称</filter-name> 定义Filter的名称.
<filter-class>Filter的类名称</filter-class> 定义Filter的类名称.例如:com.foo.hello

    例如:
  1. <filter>
  2.   <filter-name>setCharacterEncoding</filter-name>
  3.   <filter-class>coreservlet.javaworld.CH11.SetCharacterEncodingFilter</filter-class>
  4.   <init-param>
  5.      <param-name>encoding</param-name>
  6.      <param-value>GB2312</param-value>
  7.   </init-param>
  8. </filter>

4.<filter-mapping>

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

filter-mapping 元素的两个主要子元素filter-name和url-pattern.用来定义Filter所对应的URL。还有servlet-name和dispatcher子元素,不是很常用。

<filter-name>Filter的名称</filter-name>  定义Filter的名称.

<url-pattern>URL</url-pattern> Filter所对应的RUL.例如:<url-pattern>/Filter/Hello</url-pattern>
<servlet-name>Servlet的名称<servlet-name> 定义servlet的名称.
<dispatcher>REQUEST|INCLUDE|FORWARD|ERROR</disaptcher> 设定Filter对应的请求方式,有RQUEST,INCLUDE,FORWAR,ERROR四种,默认为REQUEST.

例如:

  1. <filter-mapping>
  2.    <filter-name>GZIPEncoding</filter-name>
  3.    <url-pattern>/*</url-pattern>
  4. </filter-mapping>

完整的filter配置例子如下:

  1. <filter>
  2.     <filter-name>struts2</filter-name>
  3.     <filter-class>org.apache.struts2.dispatcher.ng.filter.StrutsPrepareAndExecuteFilter</filter-class>
  4. </filter>
  5. <filter-mapping>
  6.     <filter-name>struts2</filter-name>
  7.     <url-pattern>/*</url-pattern>
  8. </filter-mapping>

5.<servlet>

在web.xml中完成的一个最常见的任务是对servlet或JSP页面给出名称和定制的URL。用servlet元素分配名称,使用servlet-mapping元素将定制的URL与刚分配的名称相关联。

例如:
  1. <servlet>
  2.   <servlet-name>Test</servlet-name>
  3.   <servlet-class>com.moreservlets.TestServlet</servlet-class>
  4. </servlet>

这表示位于WEB-INF/classes/com/moreservlets/TestServlet的servlet已经得到了注册名Test。

6.<servlet-mapping>

    servlet-mapping元素包含两个子元素servlet-name和url-pattern.用来定义servlet所对应URL.

<servlet-name>Servlet的名称</servlet-name> 定义Servlet的名称.
<url-pattern>Servlet URL</url-pattern> 定义Servlet所对应的RUL.例如:<url-pattern>/Servlet/Hello</url-pattern>

例如:
  1. <servlet-mapping>
  2.    <servlet-name>LoginChecker</servlet-name>
  3.    <url-pattern>/LoginChecker</url-pattern>
  4. </servlet-mapping>

完整的servlet配置如下所示:

  1. <servlet>
  2.   <servlet-name>ServletName</servlet-name>
  3.   <servlet-class>xxxpackage.xxxServlet</servlet-class>   <!–Servlet的类–>
  4.   <init-param>                                     <!–初始化一个变量,可看成全局变量,可省略–>
  5.     <param-name>参数名称</param-name>              <!–变量名称–>
  6.     <param-value>参数值</param-value>              <!–变量值–>
  7.   </init-param>
  8. </servlet>
  9. <servlet-mapping>
  10.   <servlet-name>ServletName</servlet-name>
  11.   <url-pattern>/aaa/xxx</url-pattern>                   <!–映射的url路径 –>
  12. </servlet-mapping>

在地址栏中输入http://localhost:8080/web-App/aaa/xxx就可以访问了。

7.<listener>

    listener元素用来注册一个监听器类,可以在Web应用中包含该类。使用listener元素,可以收到事件什么时候发生以及用什么作为响应的通知。
    listener元素用来定义Listener接口,它的主要子元素为<listener-class>
<listen-class>Listener的类名称</listener-class> 定义Listener的类名称.例如: com.foo.hello
例如:
  1. <listener>
  2.     <listener-class><span style=“font-family: FangSong_GB2312;font-size:18px; white-space: pre;”>com.foo.hello</span></listener-class>
  3. </listener>

8.<session-cofing>

    session-config包含一个子元素session-timeout.定义web应用中的session参数.
<session-timeout>分钟</session-timeout> 定义这个web应用所有session的有效期限.单位为分钟.
    例如:
  1. <session-config>
  2.    <session-timeout>20</session-timeout>
  3. </session-config>

9.<mime-mapping>

    mime-mapping包含两个子元素extension和mime-type.定义某一个扩展名和某一MIME Type做对映.
        <extension>扩展名名称</extension> 扩展名称
<mime-type>MIME格式</mime-type> MIME格式.
    例如:
  1. <mime-mapping>
  2.    <extension>doc</extension>
  3.    <mime-type>application/vnd.ms-word</mime-type>
  4. </mime-mapping>
  5. <mime-mapping>
  6.    <extension>xls</extension>
  7.    <mime-type>application/vnd.ms-excel</mime-type>
  8. </mime-mapping>
  9. <mime-mapping>
  10.    <extension>ppt</extesnion>
  11.    <mime-type>application/vnd.ms-powerpoint</mime-type>
  12. </mime-mapping>

10.<welcome-file-list>

    welcome-file-list包含一个子元素welcome-file.用来定义首页列单.
<welcome-file>用来指定首页文件名称</welcome-flie>
welcome-file用来指定首页文件名称.我们可以用<welcome-file>指定几个首页,而服务器会依照设定的顺序来找首页.
    例如:
  1. <welcome-file-list>
  2.     <welcome-file>index.jsp</welcome-file>
  3.     <welcome-file>index.htm</welcome-file>
  4. </welcome-file-list>

11.<error-page>

    error-page元素包含三个子元素error-code,exception-type和location.
    将错误代码(Error Code)或异常(Exception)的种类对应到web应用资源路径.
        <error-code>错误代码</error-code> HTTP Error code,例如: 404
<exception-type>Exception</exception-type> 一个完整名称的Java异常类型
<location>/路径</location>  在web应用内的相关资源路径
    例如:
  1. <error-page>
  2.    <error-code>404</error-code>
  3.    <location>/error404.jsp</location>
  4. </error-page>
  5. <error-page>
  6.    <exception-type>java.lang.Exception</exception-type>
  7.    <location>/except.jsp</location>
  8. </error-page>

12.<jsp-config>

    jsp-config元素主要用来设定JSP的相关配置,<jsp:config>包括<taglib>和<jsp-property-group>两个子元素.其中<taglib>元素在JSP 1.2时就已经存在了;而<jsp-property-group>是JSP 2.0新增的元素.
    <taglib>
taglib元素包含两个子元素taglib-uri和taglib-location.用来设定JSP网页用到的Tag Library路径.
<taglib-uri>URI</taglib-uri> taglib-uri定义TLD文件的URI,JSP网页的taglib指令可以经由这个URI存取到TLD文件.
<taglib-location>/WEB-INF/lib/xxx.tld</taglib-laction> TLD文件对应Web应用的存放位置.

    <jsp-property-group>
jsp-property-group元素包含8个元素,分别为:
<description>Description</descrition>    此设定的说明
<display-name>Name</display-name>        此设定的名称
<url-pattern>URL</url-pattern>           设定值所影响的范围,如:/CH2 或者/*.jsp
<el-ignored>true|false</el-ignored>      若为true,表示不支持EL语法.
<scripting-invalid>true|false</scripting-invalid>    若为true表示不支持<%scription%>语法.
<page-encoding>encoding</page-encoding>  设定JSP网页的编码
<include-prelude>.jspf</include-prelude> 设置JSP网页的抬头,扩展名为.jspf
<include-coda>.jspf</include-coda>       设置JSP网页的结尾,扩展名为.jspf
    例如:
  1. <jsp-config>
  2.     <taglib>
  3.         <taglib-uri>Taglib</taglib-uri>
  4.         <taglib-location>/WEB-INF/tlds/MyTaglib.tld</taglib-location>
  5.     </taglib>
  6.     <jsp-property-group>
  7.         <description>
  8.           Special property group for JSP Configuration JSP example.
  9.         </description>
  10.         <display-name>JSPConfiguration</display-name>
  11.         <uri-pattern>/*</uri-pattern>
  12.         <el-ignored>true</el-ignored>
  13.         <page-encoding>GB2312</page-encoding>
  14.         <scripting-inivalid>true</scripting-inivalid>
  15.    …………
  16.     </jsp-property-group>
  17. </jsp-config>

12.<resource-ref>

resource-ref元素包括五个子元素description,res-ref-name,res-type,res-auth,res-sharing-scope.利用JNDI取得应用可利用资源.
    <description>说明</description> 资源说明
<rec-ref-name>资源名称</rec-ref-name> 资源名称
<res-type>资源种类</res-type> 资源种类
<res-auth>Application|Container</res-auth> 资源由Application或Container来许可
<res-sharing-scope>Shareable|Unshareable</res-sharing-scope> 资源是否可以共享.默认值为 Shareable
例如:
  1. <resource-ref>
  2.    <description>JNDI JDBC DataSource of JSPBook</description>
  3.    <res-ref-name>jdbc/sample_db</res-ref-name>
  4.    <res-type>javax.sql.DataSoruce</res-type>
  5.    <res-auth>Container</res-auth>
  6. </resource-ref>

thedarkside

这是一个最好的时代,这是一个最坏的时代。

stay connected

228,480

Fans

21,563

Followers

20,563

Followers

8,125

Subscribers

2,253

Subscribers

10,563

Followers

最新文章

entertainment
Buckingham Palace soil used in Tate exhibit
Oct 13, 2016
Sports
Legendary coach Steve Spurrier was truly
Oct 13, 2016
Technology
Acer reveals all-in-one Windows 10 PC
Oct 13, 2016
entertainment
Revival allows Selena Gomez to shed
Oct 13, 2016
entertainment
Buckingham Palace soil used in Tate exhibit
Oct 13, 2016
Sports
Legendary coach Steve Spurrier was truly
Oct 13, 2016
Technology
Acer reveals all-in-one Windows 10 PC
Oct 13, 2016
entertainment
Revival allows Selena Gomez to shed
Oct 13, 2016