Tomcat web.xml详解

Tomcat加载顺序

加载类和资源的顺序为：
1、/Web-INF/classes
2、/Web-INF/lib/*.jar
3、Bootstrap
4、System
5、$CATALINA_HOME/common/classes
6、$CATALINA_HOME/common/endores/*.jar
7、$CATALINA_HOME/common/lib/*.jar
8、$CATALINA_HOME/shared/classes
9、$CATALINA_HOME/shared/lib/*.jar

两个web配置文件

Servlet定义的时候，我发现在${catalina.home}/conf下以及${catalina.home}/webapps/ROOT/WEB_INF下都有web.xml这个文件。

web.xml的文件格式定义在Servlet规范中，因此所有符合Servlet规范的Java Servlet Container都会用到它。当tomcat部署应用程序时（在激活过程中，或加载应用程序后），它都会读取通用的conf/web.xml，然后再读取web应用程序中的WEB-INF/web.xml。其实根据他们的位置，我们就可以知道，conf/web.xml文件中的设定会应用于所有的web应用程序，而某些web应用程序的WEB-INF/web.xml中的设定只应用于该应用程序本身。

如果没有WEB-INF/web.xml文件，tomcat会输出找不到的消息，但仍然会部署并使用web应用程序，servlet规范的作者想要实现一种能迅速并简易设定新范围的方法，以用作测试，因此，这个web.xml并不是必要的，不过通常最好还是让每一个上线的web应用程序都有一个自己的WEB-INF/web.xml。

系统web.xml详解

 


<web-app>

<display-name>Sample Applicationdisplay-name>

<description>
This is a Sample Application
description>


<filter>
<filter-name>SampleFilterfilter-name>
<filter-class>mypack.SampleFilterfilter-class>
filter>


<filter-mapping>
<filter-name>SampleFilterfilter-name>
<url-pattern>*.jspurl-pattern>
filter-mapping>


<servlet>
<servlet-name>SampleServletservlet-name>
<servlet-class>mypack.SampleServletservlet-class>
<init-param>
<param-name>initParam1param-name>
<param-value>2param-value>
init-param>
<load-on-startup>1load-on-startup>
servlet>


<servlet-mapping>
<servlet-name>SampleServletservlet-name>
<url-pattern>/sampleurl-pattern>
servlet-mapping>


<session-config>
<session-timeout>30session-timeout>
session-config>


<welcome-file-list>
<welcome-file>login.jspwelcome-file>
<welcome-file>index.htmwelcome-file>
welcome-file-list>


<taglib>
<taglib-uri>/mytaglibtaglib-uri>
<taglib-location>/WEB-INF/mytaglib.tldtaglib-location>
taglib>


<resource-ref>
<description>DB Connectiondescription>
<res-ref-name>jdbc/sampleDBres-ref-name>
<res-type>javax.sql.DataSourceres-type>
<res-auth>Containerres-auth>
resource-ref>


<Security-constraint>
<web-resource-collection>
<web-resource-name>sample applictionweb-resource-name>
<url-pattern>/*url-pattern>
web-resource-collection>
<auth-constraint>
<role-name>guestrole-name>
auth-constraint>
Security-constraint>



<login-config>
<auth-method>FORMauth-method>
<realm-name>
Tomcat Server Configuration form-Based Authentication Area
realm-name>
<form-login-config>
<form-login-page>/login.jspform-login-page>
<form-error-page>/error.jspform-error-page>
form-login-config>
login-config>


<security-role>
<description>
The role that is required to log into the sample application
description>
<role-name>guestrole-name>
security-role>
web-app>

五、web.xml配置简介：
1、默认(欢迎)文件的设置
在tomcat4\conf\web.xml中，与IIS中的默认文件意思相同。

file-list>
   file>index.htmlfile>
   file>index.htmfile>
   file>index.jspfile>
file-list>

2、报错文件的设置

<error-page>
<error-code>404error-code>
<location>/notFileFound.jsplocation>
error-page>
<error-page>
<exception-type>java.lang.NullPointerExceptionexception-type>
<location>/null.jsplocation>
error-page>

如果某文件资源没有找到，服务器要报404错误，按上述配置则会调用\webapps\ROOT\notFileFound.jsp。
如果执行的某个JSP文件产生NullPointException ，则会调用\webapps\ROOT\null.jsp

3、会话超时的设置
设置session 的过期时间，单位是分钟；

<session-config>
<session-timeout>30session-timeout>
session-config>

4、过滤器的设置

<filter>
<filter-name>FilterSourcefilter-name>
<filter-class>project4. FilterSource filter-class>
filter>
<filter-mapping>
<filter-name>FilterSourcefilter-name>
<url-pattern>/WwwServleturl-pattern>
(<url-pattern>/haha/*url-pattern>)
filter-mapping>

过滤：
1) 身份验证的过滤Authentication Filters
2) 日志和审核的过滤Logging and Auditing Filters
3) 图片转化的过滤Image conversion Filters
4) 数据压缩的过滤Data compression Filters
5) 加密过滤Encryption Filters
6) Tokenizing Filters
7) 资源访问事件触发的过滤Filters that trigger resource access events XSL/T 过滤XSL/T filters
8) 内容类型的过滤Mime-type chain Filter 注意监听器的顺序，如：先安全过滤，然后资源，然后内容类型等，这个顺序可以自己定。（更加详细的解释，见参考文档）

参考文档

tomcat中加载顺序

首先可以肯定的是，加载顺序与它们在 web.xml 文件中的先后顺序无关。即不会因为 filter 写在 listener 的前面而会先加载 filter。最终得出的结论是：listener -> filter -> servlet

同时还存在着这样一种配置节：context-param，它用于向 ServletContext 提供键值对，即应用程序上下文信息。我们的 listener, filter 等在初始化时会用到这些上下文中的信息，那么 context-param 配置节是不是应该写在 listener 配置节前呢？实际上 context-param 配置节可写在任意位置，因此真正的加载顺序为：context-param -> listener -> filter -> servlet

对于某类配置节而言，与它们出现的顺序是有关的。以 filter 为例，web.xml 中当然可以定义多个 filter，与 filter 相关的一个配置节是 filter-mapping，这里一定要注意，对于拥有相同 filter-name 的 filter 和 filter-mapping 配置节而言，filter-mapping 必须出现在 filter 之后，否则当解析到 filter-mapping 时，它所对应的 filter-name 还未定义。web 容器启动时初始化每个 filter 时，是按照 filter 配置节出现的顺序来初始化的，当请求资源匹配多个 filter-mapping 时，filter 拦截资源是按照 filter-mapping 配置节出现的顺序来依次调用 doFilter() 方法的。

servlet 同 filter 类似 ，此处不再赘述。

由此，可以看出，web.xml 的加载顺序是：context-param -> listener -> filter -> servlet ，而同个类型之间的实际程序调用的时候的顺序是根据对应的 mapping 的顺序进行调用的。

web.xml文件详解

Web.xml常用元素

<web-app>    
<display-name></display-name>定义了WEB应用的名字    

<description></description> 声明WEB应用的描述信息    

<context-param></context-param> context-param元素声明应用范围内的初始化参数。    

<filter></filter> 过滤器元素将一个名字与一个实现javax.servlet.Filter接口的类相关联。    
<filter-mapping></filter-mapping> 一旦命名了一个过滤器，就要利用filter-mapping元素把它与一个或多个servlet或JSP页面相关联。 

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

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

<servlet-mapping></servlet-mapping> 服务器一般为servlet提供一个缺省的URL：http://host/webAppPrefix/servlet/ServletName。    

但是，常常会更改这个URL，以便servlet可以访问初始化参数或更容易地处理相对URL。在更改缺省URL时，使用servlet-mapping元素。    

<session-config></session-config> 如果某个会话在一定时间内未被访问，服务器可以抛弃它以节省内存。    

可通过使用HttpSession的setMaxInactiveInterval方法明确设置单个会话对象的超时值，或者可利用session-config元素制定缺省超时值。    

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

<welcome-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的本地主目录的应用。   

</web-app>    

相应元素配置

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

<icon>    
<small-icon>/images/app_small.gifsmall-icon>    
<large-icon>/images/app_large.giflarge-icon>    
icon>

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

<display-name>Tomcat Exampledisplay-name>

3、Web 应用描述： 给出于此相关的说明性文本

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

4、上下文参数：声明应用范围内的初始化参数。

<context-param>    
    <param-name>ContextParameterpara-name>    
    <param-value>testparam-value>    
    <description>It is a test parameter.description>    
context-param>    

在servlet里面可以通过getServletContext().getInitParameter(“context/param”)得到

5、过滤器配置：将一个名字与一个实现javaxs.servlet.Filter接口的类相关联。

<filter>    
        <filter-name>setCharacterEncodingfilter-name>    
        <filter-class>com.myTest.setCharacterEncodingFilterfilter-class>    
        <init-param>    
            <param-name>encodingparam-name>    
            <param-value>GB2312param-value>    
        init-param>    
filter>    
<filter-mapping>    
        <filter-name>setCharacterEncodingfilter-name>    
        <url-pattern>/*url-pattern>    
filter-mapping>    

6、监听器配置

<listener>    
      <listerner-class>listener.SessionListenerlistener-class>    
listener>    

7、Servlet配置
基本配置

   <servlet>    
      <servlet-name>snoopservlet-name>    
      <servlet-class>SnoopServletservlet-class>    
   servlet>    
   <servlet-mapping>    
      <servlet-name>snoopservlet-name>    
      <url-pattern>/snoopurl-pattern>    
   servlet-mapping>    

高级配置

   <servlet>    
      <servlet-name>snoopservlet-name>    
      <servlet-class>SnoopServletservlet-class>    
      <init-param>    
         <param-name>fooparam-name>    
         <param-value>barparam-value>    
      init-param>    
      <run-as>    
         <description>Security role for anonymous accessdescription>    
         <role-name>tomcatrole-name>    
      run-as>    
   servlet>    
   <servlet-mapping>    
      <servlet-name>snoopservlet-name>    
      <url-pattern>/snoopurl-pattern>    
   servlet-mapping>    

元素说明

     <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

8、会话超时配置（单位为分钟）

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

9、MIME类型配置

   <mime-mapping>    
      <extension>htmextension>    
      <mime-type>text/htmlmime-type>    
   mime-mapping>

10、指定欢迎文件页配置

   file-list>    
      file>index.jspfile>    
      file>index.htmlfile>    
      file>index.htmfile>    
   file-list>  

11、配置错误页面
一、 通过错误码来配置error-page

   <error-page>    
      <error-code>404error-code>    
      <location>/NotFound.jsplocation>    
   error-page>  

上面配置了当系统发生404错误时，跳转到错误处理页面NotFound.jsp。
二、通过异常的类型配置error-page

   <error-page>    
       <exception-type>java.lang.NullExceptionexception-type>    
       <location>/error.jsplocation>    
   error-page> 

上面配置了当系统发生java.lang.NullException（即空指针异常）时，跳转到错误处理页面error.jsp
12、TLD配置

   <taglib>    
       <taglib-uri>http://jakarta.apache.org/tomcat/debug-taglibtaglib-uri>    
       <taglib-location>/WEB-INF/jsp/debug-taglib.tldtaglib-location>    
   taglib> 

如果MyEclipse一直在报错,应该把 放到 中

   <jsp-config>    
      <taglib>    
          <taglib-uri>http://jakarta.apache.org/tomcat/debug-taglibtaglib-uri>    
          <taglib-location>/WEB-INF/pager-taglib.tldtaglib-location>    
      taglib>    
   jsp-config>    

13、资源管理对象配置

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

14、资源工厂配置

   <resource-ref>    
       <res-ref-name>mail/Session</res-ref-name>    
       <res-type>javax.mail.Session</res-type>    
       <res-auth>Container</res-auth>    
   </resource-ref> 

配置数据库连接池就可在此配置：

   <resource-ref>    
       <description>JNDI JDBC DataSource of shopdescription>    
       <res-ref-name>jdbc/sample_dbres-ref-name>    
       <res-type>javax.sql.DataSourceres-type>    
       <res-auth>Containerres-auth>    
   resource-ref>    

15、安全限制配置

   <security-constraint>    
      <display-name>Example Security Constraintdisplay-name>    
      <web-resource-collection>    
         <web-resource-name>Protected Areaweb-resource-name>    
         <url-pattern>/jsp/security/protected/*url-pattern>    
         <http-method>DELETEhttp-method>    
         <http-method>GEThttp-method>    
         <http-method>POSThttp-method>    
         <http-method>PUThttp-method>    
      web-resource-collection>    
      <auth-constraint>    
        <role-name>tomcatrole-name>    
        <role-name>role1role-name>    
      auth-constraint>    
   security-constraint> 

16、登陆验证配置

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

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

<security-role>    
     <role-name>tomcatrole-name>    
security-role> 

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

19、EJB 声明

<ejb-ref>    
     <description>Example EJB referencedecription>    
     <ejb-ref-name>ejb/Accountejb-ref-name>    
     <ejb-ref-type>Entityejb-ref-type>    
     <home>com.mycompany.mypackage.AccountHomehome>    
     <remote>com.mycompany.mypackage.Accountremote>    
ejb-ref> 

20、本地EJB声明

<ejb-local-ref>    
     <description>Example Loacal EJB reference</decription>    
     <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>  

21、配置DWR

<servlet>    
      <servlet-name>dwr-invokerservlet-name>    
      <servlet-class>uk.ltd.getahead.dwr.DWRServletservlet-class>    
servlet>    
<servlet-mapping>    
      <servlet-name>dwr-invokerservlet-name>    
      <url-pattern>/dwr/*url-pattern>    
servlet-mapping> 

22、配置Struts

    <display-name>Struts Blank Application</display-name>    
    <servlet>    
        <servlet-name>action</servlet-name>    
        <servlet-class>    
            org.apache.struts.action.ActionServlet    
        </servlet-class>    
        <init-param>    
            <param-name>detail</param-name>    
            <param-value>2</param-value>    
        </init-param>    
        <init-param>    
            <param-name>debug</param-name>    
            <param-value>2</param-value>    
        </init-param>    
        <init-param>    
            <param-name>config</param-name>    
            <param-value>/WEB-INF/struts-config.xml</param-value>    
        </init-param>    
        <init-param>    
            <param-name>application</param-name>    
            <param-value>ApplicationResources</param-value>    
        </init-param>    
        <load-on-startup>2</load-on-startup>    
    </servlet>    
    <servlet-mapping>    
        <servlet-name>action</servlet-name>    
        <url-pattern>*.do</url-pattern>    
    </servlet-mapping>    
    <welcome-file-list>    
        <welcome-file>index.jsp</welcome-file>    
    </welcome-file-list>    

        
    <taglib>    
        <taglib-uri>struts-bean</taglib-uri>    
        <taglib-location>/WEB-INF/tld/struts-bean.tld</taglib-location>    
    </taglib>    
    <taglib>    
        <taglib-uri>struts-html</taglib-uri>    
        <taglib-location>/WEB-INF/tld/struts-html.tld</taglib-location>    
    </taglib>    
    <taglib>    
    <taglib-uri>struts-nested</taglib-uri>    
    <taglib-location>/WEB-INF/tld/struts-nested.tld</taglib-location>    
    </taglib>    
    <taglib>    
        <taglib-uri>struts-logic</taglib-uri>    
        <taglib-location>/WEB-INF/tld/struts-logic.tld</taglib-location>    
    </taglib>    
    <taglib>    
        <taglib-uri>struts-tiles</taglib-uri>    
        <taglib-location>/WEB-INF/tld/struts-tiles.tld</taglib-location>    
    </taglib>  

23、配置Spring（基本上都是在Struts中配置的）

       
   <context-param>    
      <param-name>contextConfigLocationparam-name>    
      <param-value>    
           
        /WEB-INF/applicationContext.xml, /WEB-INF/action-servlet.xml    
      param-value>    
   context-param>    

       

<listener>    
     <listener-class>org.springframework.web.context.ContextLoaderListenerlistener-class>    
listener>    

<listener>    
     <listener-class>    
       org.springframework.web.context.request.RequestContextListener    
     listener-class>    
listener>