关于web.xml配置的那些事儿 1.简介 2.Tomcat加载资源顺序 3.web.xml配置文件简介 3.web.xml元素配置详解 4.spring项目中web.xml基础配置
/conf目录下也有作用于全局web应用web.xml文件,当一个web项目要启动时,Tomcat会首先加载项目中的web.xml文件,然后通过其中的配置来启动项目,只有配置的各项没有错误时,项目才能正常启动。
首先让我们从Tomcat加载资源的顺序开始,一步步分析web.xml文件的作用。
2.Tomcat加载资源顺序
Tomcat启动时加载资源主要有三个阶段:
-
第一阶段:JVM相关资源
jar (class
-
第二阶段:Tomcat自身相关资源
class (2)$CATALINA_HOME/commons/endorsed/*.jar (3)$CATALINA_HOME/commons/i18n/*.jar (jar (class (jar (class (jar
-
第三阶段:Web应用相关资源
/*.class (2)具体应用的webapp: /WEB-INF/jar
在同一个文件夹下,jar包是按顺序从上到下依次加载,由ClassLoader的双亲委托模式加载机制我们可以知道,假设两个包名和类名完全相同的class文件不再同一个jar包,如果一个class文件已经被加载java虚拟机里了,那么后面的相同的class文件就不会被加载了。
值得注意的关键是:tomcat按上述顺序依次加载资源,当后加载的资源与之前加载的资源相重时,后加载的资源会继续加载并将之前的资源覆盖。
Tomcat的具体内部细节及解读可以参考:
- Apache Tomcat 9 (9.0.0.M26) - Documentation
- 极客学院wiki - 《Tomcat 8 权威指南》
- 《深入剖析Tomcat》
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)]
?>
web-app>
servlet 3.0 [Tomcat 7.0.x]
?>
web-app>
servlet 3.1 [Tomcat 8.0.x (superseded) & 8.5.x]
?>
web-app>
servlet 4.0 [Tomcat 9.0.x]
web-app>
${CATALINA_HOME}/webapps/WebDemo(WebDemo为web应用名)下都有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元素配置详解
ServletContext -> context-param -> listener -> filter -> servlet
web.xml中定义了以下元素:
web-app>
display-name>定义了WEB应用的名字
description> 声明WEB应用的描述信息
context-param> context-param元素声明应用范围内的初始化参数。
filter> 过滤器元素将一个名字与一个实现javax.servlet.Filter接口的类相关联。
filter-mapping> 一旦命名了一个过滤器,就要利用filter-mapping元素把它与一个或多个servlet或JSP页面相关联。
listener>servlet API的版本2.3增加了对事件监听程序的支持,事件监听程序在建立、修改和删除会话或servlet环境时得到通知。Listener元素指出事件监听程序类。
servlet> 在向servlet或JSP页面制定初始化参数或定制URL时,必须首先命名servlet或JSP页面。Servlet元素就是用来完成此项任务的。
servlet-mapping> 服务器一般为servlet提供一个缺省的URL:http://host/webAppPrefix/servlet/ServletName.
但是,常常会更改这个URL,以便servlet可以访问初始化参数或更容易地处理相对URL。在更改缺省URL时,使用servlet-mapping元素。
session-config> 如果某个会话在一定时间内未被访问,服务器可以抛弃它以节省内存。 可通过使用HttpSession的setMaxInactiveInterval方法明确设置单个会话对象的超时值,或者可利用session-config元素制定缺省超时值。
mime-mapping>如果Web应用具有想到特殊的文件,希望能保证给他们分配特定的MIME类型,则mime-mapping元素提供这种保证。
welcome-file-list> 指示服务器在收到引用一个目录名而不是文件名的URL时,使用哪个文件。
error-page> 在返回特定HTTP状态代码时,或者特定类型的异常被抛出时,能够制定将要显示的页面。
taglib> 对标记库描述符文件(Tag Libraryu Descriptor file)指定别名。此功能使你能够更改TLD文件的位置,而不用编辑使用这些文件的JSP页面。
resource-env-ref>声明与资源相关的一个管理对象。
resource-ref> 声明一个资源工厂使用的外部资源。
security-constraint> 制定应该保护的URL。它与login-config元素联合使用
login-config> 指定服务器应该怎样给试图访问受保护页面的用户授权。它与sercurity-constraint元素联合使用。
security-role>给出安全角色的一个列表,这些角色将出现在servlet元素内的security-role-ref元素的role-name子元素中。分别地声明角色可使高级IDE处理安全信息更为容易。
env-entry>声明Web应用的环境项。
ejb-ref>声明一个EJB的主目录的引用。
ejb-local-ref>声明一个EJB的本地主目录的应用。
web-app>
相应元素的配置:
-
Web应用图标:指出IDE和GUI工具用来表示Web应用的大图标和小图标
icon> small-icon> large-icon> icon>
-
Web 应用名称:提供GUI工具可能会用来标记这个特定的Web应用的一个名称
display-name>
-
Web 应用描述: 给出于此相关的说明性文本
disciption>
-
上下文参数:声明应用范围内的初始化参数。
context-param> para-name> param-value> description> context-param>
-
过滤器配置:将一个名字与一个实现javaxs.servlet.Filter接口的类相关联。
filter> filter-name> filter-class> init-param> param-name> param-value> init-param> filter> filter-mapping> filter-name> url-pattern> filter-mapping>
-
监听器配置
listener> listener-class> listener>
-
基本配置
servlet> servlet-name> servlet-class> servlet> servlet-mapping> servlet-name> url-pattern> servlet-mapping>
高级配置
servlet> servlet-name> servlet-class> init-param> param-name> param-value> init-param> run-as> description> role-name> run-as> servlet> servlet-mapping> servlet-name> url-pattern> servlet-mapping>
元素说明
servlet> 用来声明一个servlet的数据,主要有以下子元素: servlet-name> 指定servlet的名称 servlet-class> 指定servlet的类名称 jsp-file> 指定web站台中的某个JSP网页的完整路径 init-param> 用来定义参数,可有多个init-param。在servlet类中通过getInitParamenter(String name)方法访问初始化参数 load-on-startup>指定当Web应用启动时,装载Servlet的次序。 当值为正数或零时:Servlet容器先加载数值小的servlet,再依次加载其他数值大的servlet. 当值为负或未定义:Servlet容器将在Web客户首次访问这个servlet时加载它 servlet-mapping> 用来定义servlet所对应的URL,包含两个子元素 servlet-name> 指定servlet的名称 url-pattern> 指定servlet所对应的URL
-
会话超时配置(单位为分钟)
session-config> session-timeout> session-config>
-
MIME类型配置
mime-mapping> extension> mime-type> mime-mapping>
-
指定欢迎文件页配置
welcome-file-list> welcome-file> welcome-file> welcome-file> welcome-file-list>
-
方法1:通过错误码来配置error-page
error-page> error-code> location> error-page>
404错误时,跳转到错误处理页面NotFound.jsp。 方法2:通过异常的类型配置error-page
error-page> exception-type> location> error-page>
上面配置了当系统发生java.lang.NullException(即空指针异常)时,跳转到错误处理页面error.jsp
-
TLD配置
taglib> taglib-uri> taglib-location> taglib>
jsp-config>中
jsp-config> taglib> taglib-uri> taglib-location> taglib> jsp-config>
-
资源管理对象配置
resource-env-ref> resource-env-ref-name> resource-env-ref>
-
资源工厂配置
resource-ref> res-ref-name> res-type> res-auth> resource-ref>
配置数据库连接池就可在此配置:
resource-ref> description> res-ref-name> res-type> res-auth> resource-ref>
-
安全限制配置
security-constraint> display-name> web-resource-collection> web-resource-name> url-pattern> http-method> http-method> http-method> http-method> web-resource-collection> auth-constraint> role-name> role-name> auth-constraint> security-constraint>
-
登陆验证配置
login-config> auth-method> realm-name> form-login-config> form-login-page> form-error-page> form-login-config> login-config>
-
分别地声明角色可使高级IDE处理安全信息更为容易。
security-role> role-name> security-role>
-
Web环境参数:env-entry元素声明Web应用的环境项
env-entry> env-entry-name> env-entry-value> env-entry-type> env-entry>
-
EJB 声明
ejb-ref> decription> ejb-ref-name> ejb-ref-type> home> remote> ejb-ref>
-
本地EJB声明
ejb-local-ref> decription> ejb-ref-name> ejb-ref-type> local-home> local> ejb-local-ref>
-
配置DWR
servlet> servlet-name> servlet-class> servlet> servlet-mapping> servlet-name> url-pattern> servlet-mapping>
4.spring项目中web.xml基础配置
配置基于servlet 3.1
?>
display-name>
description>
<!-- 在Spring框架中是如何解决从页面传来的字符串的编码问题的呢?
下面我们来看看Spring框架给我们提供过滤器CharacterEncodingFilter
这个过滤器就是针对于每次浏览器请求进行过滤的,然后再其之上添加了父类没有的功能即处理字符编码。
其中encoding用来设置编码格式,forceEncoding用来设置是否理会 request.getCharacterEncoding()方法,设置为true则强制覆盖之前的编码格式。-->
filter>
filter-name>
filter-class>
init-param>
param-name>
param-value>
init-param>
init-param>
param-name>
param-value>
init-param>
filter>
filter-mapping>
filter-name>
url-pattern>
filter-mapping>
<!-- 项目中使用Spring 时,applicationContext.xml配置文件中并没有BeanFactory,要想在业务层中的class 文件中直接引用Spring容器管理的bean可通过以下方式-->
<!--1、在web.xml配置监听器ContextLoaderListener-->
<!--ContextLoaderListener的作用就是启动Web容器时,自动装配ApplicationContext的配置信息。因为它实现了ServletContextListener这个接口,在web.xml配置这个监听器,启动容器时,就会默认执行它实现的方法。
在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");-->
listener>
listener-class>
listener>
<!--2、部署applicationContext的xml文件-->
context-param>
param-name>
param-value>
context-param>
<!--方案一:激活Tomcat的defaultServlet来处理静态文件-->
<!--要写在DispatcherServlet的前面, 让 defaultServlet先拦截请求,这样请求就不会进入Spring了,我想性能是最好的吧。-->
servlet-mapping>
servlet-name>
url-pattern>
servlet-mapping>
servlet-mapping>
servlet-name>
url-pattern>
servlet-mapping>
servlet-mapping>
servlet-name>
url-pattern>
servlet-mapping>
servlet-mapping>
servlet-name>
url-pattern>
servlet-mapping>
servlet-mapping>
servlet-name>
url-pattern>
servlet-mapping>
servlet-mapping>
servlet-name>
url-pattern>
servlet-mapping>
servlet-mapping>
servlet-name>
url-pattern>
servlet-mapping>
servlet-mapping>
servlet-name>
url-pattern>
servlet-mapping>
servlet-mapping>
servlet-name>
url-pattern>
servlet-mapping>
servlet-mapping>
servlet-name>
url-pattern>
servlet-mapping>
<!--使用Spring MVC,配置DispatcherServlet是第一步。DispatcherServlet是一个Servlet,,所以可以配置多个DispatcherServlet-->
<!--DispatcherServlet是前置控制器,配置在web.xml文件中的。拦截匹配的请求,Servlet拦截匹配规则要自已定义,把拦截下来的请求,依据某某规则分发到目标Controller(我们写的Action)来处理。-->
servlet>
servlet-name>
<!--在DispatcherServlet的初始化过程中,框架会在web应用的 WEB-INF文件夹下寻找名为[servlet-name]-servlet.xml 的配置文件,生成文件中定义的bean。-->
servlet-class>
<!--指明了配置文件的文件名,不使用默认配置文件名,而使用dispatcher-servlet.xml配置文件。-->
init-param>
param-name>
<!--其中<param-value>**.xml</param-value> 这里可以使用多种写法-->
<!--1、不写,使用默认值:/WEB-INF/<servlet-name>-servlet.xml-->
<!--2、<param-value>/WEB-INF/classes/dispatcher-servlet.xml</param-value>-->