Web.xml详解

时间  2019-12-01
标签 web.xml web xml 详解 栏目 Tomcat 繁體版
原文   原文链接

Web.xml加载过程（步骤）

首先简单说一下，web.xml的加载过程。 当咱们去启动一个WEB项目时，容器包括（JBoss、Tomcat等）首先会读取项目web.xml配置文件里的配置，当这一步骤没有出错而且完成以后，项目才能正常地被启动起来。html

  • 启动WEB项目的时候，容器首先会去它的配置文件web.xml读取两个节点:
<listener></listener>

和java

<context-param></context-param>
  • 紧接着，容器建立一个 ServletContext（application），这个WEB项目全部部分都将共享这个上下文。
  • 容器以 <context-param></context-param> 的 name 做为键，value做为值，将其转化为键值对，存入ServletContext。
  • 容器建立 <listener></listener> 中的类实例，根据配置的 class 类路径 <listener-class> 来建立监听，在监听中会有 contextInitialized(ServletContextEvent args) 初始化方法，启动 Web 应用时，系统调用 Listener 的该方法，在这个方法中得到：
ServletContext application =ServletContextEvent.getServletContext();
context-param的值= application.getInitParameter("context-param的键");

获得这个context-param的值以后，你就能够作一些操做了web

  • 举例：你可能想在项目启动以前就打开数据库，那么这里就能够在<context-param>中设置 数据库的链接方式（驱动、url、user、password），在监听类中初始化数据库的链接。 这个监听是本身写的一个类，除了初始化方法，它还有销毁方法，用于关闭应用前释放资源。 好比:说数据库链接的关闭，此时，调用contextDestroyed(ServletContextEvent args)，关闭Web应用时，系统调用Listener的该方法。
  • 接着，容器会读取**<filter></filter>**，根据指定的类路径来实例化过滤器。
  • 以上都是在WEB项目尚未彻底启动起来的时候就已经完成了的工做。若是系统中有Servlet，则Servlet是在第一次发起请求的时候被实例化的，并且通常不会被容器销毁，它能够服务于多个用户的请求。因此，Servlet的初始化都要比上面提到的那几个要迟。

总的来讲，web.xml 的加载顺序是: <context-param> -> <listener> -> <filter> -> <servlet> 。其中，若是 web.xml 中出现了相同的元素，则按照在配置文件中出现的前后顺序来加载。spring

对于某类元素而言，与它们出现的顺序是有关的。以 <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标签详解

1. **XML**文档有效性检查

部署描述符的根元素是**<web-app>。DTD文件规定<web-app>**元素的子元素的语法以下：tomcat

<!DOCTYPE web-app PUBLIC
 "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
 "http://java.sun.com/dtd/web-app_2_3.dtd" >

这段代码指定文件类型定义(DTD)，能够经过它检查XML文档的有效性。下面显示的<!DOCTYPE>元素有几个特性，这些特性告诉咱们关于DTD的信息：session

  • **web-app定义该文档(部署描述符，不是DTD**文件)的根元素
  • **PUBLIC意味着DTD**文件能够被公开使用
  • _ "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"_意味着DTD由Sun Microsystems, Inc.维护。该信息也表示它描述的文档类型是**DTD Web Application 2.3，并且DTD**是用英文书写的。
  • URL"http://java.sun.com/dtd/web-app_2_3.dtd" 表示D文件的位置。

2. <web-app></web-app>

<!ELEMENT web-app (icon?, display-name?, description?, 
distributable?, context-param*, filter*, filter-mapping*, 
listener*, servlet*, servlet-mapping*, session-config?, 
mime-mapping*, welcome-file-list?, 
error-page*, taglib*, resource-env-ref*, resource-ref*, 
security-constraint*, login-config?, security-role*,env-entry*, 
ejb-ref*, ejb-local-ref*)>

正如您所看到的，这个元素含有23个子元素，并且子元素都是可选的。问号**(？)**表示子元素是可选的，并且只能出现一次。星号 (*) 表示子元素可在部署描述符中出现零次或屡次。有些子元素还能够有它们本身的子元素。 web.xml 文件中 **<web-app>**元素声明的是下面每一个子元素的声明。下面讲述部署描述符中可能包含的全部子元素。app

ps:在Servlet 2.3中，子元素必须按照DTD文件语法描述中指定的顺序出现。好比：若是部署描述符中的<web-app>元素有<servlet>和<servlet-mapping>两个子元素，则<servlet>子元素必须出如今<servlet-mapping>子元素以前。在Servlet2.4中，顺序并不重要。dom

