web.xml配置详解

1. XML文档有效性检查


这段代码指定文件类型定义(DTD),可以通过它检查XML文档的有效性。下面显示的元素有几个特性,这些特性告诉我们关于DTD的信息:

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

2.

部署描述符的根元素是。DTD文件规定元素的子元素的语法如下:


正如您所看到的,这个元素含有23个子元素,而且子元素都是可选的。问号(?)表示子元素是可选的,而且只能出现一次。星号(*)表示子元素可在部署描述符中出现零次或多次。有些子元素还可以有它们自己的子元素。web.xml文件中元素声明的是下面每个子元素的声明。下面讲述部署描述符中可能包含的所有子元素。

注意:在Servlet 2.3中,子元素必须按照DTD文件语法描述中指定的顺序出现。比如:如果部署描述符中的元素有两个子元素,则子元素必须出现在子元素之前。在Servlet2.4中,顺序并不重要。

3.

test-hwp-web-application定义了web应用的名称,可以在http://localhost:8080/manager/html中显示。如下所示:

20180107122615744.png

4.

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

5.

使用上下文初始化参数


  
  
    webAppRootKey  
    business.root  
  
  
  
    contextConfigLocation  
    /WEB-INF/spring-configuration/*.xml  

5.1解释:

元素含有一对参数名和参数值,用作应用的Servlet上下文初始化参数,参数名在整个Web应用中必须是惟一的,在web应用的整个生命周期中上下文初始化参数都存在,任意的Servlet和jsp都可以随时随地访问它。子元素包含有参数名,而子元素包含的是参数值。作为选择,可用子元素来描述参数。

5.2 什么情况下使用,为什么使用

比如:定义一个管理员email地址用来从程序发送错误,或者与你整个应用程序有关的其他设置。使用自己定义的设置文件需要额外的代码和管理;直接在你的程序中使用硬编码(Hard-coding)参数值会给你之后修改程序带来麻烦,更困难的是,要根据不同的部署使用不同的设置;通过这种办法,可以让其他开发人员更容易找到相关的参数,因为它是一个用于设置这种参数的标准位置。

5.3 Spring配置文件:

配置Spring,必须需要,而可有可无如果在web.xml中不写配置信息,默认的路径是/WEB-INF/applicationontext.xml在WEB-INF目录下创建的xml文件的名称必须是applicationContext.xml
如果是要自定义文件名可以在web.xml里加入contextConfigLocation这个context参数:在
里指定相应的xml文件名,如果有多个xml文件,可以写在一起并以“,”号分隔,比如在business-client工程中,我们采用了自定义配置方式,配置如下:

  
  
    contextConfigLocation  
    /WEB-INF/spring-configuration/*.xml  
  
  
     org.springframework.web.context.ContextLoaderListener  
 

对应工程目录结构如下所示:


20180107123652181.png

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

    
     
        webAppRootKey    
        webapp.root    
 

当然也不能重复,否则报类似下面的错误:

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为

    
        
        webAppRootKey    
         business.root     
        
    
        
        webAppRootKey    
         pubbase.root    
    

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

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

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

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

如果web.xml中有contextConfigLocation参数指定的Spring配置文件则会去加载相应的配置文件,而不会去加载/WEB-INF/下的applicationContext.xml。但是如果没有指定的话,默认会去/WEB-INF/下加载applicationContext.xml。

在一个团队使用Spring的实际项目中,应该需要多个Spring的配置文件,如何使用和交叉引用的问题:
多个配置文件可以在web.xml里用逗号分隔写入,如:

  
   contextConfigLocation   
    applicationContext-database.xml,applicationContext.xml    

多个配置文件里的交叉引用可以用ref的external或bean解决,例如:applicationContext.xml
dbBean在applicationContext-database.xml中。

   
     
        
      

5.5 在不同环境下如何获取:

范例:

  
   param_name  
   param_value  

此所设定的参数,
在JSP网页中可以使用下列方法来取得:${initParam.param_name}
若在Servlet可以使用下列方法来获得:
String param_name=getServletContext().getInitParamter("param_name");
Servlet的ServletConfig对象拥有该Servlet的ServletContext的一个引用,所以可这样取得上下文初始化参数:getServletConfig().getServletContext().getInitParameter()也可以在Servlet中直接调用getServletContext().getInitParameter(),两者是等价的

6.

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

  
   
   120   

7.

  
  
  
    org.springframework.web.util.Log4jConfigListener  
  

  
    org.springframework.web.context.ContextLoaderListener  
  
   
  
com.yonyou.mcloud.cas.client.session.SingleSignOutHttpSessionListener  

7.1 Listener介绍:

为web应用程序定义监听器,监听器用来监听各种事件,比如:application和session事件,所有的监听器按照相同的方式定义,功能取决去它们各自实现的接口,常用的Web事件接口有如下几个:
(1). ServletContextListener:用于监听Web应用的启动和关闭;
(2). ServletContextAttributeListener:用于监听ServletContext范围(application)内属性的改变;
(3). ServletRequestListener:用于监听用户的请求;
(4). ServletRequestAttributeListener:用于监听ServletRequest范围(request)内属性的改变;
(5). HttpSessionListener:用于监听用户session的开始和结束;
(6). HttpSessionAttributeListener:用于监听HttpSession范围(session)内属性的改变。
主要用于监听Web应用事件,
其中有两个比较重要的WEB应用事件
1.应用的启动和停止(starting up or shutting down)
2.Session的创建和失效(created or destroyed)。

应用启动事件发生在应用第一次被Servlet容器装载和启动的时候;停止事件发生在Web应用停止的时候。
Session创建事件发生在每次一个新的session创建的时候,类似地Session失效事件发生在每次一个Session失效的时候。
为了使用这些Web应用事件做些有用的事情,我们必须创建和使用一些特殊的“监听类”。
它们是实现了以下两个接口中任何一个接口的简单java类:javax.servlet.ServletContextListenerjavax.servlet.http.HttpSessionListener
如果想让你的类监听应用的启动和停止事件,你就得实现ServletContextListener接口;
想让你的类去监听Session的创建和失效事件,那你就得实现HttpSessionListener接口。

7.2 Listener配置:

配置Listener只要向Web应用注册Listener实现类即可,无序配置参数之类的东西,因为Listener获取的是Web应用ServletContext(application)的配置参数。为Web应用配置Listener的两种方式:
(1). 使用@WebListener修饰Listener实现类即可。
(2). 在web.xml文档中使用进行配置。
我们选择web.xml这种配置方式,只有一个元素指定Listener的实现类,如下所示:

  
   org.springframework.web.context.ContextLoaderListener  

这里的用于Spring的加载
Spring加载可以利用ServletContextListener实现,也可以采用load-on-startup Servlet 实现.

但是当需要用到bean时,但加载顺序是:先加载后加载,则中初始化操作中的bean为null;所以,如果过滤器中要使用到bean,此时就可以根据加载顺序 -> -> ,将spring的加载改成Listener的方式。
方式1.采用load-on-startup Servlet 实现:

    
   context   
   org.springframework.web.context.ContextLoaderServlet    
   1    

方式2:利用ServletContextListener实现:
ContextLoaderListener 实现了 ServletContextListener

  
   org.springframework.web.context.ContextLoaderListener  

我们选择了第二种方式,在J2EE工程中web服务器启动的时候最先调用web.xml,上面这段配置的意思是加载spring的监听器,其中ContextLoaderListener的作用就是启动Web容器时,自动装配applicationContext.xml的配置信息,执行它所实现的方法。

8.

  
    
    
    CharacterEncodingFilter  
    org.springframework.web.filter.CharacterEncodingFilter  
      
      encoding  
      UTF-8  
      
      
      forceEncoding  
      true  
      
    
    
    
    CAS Single Sign Out Filter  
    com.yonyou.mcloud.cas.client.session.SingleSignOutFilter  
    
    
    
    CAS Authentication Filter  
com.yonyou.mcloud.cas.client.authentication.ExpandAuthenticationFilter  
      
      casServerLoginUrl  
      https://dev.yonyou.com:443/sso-server/login  
      
      
        
      serverName  
      http://10.1.215.40:80  
      
    
    
    
    CAS Validation Filter  
org.jasig.cas.client.validation.Cas20ProxyReceivingTicketValidationFilter  
      
      casServerUrlPrefix  
      https://dev.yonyou.com:443/sso-server  
      
      
      serverName  
      http://10.1.215.40:80  
      
      
      proxyCallbackUrl  
      https://dev.yonyou.com:443/business/proxyCallback  
      
      
      proxyReceptorUrl  
      /proxyCallback  
      
      
      proxyGrantingTicketStorageClass  
com.yonyou.mcloud.cas.client.proxy.MemcachedBackedProxyGrantingTicketStorageImpl  
      
      
      
      encoding  
      UTF-8  
      
    
    
    CAS HttpServletRequest Wrapper Filter  
    org.jasig.cas.client.util.HttpServletRequestWrapperFilter  
    
    
    CAS Assertion Thread Local Filter  
    org.jasig.cas.client.util.AssertionThreadLocalFilter  
    
    
    NoCache Filter  
    com.yonyou.mcloud.cas.client.authentication.NoCacheFilter  
    
    
    
    CharacterEncodingFilter  
    /*  
    
    
    NoCache Filter  
    /*  
    
    
    CAS Single Sign Out Filter  
    /*  
    
    
    CAS Validation Filter  
    /proxyCallback  
    
    
    CAS Authentication Filter  
    /*  
    
    
    CAS Validation Filter  
    /*  
    
    
    CAS HttpServletRequest Wrapper Filter  
    /*  
    
    
    CAS Assertion Thread Local Filter  
    /*  
  
8.1 Filter介绍:

filter的作用:

Filter可认为是Servle的一种“加强版”,`主要用于对用户请求request进行预处理,也可以对Response进行后处理`,是个典型的处理链。

使用Filter的完整流程是:Filter对用户请求进行预处理,接着将请求HttpServletRequest交给Servlet进行处理并生成响应,最后Filter再对服务器响应HttpServletResponse进行后处理。Filter与Servlet具有完全相同的生命周期,且Filter也可以通过来配置初始化参数,获取Filter的初始化参数则使用FilterConfig的getInitParameter()。
换种说法,Servlet里有request和response两个对象,Filter能够在一个request到达Servlet之前预处理request,也可以在离开Servlet时处理response,Filter其实是一个Servlet链。以下是Filter的一些常见应用场合,
(1)认证Filter
(2)日志和审核Filter
(3)图片转换Filter
(4)数据压缩Filter
(5)密码Filter
(6)令牌Filter
(7)触发资源访问事件的Filter
(8)XSLT Filter
(9)媒体类型链Filter
Filter可负责拦截多个请求或响应;一个请求或响应也可被多个Filter拦截。创建一个Filter只需两步:
(1) 创建Filter处理类
(2) Web.xml文件中配置Filter
Filter必须实现javax.servlet.Filter接口,在该接口中定义了三个方法:
(1) void init(FilterConfig config):用于完成Filter的初始化。FilteConfig用于访问Filter的配置信息。
(2) void destroy():用于Filter销毁前,完成某些资源的回收。
(3) void doFilter(ServletRequest request,ServletResponse response,FilterChain chain):实现过滤功能的核心方法,该方法就是对每个请求及响应增加额外的处理。该方法实现对用户请求request进行预处理,也可以实现对服务器响应response进行后处理---它们的分界线为是否调用了chain.doFilter(request,response),执行该方法之前,即对用户请求request进行预处理,执行该方法之后,即对服务器响应response进行后处理。

8.2 Filter配置:

Filter可认为是Servlet的“增强版”,因此Filter配置与Servlet的配置非常相似,需要配置两部分:配置Filter名称和Filter拦截器URL模式。区别在于Servlet通常只配置一个URL,而Filter可以同时配置多个请求的URL。配置Filter有两种方式:
(1). 在Filter类中通过Annotation进行配置。
(2). 在web.xml文件中通过配置文件进行配置。
我们使用的是web.xml这种配置方式,下面重点介绍内包含的一些元素。
用于指定Web容器中的过滤器,可包含
(1).用来定义过滤器的名称,该名称在整个程序中都必须唯一。
(2).元素指定过滤器类的完全限定的名称,即Filter的实现类。
(3). 为Filter配置参数,与具有相同的元素描述符
(4). 元素用来声明Web应用中的过滤器映射,过滤器被映射到一个servlet或一个URL 模式。这个过滤器的必须具有相同的,指定该Filter所拦截的URL。过滤是按照部署描述符的出现的顺序执行的。

9.1 Servlet介绍

例子:

  
  
  
    business  
    org.springframework.web.servlet.DispatcherServlet  
      
      publishContext  
      false  
      
    1  
  
  
  
    LogOutServlet  
    com.yonyou.mcloud.cas.web.servlet.LogOutServlet  
      
      serverLogoutUrl  
      https://dev.yonyou.com:443/sso-server/logout  
      
      
      serverName  
      http://10.1.215.40:80/business/  
      
  
  
  
    LogOutServlet  
    /logout  
  
  
    business  
    /  

9.1 Servlet介绍:

servlet作用

Servlet通常称为服务器端`小程序`,是运行在服务器端的程序,`用于处理及响应客户的请求`。

Servlet是个特殊的java类,继承于HttpServlet。客户端通常只有GET和POST两种请求方式,Servlet为了响应则两种请求,必须重写doGet()和doPost()方法。大部分时候,Servlet对于所有的请求响应都是完全一样的,此时只需要重写service()方法即可响应客户端的所有请求。
另外,HttpServlet有两个方法:
(1). init(ServletConfig config):创建Servlet实例时,调用该方法的初始化Servlet资源。
(2). destroy():销毁Servlet实例时,自动调用该方法的回收资源。
通常无需重写init()和destroy()两个方法,除非需要在初始化Servlet时,完成某些资源初始化的方法,才考虑重写init()方法,如果重写了init()方法,应在重写该方法的第一行调用super.init(config),该方法将调用HttpServlet的init()方法。如果需要在销毁Servlet之前,先完成某些资源的回收,比如关闭数据库连接,才需要重写destory方法()。
Servlet的生命周期:
创建Servlet实例有两个时机:
(1). 客户端第一次请求某个Servlet时,系统创建该Servlet的实例,大部分Servlet都是这种Servlet。
(2). Web应用启动时立即创建Servlet实例,即load-on-start Servlet
每个Servlet的运行都遵循如下生命周期:
(1). 创建Servlet实例。
(2). Web容器调用Servlet的init()方法,对Servlet进行初始化。
(3). Servlet初始化后,将一直存在于容器中,用于响应客户端请求,如果客户端发送GET请求,容器调用Servlet的doGet()方法处理并响应请求;如果客户端发送POST请求,容器调用Servlet的doPost()方法处理并响应请求。或者统一使用service()方法处理来响应用户请求。
(4). Web容器决定销毁Servlet时,先调用Servlet的destory()方法,通常在关闭Web应用时销毁Servlet实例。

9.2 Servlet配置:

为了让Servlet能响应用户请求,还必须将Servlet配置在web应用中,配置Servlet需要修改web.xml文件。从Servlet3.0开始,配置Servlet有两种方式:

(1). 在Servlet类中使用@WebServlet Annotation进行配置。
(2). 在web.xml文件中进行配置。

我们用web.xml文件来配置Servlet,需要配置用来声明一个Servlet。元素的用法和的用法相同。元素与元素具有相同的元素描述符,可以使用子元素将初始化参数名和参数值传递给Servlet.
访问Servlet配置参数通过ServletConfig对象来完成,ServletConfig提供如下方法:
java.lang.String.getInitParameter(java.lang.String name):用于获取初始化参数
ServletConfig获取配置参数的方法和ServletContext获取配置参数的方法完全一样,只是ServletConfig是取得当前Servlet的配置参数,而ServletContext是获取整个Web应用的配置参数。

1). :为Servlet指定一个文本描述。
2). :为Servlet提供一个简短的名字被某些工具显示。
3). :为Servlet指定一个图标,在图形管理工具中表示该Servlet。

必须含有,或者
描述如下:
1). 用来定义servlet的名称,该名称在整个应用中必须是惟一的。
2). 用来指定servlet的完全限定的名称。
3). 用来指定应用中JSP文件的完整路径。这个完整路径必须由/开始。


如果load-on-startup元素存在,而且也指定了jsp-file元素,则JSP文件会被重新编译成Servlet,同时产生的Servlet也被载入内存。的内容可以为空,或者是一个整数。这个值表示由Web容器载入内存的顺序。
举个例子:如果有两个Servlet元素都含有子元素,则子元素值较小的Servlet将先被加载。如果子元素值为空或负值,则由Web容器决定什么时候加载Servlet。如果两个Servlet的子元素值相同,则由Web容器决定先加载哪一个Servlet。1表示启动容器时,初始化Servlet。
(4).
含有
1). :Servlet的名字,唯一性和一致性,与元素中声明的名字一致。
2). :指定相对于Servlet的URL的路径。该路径相对于web应用程序上下文的根路径。将URL模式映射到某个Servlet,即该Servlet处理的URL。
(5). 加载Servlet的过程
容器的Context对象对请求路径(URL)做出处理,去掉请求URL的上下文路径后,按路径映射规则和Servlet映射路径()做匹配,如果匹配成功,则调用这个Servlet处理请求。

9.3DispatcherServlet在web.xml中的配置:

  
  
    business  
    org.springframework.web.servlet.DispatcherServlet  
      
      publishContext  
      false  
      
    1  

配置Spring MVC,指定处理请求的Servlet,有两种方式:
(1). 默认查找MVC配置文件的地址是:/WEB-INF/${servletName}-servlet.xml
(2). 可以通过配置修改MVC配置文件的位置,需要在配置DispatcherServlet时指定MVC配置文件的位置。
我们在平台项目两个工程中分别使用了不同的配置方式,介绍如下:
(1). 在business-client工程中按照默认方式查找MVC的配置文件,配置文件目录为: /WEB-INF/business-servlet.xml。工程结构如下

20180107221229630.png

(2).在public-base-server工程中,通过第2种方式进行配置,把spring-servlet.xml放到src/main/resources/config/spring-servlet.xml,则需要在配置DispatcherServlet时指定标签。具体代码如下:

  
    spring  
    org.springframework.web.servlet.DispatcherServlet  
        
        publishContext  
        false  
  
     
         contextConfigLocation    
            classpath:config/spring-servlet.xml    
           
     1  

工程目录结构如下

20180107221333060.png
20180107221352019.png

其中,classpath是web项目的类路径,可以理解为classes下面。因为无论这些配置文件放在哪,编译之后如果没有特殊情况的话都直接在classes下面。jar包的话虽然放在lib文件夹里,但实际上那些类可以直接引用,比如:com.test.ABC,仿佛也在classes下面一样。

在我们的工程里,经过验证,maven工程这两个
image

路径经过编译后生成的文件都位于classes目录下,即这两个路径相当于类路径,在下面创建config文件夹(folder),然后创建自定义的xml配置文件即可。

classpath和classpath区别:同名资源存在时,classpath只从第一个符合条件的classpath中加载资源,而classpath会从所有的classpath中加载符合条件的资源。classpath,需要遍历所有的classpath,效率肯定比不上classpath,因此在项目设计的初期就尽量规划好资源文件所在的路径,避免使用classpath来加载。

参考链接:https://blog.csdn.net/ahou2468/article/details/79015251

你可能感兴趣的:(web.xml配置详解)