关于web.xml配置的那些事儿
本文转载自：关于web.xml配置的那些事儿 - 个人文章 - SegmentFault 思否
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的具体内部细节及解读可以参考：
Apache Tomcat 9 (9.0.0.M26) - Documentation
3.web.xml配置文件简介
servlet和JSP规范在发展阶段中出现了很多的web.xml配置版本，如3.0、3.1、4.0等，版本的变更会改变web.xml对应的配置代码。下图是来自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.
上下文参数：声明应用范围内的初始化参数。
ContextParametertestIt is a test parameter.
在servlet里面可以通过getServletContext().getInitParameter("context/param")得到。
过滤器配置：将一个名字与一个实现javaxs.servlet.Filter接口的类相关联。
setCharacterEncodingcom.myTest.setCharacterEncodingFilterencodingGB2312setCharacterEncoding/*
监听器配置
listener.SessionListener
Servlet配置
基本配置
snoopSnoopServletsnoop/snoop
高级配置
snoopSnoopServletfoobarSecurity role for anonymous accesstomcatsnoop/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类型配置
htmtext/html
指定欢迎文件页配置
index.jspindex.htmlindex.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/Sessionjavax.mail.SessionContainer
配置数据库连接池就可在此配置：
JNDI JDBC DataSource of shopjdbc/sample_dbjavax.sql.DataSourceContainer
安全限制配置
Example Security ConstraintProtected Area/jsp/security/protected/*DELETEGETPOSTPUTtomcatrole1
登陆验证配置
FORMExample-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应用的环境项
minExemptions1java.lang.Integer
EJB 声明
Example EJB referenceejb/AccountEntitycom.mycompany.mypackage.AccountHomecom.mycompany.mypackage.Account
本地EJB声明
Example Loacal EJB referenceejb/ProcessOrderSessioncom.mycompany.mypackage.ProcessOrderHomecom.mycompany.mypackage.ProcessOrder
配置DWR
dwr-invokeruk.ltd.getahead.dwr.DWRServletdwr-invoker/dwr/*
4.spring项目中web.xml基础配置
配置基于servlet 3.1
demodemo
下面我们来看看Spring框架给我们提供过滤器CharacterEncodingFilter
这个过滤器就是针对于每次浏览器请求进行过滤的，然后再其之上添加了父类没有的功能即处理字符编码。
其中encoding用来设置编码格式，forceEncoding用来设置是否理会 request.getCharacterEncoding()方法，设置为true则强制覆盖之前的编码格式。-->characterEncodingFilterorg.springframework.web.filter.CharacterEncodingFilterencodingUTF-8forceEncodingtruecharacterEncodingFilter/*
在ContextLoaderListener中关联了ContextLoader这个类，所以整个加载配置过程由ContextLoader来完成。
它的API说明
第一段说明ContextLoader可以由 ContextLoaderListener和ContextLoaderServlet生成。
如果查看ContextLoaderServlet的API，可以看到它也关联了ContextLoader这个类而且它实现了HttpServlet 这个接口
第二段，ContextLoader创建的是 XmlWebApplicationContext这样一个类，它实现的接口是WebApplicationContext->ConfigurableWebApplicationContext->ApplicationContext->
BeanFactory这样一来spring中的所有bean都由这个类来创建
IUploaddatafileManager uploadmanager = (IUploaddatafileManager)
ContextLoaderListener.getCurrentWebApplicationContext().getBean("uploadManager");-->org.springframework.web.context.ContextLoaderListener
在WEB-INF目录下创建的xml文件的名称必须是applicationContext.xml。
如果是要自定义文件名可以在web.xml里加入contextConfigLocation这个context参数：
在 里指定相应的xml文件名，如果有多个xml文件，可以写在一起并以“,”号分隔。
也可以这样applicationContext-*.xml采用通配符，比如这那个目录下有applicationContext-ibatis-base.xml，
applicationContext-action.xml，applicationContext-ibatis-dao.xml等文件，都会一同被载入。
在ContextLoaderListener中关联了ContextLoader这个类，所以整个加载配置过程由ContextLoader来完成。-->contextConfigLocationclasspath:spring/applicationContext.xmldefault*.cssdefault*.swfdefault*.gifdefault*.jpgdefault*.pngdefault*.jsdefault*.htmldefault*.xmldefault*.jsondefault*.mapDispatcherServletorg.springframework.web.servlet.DispatcherServletcontextConfigLocation**.xml 这里可以使用多种写法-->-servlet.xml-->/WEB-INF/classes/dispatcher-servlet.xml-->classpath*:dispatcher-servlet.xml-->classpath:spring/dispatcher-servlet.xml1DispatcherServlet/login.html404/nopage.htmljava.lang.NullPointerException/error.html360
5.流行的web.xml零配置
servlet3.0+规范后，允许servlet，filter，listener不必声明在web.xml中，而是以硬编码的方式存在，实现容器的零配置。
spring框架提供了一些类如WebApplicationInitializer用来配置web.xml，这意味着我们可以舍弃web.xml，仅仅在主程序代码中进行配置。
spring的“约定大于配置”思想也体现在这里，用java注解来优化过去繁杂的xml文件配置，大大提高了开发者的编程速度和体验。
现在很流行的spring boot框架，只要几步就可以搭建一个java web项目，根本无需自己手动配置web.xml，框架已经为你提供了足够多的注解、接口及实现类，让我们能够专注于应用本身。
有关spring对web.xml配置的隐藏实现细节，这里就不详细展开了，欢迎关注我的下一篇博客。
6.参考资料
Apache Tomcat 9 (9.0.0.M26) - Documentation