3.<display-name></display-name>

<display-name>test-hwp-web-application</display-name>定义了web应用的名称，能够在http://localhost:8080/manager/html 中显示。以下所示：webapp

输入图片说明

4.<distributable/>

<distributable/>可使用distributable元素来告诉servlet/JSP容器，Web容器中部署的应用程序适合在分环境下运行。

5.<context-param></context-param>

<!--****************************上下文初始化参数配***************************-->  
<context-param>  
    <param-name>webAppRootKey</param-name>  
    <param-value>business.root</param-value>  
</context-param>  
<!-- spring config -->  
<context-param>  
    <param-name>contextConfigLocation</param-name>  
    <param-value>/WEB-INF/spring-configuration/*.xml</param-value>  
</context-param>

<context-param>解释： <context-param>元素含有一对参数名和参数值，用做应用的Servlet上下文初始化参数，参数名在整个Web应用中必须是唯一的，在web应用的整个生命周期中上下文初始化参数都存在，任意的Servlet和 _ jsp_ 均可以随时随地访问它。<param-name> 子元素包含有参数名，而**<param-value>子元素包含的是参数值。做为选择，可用<description>**子元素来描述参数。

什么状况下使用，为何使用<context-param>?

好比：定义一个管理员email地址用来从程序发送错误，或者与你整个应用程序有关的其余设置。使用本身定义的设置文件须要额外的代码和管理；直接在你的程序中使用硬编码（Hard-coding）参数值会给你以后修改程序带来麻烦，更困难的是，要根据不一样的部署使用不一样的设置；经过这种办法，可让其余开发人员更容易找到相关的参数，由于它是一个用于设置这种参数的标准位置。

Spring配置文件：

配置**Spring，必须须要<listener>，而<context-param>无关紧要，若是在web.xml中不写<context-param>配置信息，默认的路径是/WEB-INF/applicationContext.xml，在WEB-INF目录下建立的xml文件的名称必须是applicationContext.xml。若是是要自定义文件名能够在web.xml里加入contextConfigLocation这个context参数：在<param-value>里指定相应的xml文件名，若是有多个xml文件，能够写在一块儿并以“,”号分隔，好比在business-client工程中，咱们采用了自定义配置方式，<context-param>**配置以下：

<!-- spring config -->  
<context-param>  
    <param-name>contextConfigLocation</param-name>  
    <param-value>/WEB-INF/spring-configuration/*.xml</param-value>  
</context-param>  
<listener>  
     <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>  
 </listener>

部署在同一容器中的多个Web项目，要配置不一样的webAppRootKey，web.xml文件中最好定义webAppRootKey参数，若是不定义，将会缺省为“webapp.root”，以下：

<!-- 应用路径  -->    
 <context-param>    
        <param-name>webAppRootKey</param-name>    
        <param-value>webapp.root</param-value>    
 </context-param>

固然也不能重复，不然报相似下面的错误：

Web app root system property already set to different value: 'webapp.root' = [/home/user/tomcat/webapps/project1/] instead of [/home/user/tomcat/webapps/project2/] - Choose unique values for the 'webAppRootKey' context-param in your web.xml files!

意思是“webapp.root”这个key已经指向了项目1，不能够再指向项目2。多个项目要对webAppRootKey进行配置，咱们工程主要是让log4j能将日志写到对应项目根目录下，好比：咱们的项目的webAppRootKey为

!—business-client应用路径  -->    
    <context-param>    
        <param-name>webAppRootKey</param-name>    
        <param-value> business.root </param-value>    
    </context-param>    
<!—public-base应用路径  -->    
    <context-param>    
        <param-name>webAppRootKey</param-name>    
        <param-value> pubbase.root</param-value>    
    </context-param>

这样就不会出现冲突了。就能够在运行时动态地找到项目路径，在log4j.properties配置文件中能够按下面的方式使用**${webapp.root}**：

log4j.appender.file.File=${webapp.root}/WEB-INF/logs/sample.log

就能够在运行时动态地找出项目的路径。

多个配置文件交叉引用处理：

若是web.xml中有contextConfigLocation参数指定的Spring配置文件，则会去加载相应的配置文件，而不会去加载/WEB-INF/下的applicationContext.xml。可是若是没有指定的话，默认会去/WEB-INF/下加载applicationContext.xml。 在一个团队使用Spring的实际项目中，应该须要多个Spring的配置文件，如何使用和交叉引用的问题： 多个配置文件能够在web.xml里用空格分隔写入，如：

<context-param>  
<param-name>contextConfigLocation </param-name>  
<param-value> applicationContext-database.xml,applicationContext.xml</param-value>    
<context-param>

多个配置文件里的交叉引用能够用ref的external或bean解决，例如

applicationContext.xml

<bean id="userService" class="domain.user.service.impl.UserServiceImpl">   
<property name="dbbean">  
<ref bean="dbBean"/>  
</property>   
</bean>

dbBean在applicationContext-database.xml中。 在不一样环境下如何获取：

<context-param>  
<param-name>param_name</param-name>  
<param-value>param_value</param-value>  
</context-param>

此所设定的参数，在JSP网页中可使用下列方法来取得：

${initParam.param_name}

若在Servlet可使用下列方法来得到：

String param_name=getServletContext().getInitParamter("param_name");

**Servlet的ServletConfig对象拥有该Servlet**的 ServletContext的一个引用，因此可这样取得上下文初始化参数：getServletConfig().getServletContext().getInitParameter()也能够在Servlet中直接调用getServletContext().getInitParameter()，二者是等价的。

6.<session-config></session-config>

<!-- Set timeout to 120 minutes -->  
<session-config>   
<session-timeout>120</session-timeout>   
</session-config>

<session-config> 用于设置容器的**session参数，好比：<session-timeout>用于指定http session的失效时间。默认时间设置在<jakarta>/conf/web.xml (30 minutes)。<session-timeout>**用来指定默认的会话超时时间间隔，以分钟为单位。该元素值必须为整数。若是 session-timeout元素的值为零或负数，则表示会话将永远不会超时。

7. <listener></listener>

<!--****************************监听器配置*********************************-->  
<!-- Spring的log4j监听器 -->  
<listener>  
    <listener-class>org.springframework.web.util.Log4jConfigListener</listener-class>  
</listener>  
<listener>  
    <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>  
</listener>  
<!-- 与CAS Single Sign Out Filter配合，注销登陆信息  -->   
<listener>  
<listener-class>com.yonyou.mcloud.cas.client.session.SingleSignOutHttpSessionListener</listener-class>  
</listener>
  1. Listener介绍：

<listener>为web应用程序定义监听器，监听器用来监听各类事件，好比：application和session事件，全部的监听器按照相同的方式定义，功能取决去它们各自实现的接口，经常使用的Web事件接口有以下几个：

  • _ ServletContextListener_：用于监听**Web**应用的启动和关闭；
  • _ ServletContextAttributeListener_：用于监听**ServletContext范围（application**）内属性的改变；
  • ServletRequestListener：用于监听用户的请求；
  • ServletRequestAttributeListener：用于监听**ServletRequest范围（request**）内属性的改变；
  • _ HttpSessionListener_：用于监听用户**session**的开始和结束；
  • HttpSessionAttributeListener：用于监听**HttpSession范围（session**）内属性的改变。

<listener>主要用于监听Web应用事件，其中有两个比较重要的WEB应用事件：应用的启动和中止（starting up or shutting down）和**Session的建立和失效（created or destroyed）。应用启动事件发生在应用第一次被Servlet容器装载和启动的时候；中止事件发生在Web应用中止的时候。Session建立事件发生在每次一个新的session建立的时候，相似地Session失效事件发生在每次一个Session失效的时候。为了使用这些Web应用事件作些有用的事情，咱们必须建立和使用一些特殊的“监听类”。它们是实现了如下两个接口中任何一个接口的简单java类：javax.servlet.ServletContextListener或javax.servlet.http.HttpSessionListener，若是想让你的类监听应用的启动和中止事件，你就得实现ServletContextListener接口；想让你的类去监听Session的建立和失效事件，那你就得实现HttpSessionListener**接口。

1.Listener配置：

  • 使用**@WebListener修饰Listener**实现类便可。
  • 在**web.xml文档中使用<listener>**进行配置。

咱们选择web.xml这种配置方式，只有一个元素<listener-class>指定Listener的实现类，以下所示：

<listener>
<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>

8. <filter></filter>

<!--****************************过滤器配置*********************************-->  
  <!-- 字符集过滤器 -->  
  <filter>  
    <filter-name>CharacterEncodingFilter</filter-name>  
    <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>  
    <init-param>  
      <param-name>encoding</param-name>  
      <param-value>UTF-8</param-value>  
    </init-param>  
    <init-param>  
      <param-name>forceEncoding</param-name>  
      <param-value>true</param-value>  
    </init-param>  
  </filter>  
  <!-- 单点登出过滤器 -->  
  <filter>  
    <filter-name>CAS Single Sign Out Filter</filter-name>  
    <filter-class>com.yonyou.mcloud.cas.client.session.SingleSignOutFilter</filter-class>  
  </filter>  
  <!-- 认证过滤器 -->  
  <filter>  
    <filter-name>CAS Authentication Filter</filter-name>  
<filter-class>com.yonyou.mcloud.cas.client.authentication.ExpandAuthenticationFilter</filter-class>  
    <init-param>  
      <param-name>casServerLoginUrl</param-name>  
      <param-value>https://dev.yonyou.com:443/sso-server/login</param-value>  
    </init-param>  
    <init-param>  
      <!--这里的server是服务端的IP -->  
      <param-name>serverName</param-name>  
      <param-value>http://10.1.215.40:80</param-value>  
    </init-param>  
  </filter>  
  <!-- 验证ST/PT过滤器 -->  
  <filter>  
    <filter-name>CAS Validation Filter</filter-name>  
<filter-class>org.jasig.cas.client.validation.Cas20ProxyReceivingTicketValidationFilter</filter-class>  
    <init-param>  
      <param-name>casServerUrlPrefix</param-name>  
      <param-value>https://dev.yonyou.com:443/sso-server</param-value>  
    </init-param>  
    <init-param>  
      <param-name>serverName</param-name>  
      <param-value>http://10.1.215.40:80</param-value>  
    </init-param>  
    <init-param>  
      <param-name>proxyCallbackUrl</param-name>  
      <param-value>https://dev.yonyou.com:443/business/proxyCallback</param-value>  
    </init-param>  
    <init-param>  
      <param-name>proxyReceptorUrl</param-name>  
      <param-value>/proxyCallback</param-value>  
    </init-param>  
    <init-param>  
      <param-name>proxyGrantingTicketStorageClass</param-name>  
<param-value>com.yonyou.mcloud.cas.client.proxy.MemcachedBackedProxyGrantingTicketStorageImpl</param-value>  
    </init-param>  
    <!-- 解决中文问题 -->  
    <init-param>  
      <param-name>encoding</param-name>  
      <param-value>UTF-8</param-value>  
    </init-param>  
  </filter>  
  <filter>  
    <filter-name>CAS HttpServletRequest Wrapper Filter</filter-name>  
    <filter-class>org.jasig.cas.client.util.HttpServletRequestWrapperFilter</filter-class>  
  </filter>  
  <filter>  
    <filter-name>CAS Assertion Thread Local Filter</filter-name>  
    <filter-class>org.jasig.cas.client.util.AssertionThreadLocalFilter</filter-class>  
  </filter>  
  <filter>  
    <filter-name>NoCache Filter</filter-name>  
    <filter-class>com.yonyou.mcloud.cas.client.authentication.NoCacheFilter</filter-class>  
  </filter>  
  <!--****************************映射关系配置********************************-->  
  <filter-mapping>  
    <filter-name>CharacterEncodingFilter</filter-name>  
    <url-pattern>/*</url-pattern>  
  </filter-mapping>  
  <filter-mapping>  
    <filter-name>NoCache Filter</filter-name>  
    <url-pattern>/*</url-pattern>  
  </filter-mapping>  
  <filter-mapping>  
    <filter-name>CAS Single Sign Out Filter</filter-name>  
    <url-pattern>/*</url-pattern>  
  </filter-mapping>  
  <filter-mapping>  
    <filter-name>CAS Validation Filter</filter-name>  
    <url-pattern>/proxyCallback</url-pattern>  
  </filter-mapping>  
  <filter-mapping>  
    <filter-name>CAS Authentication Filter</filter-name>  
    <url-pattern>/*</url-pattern>  
  </filter-mapping>  
  <filter-mapping>  
    <filter-name>CAS Validation Filter</filter-name>  
    <url-pattern>/*</url-pattern>  
  </filter-mapping>  
  <filter-mapping>  
    <filter-name>CAS HttpServletRequest Wrapper Filter</filter-name>  
    <url-pattern>/*</url-pattern>  
  </filter-mapping>  
  <filter-mapping>  
    <filter-name>CAS Assertion Thread Local Filter</filter-name>  
    <url-pattern>/*</url-pattern>  
  </filter-mapping>
相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程