关于web.xml配置的那些事儿

阅读量：7155 次

发布时间：2019-06-29

本文共 11789 字，大约阅读时间需要 39 分钟。

1.简介

web.xml文件是Java web项目中的一个配置文件，主要用于配置欢迎页、Filter、Listener、Servlet等，但并不是必须的，一个java web项目没有web.xml文件照样能跑起来。Tomcat容器/conf目录下也有作用于全局web应用web.xml文件，当一个web项目要启动时，Tomcat会首先加载项目中的web.xml文件，然后通过其中的配置来启动项目，只有配置的各项没有错误时，项目才能正常启动。

那么web.xml文件中到底有些什么内容呢？我们要如何去配置它以适应我们的项目呢？

首先让我们从Tomcat加载资源的顺序开始，一步步分析web.xml文件的作用。

2.Tomcat加载资源顺序

Tomcat启动时加载资源主要有三个阶段：

第一阶段：JVM相关资源

(1)$JAVA_HOME/jre/lib/ext/*.jar(2)系统classpath环境变量中的*.jar和*.class

第二阶段：Tomcat自身相关资源

(1)$CATALINA_HOME/common/classes/*.class  (2)$CATALINA_HOME/commons/endorsed/*.jar   (3)$CATALINA_HOME/commons/i18n/*.jar   (4)$CATALINA_HOME/common/lib/*.jar   (5)$CATALINA_HOME/server/classes/*.class   (6)$CATALINA_HOME/server/lib/*.jar   (7)$CATALINA_BASE/shared/classes/*.class   (8)$CATALINA_BASE/shared/lib/*.jar

第三阶段：Web应用相关资源

(1)具体应用的webapp目录: /WEB-INF/classes/*.class   (2)具体应用的webapp: /WEB-INF/lib/*.jar

在同一个文件夹下，jar包是按顺序从上到下依次加载,由ClassLoader的双亲委托模式加载机制我们可以知道，假设两个包名和类名完全相同的class文件不再同一个jar包，如果一个class文件已经被加载java虚拟机里了，那么后面的相同的class文件就不会被加载了。

但tomcat的加载运行机制与JAVA虚拟机的父类委托机制稍有不同。
下面来做详细叙述:
1、首先加载TOMCAT_HOME/lib目录下的jar包
2、然后加载TOMCAT_HOME/webapps/项目名/WEB-INF/lib的jar包
3、最后加载的是TOMCAT_HOME/webapps/项目名/WEB-INF/classes下的类文件
值得注意的关键是：tomcat按上述顺序依次加载资源，当后加载的资源与之前加载的资源相重时，后加载的资源会继续加载并将之前的资源覆盖。

Tomcat的具体内部细节及解读可以参考：

3.web.xml配置文件简介

servlet和JSP规范在发展阶段中出现了很多的web.xml配置版本，如3.0、3.1、4.0等，版本的变更会改变web.xml对应的配置代码。下图是来自Tomcat官网的Servlet和JSP规范规范与的Apache Tomcat版本之间的对应关系：

Servlet和JSP规范规范与的Apache Tomcat版本之间的对应关系

下面是各个版本的web.xml配置示例代码：

servlet 2.5 [Tomcat 6.0.x(archived)]

...

servlet 3.0 [Tomcat 7.0.x]

...

servlet 3.1 [Tomcat 8.0.x (superseded) & 8.5.x]

...

servlet 4.0 [Tomcat 9.0.x]

...

在tomcat目录${CATALINA_HOME}/conf下和web应用目录${CATALINA_HOME}/webapps/WebDemo(WebDemo为web应用名)下都有web.xml这个文件，但是内容不一样。

Tomcat在激活、加载、部署web应用时，会解析加载${CATALINA_HOME}/conf目录下所有web应用通用的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。

3.web.xml元素配置详解

web.xml文件加载顺序为：(与顺序无关)

ServletContext -> context-param -> listener -> filter -> servlet

web.xml中定义了以下元素：


         
     定义了WEB应用的名字     
      声明WEB应用的描述信息         
      context-param元素声明应用范围内的初始化参数。     
      过滤器元素将一个名字与一个实现javax.servlet.Filter接口的类相关联。     
      一旦命名了一个过滤器，就要利用filter-mapping元素把它与一个或多个servlet或JSP页面相关联。         
     servlet API的版本2.3增加了对事件监听程序的支持，事件监听程序在建立、修改和删除会话或servlet环境时得到通知。Listener元素指出事件监听程序类。         
      在向servlet或JSP页面制定初始化参数或定制URL时，必须首先命名servlet或JSP页面。Servlet元素就是用来完成此项任务的。         
      服务器一般为servlet提供一个缺省的URL：http://host/webAppPrefix/servlet/ServletName.        但是，常常会更改这个URL，以便servlet可以访问初始化参数或更容易地处理相对URL。在更改缺省URL时，使用servlet-mapping元素。         
      如果某个会话在一定时间内未被访问，服务器可以抛弃它以节省内存。 可通过使用HttpSession的setMaxInactiveInterval方法明确设置单个会话对象的超时值，或者可利用session-config元素制定缺省超时值。         
     如果Web应用具有想到特殊的文件，希望能保证给他们分配特定的MIME类型，则mime-mapping元素提供这种保证。         
      指示服务器在收到引用一个目录名而不是文件名的URL时，使用哪个文件。         
      在返回特定HTTP状态代码时，或者特定类型的异常被抛出时，能够制定将要显示的页面。         
      对标记库描述符文件（Tag Libraryu Descriptor file）指定别名。此功能使你能够更改TLD文件的位置，而不用编辑使用这些文件的JSP页面。         
     声明与资源相关的一个管理对象。     
      声明一个资源工厂使用的外部资源。     
      制定应该保护的URL。它与login-config元素联合使用     
      指定服务器应该怎样给试图访问受保护页面的用户授权。它与sercurity-constraint元素联合使用。         
     给出安全角色的一个列表，这些角色将出现在servlet元素内的security-role-ref元素的role-name子元素中。分别地声明角色可使高级IDE处理安全信息更为容易。         
     声明Web应用的环境项。     
     声明一个EJB的主目录的引用。     
     声明一个EJB的本地主目录的应用。

相应元素的配置：

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


           
       
        /images/app_small.gif
            
       
        /images/app_large.gif

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

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


      
       Tomcat Example servlets and JSP pages.

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


           
       
        ContextParameter     
        
         test
             
        
         It is a test parameter.

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

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


           
       
        setCharacterEncoding
            
       
        com.myTest.setCharacterEncodingFilter
            
                
        
         encoding
                 
        
         GB2312
             
        
       
           
       
        setCharacterEncoding
            
       
        /*

监听器配置


           
       
        listener.SessionListener

Servlet配置

基本配置


       
       
        snoop
        
       
        SnoopServlet
        
       
       
       
        snoop
        
       
        /snoop

高级配置


              
       
        snoop
               
       
        SnoopServlet
               
                   
        
         foo
                    
        
         bar
                
               
                   
        
         Security role for anonymous access
                    
        
         tomcat
                
           
          
              
       
        snoop
               
       
        /snoop

元素说明


       用来声明一个servlet的数据，主要有以下子元素： 
       指定servlet的名称 
       指定servlet的类名称 
       指定web站台中的某个JSP网页的完整路径 
       用来定义参数，可有多个init-param。在servlet类中通过getInitParamenter(String name)方法访问初始化参数 
      指定当Web应用启动时，装载Servlet的次序。 当值为正数或零时：Servlet容器先加载数值小的servlet，再依次加载其他数值大的servlet. 当值为负或未定义：Servlet容器将在Web客户首次访问这个servlet时加载它 
       用来定义servlet所对应的URL，包含两个子元素 
       指定servlet的名称 
       指定servlet所对应的URL

会话超时配置（单位为分钟）
```
       
       
        120
        
      
```

MIME类型配置

指定欢迎文件页配置


       
       
        index.jsp
        
       
        index.html
        
       
        index.htm

配置错误页面

方法1：通过错误码来配置error-page


       
       
        404
        
       
        /NotFound.jsp

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


       
       
        java.lang.NullException
        
       
        /error.jsp

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

TLD配置


       
       
        http://jakarta.apache.org/tomcat/debug-taglib
        
       
        /WEB-INF/jsp/debug-taglib.tld

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


       
            
        
         http://jakarta.apache.org/tomcat/debug-taglib
             
        
         /WEB-INF/pager-taglib.tld

资源管理对象配置


       
       
        jms/StockQueue

资源工厂配置


       
       
        mail/Session
        
       
        javax.mail.Session
        
       
        Container

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


       
       
        JNDI JDBC DataSource of shop
        
       
        jdbc/sample_db
        
       
        javax.sql.DataSource
        
       
        Container

安全限制配置


       
       
        Example Security Constraint
        
            
        
         Protected Area
             
        
         /jsp/security/protected/*
             
        
         DELETE
             
        
         GET
             
        
         POST
             
        
         PUT
         
        
            
        
         tomcat
             
        
         role1

登陆验证配置


       
       
        FORM
        
       
        Example-Based Authentiation Area
        
            
        
         /jsp/security/protected/login.jsp
             
        
         /jsp/security/protected/error.jsp

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

Web环境参数：env-entry元素声明Web应用的环境项


       
       
        minExemptions
        
       
        1
        
       
        java.lang.Integer

EJB 声明


       
       
        Example EJB reference 
        
         ejb/Account
         
        
         Entity
         
        
         com.mycompany.mypackage.AccountHome
         
        
         com.mycompany.mypackage.Account

本地EJB声明


       
       
        Example Loacal EJB reference 
        
         ejb/ProcessOrder
         
        
         Session
         
        
         com.mycompany.mypackage.ProcessOrderHome
         
        
         com.mycompany.mypackage.ProcessOrder

配置DWR


       
       
        dwr-invoker
        
       
        uk.ltd.getahead.dwr.DWRServlet
        
       
       
       
        dwr-invoker
        
       
        /dwr/*

4.spring项目中web.xml基础配置

配置基于servlet 3.1


    
        
     
      demo
         
     
      demo
             
         
             
      
       characterEncodingFilter
              
      
       org.springframework.web.filter.CharacterEncodingFilter
              
                  
       
        encoding
                   
       
        UTF-8
               
              
                  
       
        forceEncoding
                   
       
        true
               
          
         
             
      
       characterEncodingFilter
              
      
       /*
          
         
         
         
         
             
      
       org.springframework.web.context.ContextLoaderListener
          
         
         
         
             
      
       contextConfigLocation
              
      
       classpath:spring/applicationContext.xml
          
         
         
         
         
             
      
       default
              
      
       *.css
          
         
             
      
       default
              
      
       *.swf
          
         
             
      
       default
              
      
       *.gif
          
         
             
      
       default
              
      
       *.jpg
          
         
             
      
       default
              
      
       *.png
          
         
             
      
       default
              
      
       *.js
          
         
             
      
       default
              
      
       *.html
          
         
             
      
       default
              
      
       *.xml
          
         
             
      
       default
              
      
       *.json
          
         
             
      
       default
              
      
       *.map
          
         
         
         
             
      
       DispatcherServlet
              
              
      
       org.springframework.web.servlet.DispatcherServlet
              
              
                  
       
        contextConfigLocation
                   
                   
                   
                   
                   
                   
       
        classpath:spring/dispatcher-servlet.xml
               
              
      
       1
              
          
         
             
              
              
      
       DispatcherServlet
              
              
              
              
      
       /
              
          
         
             
              
      
       login.html
          
         
             
              
      
       404
              
      
       /nopage.html
          
         
             
              
      
       java.lang.NullPointerException
              
      
       /error.html
          
         
             
              
      
       360