目录(?)[-]
首先简单说一下,web.xml的加载过程。
当我们去启动一个WEB项目时,容器包括(JBoss、Tomcat等)首先会读取项目web.xml配置文件里的配置,当这一步骤没有出错并且完成之后,项目才能正常地被启动起来。
l 启动WEB项目的时候,容器首先会去它的配置文件web.xml读取两个节点:
和 。
l 紧接着,容器创建一个ServletContext(application),这个WEB项目所有部分都将共享这个上下文。
l 容器以的name作为键,value作为值,将其转化为键值对,存入ServletContext。
l 容器创建中的类实例,根据配置的class类路径 来创建监听,在监听中会有contextInitialized(ServletContextEvent args)初始化方法,启动Web应用时,系统调用Listener的该方法,在这个方法中获得:
ServletContext application =ServletContextEvent.getServletContext();
context-param的值= application.getInitParameter("context-param的键");
得到这个context-param的值之后,你就可以做一些操作了。
l 举例:你可能想在项目启动之前就打开数据库,那么这里就可以在中设置数据库的连接方式(驱动、url、user、password),在监听类中初始化数据库的连接。这个监听是自己写的一个类,除了初始化方法,它还有销毁方法,用于关闭应用前释放资源。比如:说数据库连接的关闭,此时,调用contextDestroyed(ServletContextEvent args),关闭Web应用时,系统调用Listener的该方法。
l 接着,容器会读取,根据指定的类路径来实例化过滤器。
l 以上都是在WEB项目还没有完全启动起来的时候就已经完成了的工作。如果系统中有Servlet,则Servlet是在第一次发起请求的时候被实例化的,而且一般不会被容器销毁,它可以服务于多个用户的请求。所以,Servlet的初始化都要比上面提到的那几个要迟。
总的来说,web.xml的加载顺序是:-> 。其中,如果web.xml中出现了相同的元素,则按照在配置文件中出现的先后顺序来加载。-> ->
对于某类元素而言,与它们出现的顺序是有关的。以为例,web.xml中当然可以定义多个 ,与 相关的一个元素是 ,注意,对于拥有相同 的 和 元素而言, 必须出现在 之后,否则当解析到 时,它所对应的 还未定义。web容器启动初始化每个 时,按照 出现的顺序来初始化的,当请求资源匹配多个 时, 拦截资源是按照 元素出现的顺序来依次调用doFilter()方法的。 同 类似,此处不再赘述。
"-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
"http://java.sun.com/dtd/web-app_2_3.dtd" >
这段代码指定文件类型定义(DTD),可以通过它检查XML文档的有效性。下面显示的元素有几个特性,这些特性告诉我们关于DTD的信息:
部署描述符的根元素是
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文件中
注意:
在Servlet 2.3中,子元素必须按照DTD文件语法描述中指定的顺序出现。比如:如果部署描述符中的
比如:定义一个管理员email地址用来从程序发送错误,或者与你整个应用程序有关的其他设置。使用自己定义的设置文件需要额外的代码和管理;直接在你的程序中使用硬编码(Hard-coding)参数值会给你之后修改程序带来麻烦,更困难的是,要根据不同的部署使用不同的设置;通过这种办法,可以让其他开发人员更容易找到相关的参数,因为它是一个用于设置这种参数的标准位置。
配置Spring,必须需要
里指定相应的xml文件名,如果有多个xml文件,可以写在一起并以“,”号分隔,比如在business-client工程中,我们采用了自定义配置方式,
对应工程目录结构如下所示:
部署在同一容器中的多个Web项目,要配置不同的webAppRootKey,web.xml文件中最好定义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为
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里用空格分隔写入,如:
多个配置文件里的交叉引用可以用ref的external或bean解决,例如:
applicationContext.xml
dbBean在applicationContext-database.xml中。
范例:
此所设定的参数,在JSP网页中可以使用下列方法来取得:
${initParam.param_name}
若在Servlet可以使用下列方法来获得:
String param_name=getServletContext().getInitParamter("param_name");
Servlet的ServletConfig对象拥有该Servlet的ServletContext的一个引用,所以可这样取得上下文初始化参数:getServletConfig().getServletContext().getInitParameter()也可以在Servlet中直接调用getServletContext().getInitParameter(),两者是等价的。
<session-config> 用于设置容器的session参数,比如:<session-timeout>用于指定http session的失效时间。默认时间设置在
1. Listener介绍:
2. Listener配置:
配置Listener只要向Web应用注册Listener实现类即可,无序配置参数之类的东西,因为Listener获取的是Web应用ServletContext(application)的配置参数。为Web应用配置Listener的两种方式:
l 使用@WebListener修饰Listener实现类即可。
l 在web.xml文档中使用进行配置。
我们选择web.xml这种配置方式,只有一个元素指定Listener的实现类,如下所示:
这里的
1) 利用ServletContextListener实现:
2) 采用load-on-startup Servlet 实现:
我们选择了第二种方式,在J2EE工程中web服务器启动的时候最先调用web.xml,上面这段配置的意思是加载spring的监听器,其中ContextLoaderListener的作用就是启动Web容器时,自动装配applicationContext.xml的配置信息,执行它所实现的方法。
1. 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只需两步:
Filter必须实现javax.servlet.Filter接口,在该接口中定义了三个方法:
2. Filter配置:
Filter可认为是Servlet的“增强版”,因此Filter配置与Servlet的配置非常相似,需要配置两部分:配置Filter名称和Filter拦截器URL模式。区别在于Servlet通常只配置一个URL,而Filter可以同时配置多个请求的URL。配置Filter有两种方式:
l 在Filter类中通过Annotation进行配置。
l 在web.xml文件中通过配置文件进行配置。
我们使用的是web.xml这种配置方式,下面重点介绍内包含的一些元素。
用于指定Web容器中的过滤器,可包含 、 、 、 、 、 。
l-name>用来定义过滤器的名称,该名称在整个程序中都必须唯一。
l元素指定过滤器类的完全限定的名称,即Filter的实现类。
l为Filter配置参数,与 具有相同的元素描述符 和 。
l元素用来声明Web应用中的过滤器映射,过滤器被映射到一个servlet或一个URL 模式。这个过滤器的 和 必须具有相同的 ,指定该Filter所拦截的URL。过滤是按照部署描述符的 出现的顺序执行的。
1) 字符集过滤器
- <filter>
- <filter-name>CharacterEncodingFilterfilter-name>
- <filter-class>org.springframework.web.filter.CharacterEncodingFilterfilter-class>
- <init-param>
- <param-name>encodingparam-name>
- <param-value>UTF-8param-value>
- init-param>
- <init-param>
- <param-name>forceEncodingparam-name>
- <param-value>trueparam-value>
- init-param>
- filter>
- <filter-mapping>
- <filter-name>CharacterEncodingFilterfilter-name>
- <url-pattern>/*url-pattern>
- filter-mapping>
CharacterEncodingFilter类可以通过简单配置来帮我们实现字符集转换的功能,参数encoding用于指定编码类型,参数forceEncoding设为true时,强制执行request.setCharacterEncoding(this.encoding)和reponse.setCharacterEncoding(this.encoding)中的方法。
2) 缓存控制
- <filter>
- <filter-name>NoCache Filterfilter-name>
- <filter-class>com.yonyou.mcloud.cas.client.authentication.NoCacheFilterfilter-class>
- filter>
- <filter-mapping>
- <filter-name>NoCache Filterfilter-name>
- >
- <url-pattern>/*url-pattern>
- filter-mapping>
3) 登录认证
- <filter>
- <filter-name>CAS Authentication Filterfilter-name>
- <filter-class>com.yonyou.mcloud.cas.client.authentication.ExpandAuthenticationFilterfilter-class>
- <init-param>
- <param-name>casServerLoginUrlparam-name>
- <param-value>https://dev.yonyou.com:443/sso-server/loginparam-value>
- init-param>
- <init-param>
- <param-name>serverNameparam-name>
- <param-value>http://10.1.215.40:80param-value>
- init-param>
- filter>
- <filter-mapping>
- <filter-name>CAS Authentication Filterfilter-name>
- <url-pattern>/*url-pattern>
- filter-mapping>
登录认证,未登录用户导向CAS Server进行认证。
4) 单点登出
- <filter>
- <filter-name>CAS Single Sign Out Filterfilter-name>
- <filter-class>org.jasig.cas.client.session.SingleSignOutFilterfilter-class>
- filter>
- <filter-mapping>
- <filter-name>CAS Single Sign Out Filterfilter-name>
- <url-pattern>/*url-pattern>
- filter-mapping>
- <listener>
- <listener-class>org.jasig.cas.client.session.SingleSignOutHttpSessionListenerlistener-class>
- listener>
CAS Server通知CAS Client,删除session,注销登录信息。
5) 封装request
- <filter>
- <filter-name>CAS HttpServletRequest Wrapper Filterfilter-name>
- <filter-class>org.jasig.cas.client.util.HttpServletRequestWrapperFilterfilter-class>
- filter>
- <filter-mapping>
- <filter-name>CAS HttpServletRequest Wrapper Filterfilter-name>
- <url-pattern>/*url-pattern>
- filter-mapping>
封装request, 支持getUserPrincipal等方法。
6) 存放Assertion到ThreadLocal中
- <filter>
- <filter-name>CAS Assertion Thread Local Filterfilter-name>
- <filter-class>org.jasig.cas.client.util.AssertionThreadLocalFilterfilter-class>
- filter>
- <filter-mapping>
- <filter-name>CAS Assertion Thread Local Filterfilter-name>
- <url-pattern>/*url-pattern>
- filter-mapping>
7) 禁用浏览器缓存
- <filter>
- <filter-name>NoCache Filterfilter-name>
- <filter-class>com.yonyou.mcloud.cas.client.authentication.NoCacheFilterfilter-class>
- filter>
- <filter-mapping>
- <filter-name>NoCache Filterfilter-name>
- <url-pattern>/*url-pattern>
- filter-mapping>
8) CAS Client向CAS Server进行ticket验证
- <filter>
- <filter-name>CAS Validation Filterfilter-name>
- <filter-class>org.jasig.cas.client.validation.Cas20ProxyReceivingTicketValidationFilterfilter-class>
- <init-param>
- <param-name>casServerUrlPrefixparam-name>
- <param-value>https://dev.yonyou.com:443/sso-serverparam-value>
- init-param>
- <init-param>
- <param-name>serverNameparam-name>
- <param-value>http://10.1.215.40:80param-value>
- init-param>
- <init-param>
- <param-name>proxyCallbackUrlparam-name>
- <param-value>https://dev.yonyou.com:443/business/proxyCallbackparam-value>
- init-param>
- <init-param>
- <param-name>proxyReceptorUrlparam-name>
- <param-value>/proxyCallbackparam-value>
- init-param>
- <init-param>
- <param-name>proxyGrantingTicketStorageClassparam-name>
- <param-value>com.yonyou.mcloud.cas.client.proxy.MemcachedBackedProxyGrantingTicketStorageImplparam-value>
- init-param>
- <init-param>
- <param-name>encodingparam-name>
- <param-value>UTF-8param-value>
- init-param>
- filter>
- <filter-mapping>
- <filter-name>CAS Validation Filterfilter-name>
- <url-pattern>/proxyCallbackurl-pattern>
- filter-mapping>
- <filter-mapping>
- <filter-name>CAS Validation Filterfilter-name>
- <url-pattern>/*url-pattern>
- filter-mapping>
- <servlet>
- <servlet-name>businessservlet-name>
- <servlet-class>org.springframework.web.servlet.DispatcherServletservlet-class>
- <init-param>
- <param-name>publishContextparam-name>
- <param-value>falseparam-value>
- init-param>
- <load-on-startup>1load-on-startup>
- servlet>
- <servlet>
- <servlet-name>LogOutServletservlet-name>
- <servlet-class>com.yonyou.mcloud.cas.web.servlet.LogOutServletservlet-class>
- <init-param>
- <param-name>serverLogoutUrlparam-name>
- <param-value>https://dev.yonyou.com:443/sso-server/logoutparam-value>
- init-param>
- <init-param>
- <param-name>serverNameparam-name>
- <param-value>http://10.1.215.40:80/business/param-value>
- init-param>
- servlet>
- <servlet-mapping>
- <servlet-name>LogOutServletservlet-name>
- <url-pattern>/logouturl-pattern>
- servlet-mapping>
- <servlet-mapping>
- <servlet-name>businessservlet-name>
- <url-pattern>/url-pattern>
- servlet-mapping>
Servlet通常称为服务器端小程序,是运行在服务器端的程序,用于处理及响应客户的请求。Servlet是个特殊的java类,继承于HttpServlet。客户端通常只有GET和POST两种请求方式,Servlet为了响应则两种请求,必须重写doGet()和doPost()方法。大部分时候,Servlet对于所有的请求响应都是完全一样的,此时只需要重写service()方法即可响应客户端的所有请求。
另外HttpServlet有两个方法
通常无需重写init()和destroy()两个方法,除非需要在初始化Servlet时,完成某些资源初始化的方法,才考虑重写init()方法,如果重写了init()方法,应在重写该方法的第一行调用super.init(config),该方法将调用HttpServlet的init()方法。如果需要在销毁Servlet之前,先完成某些资源的回收,比如关闭数据库连接,才需要重写destory方法()。
Servlet的生命周期:
创建Servlet实例有两个时机:
每个Servlet的运行都遵循如下生命周期:
为了让Servlet能响应用户请求,还必须将Servlet配置在web应用中,配置Servlet需要修改web.xml文件。
从Servlet3.0开始,配置Servlet有两种方式:
我们用web.xml文件来配置Servlet,需要配置
java.lang.String.getInitParameter(java.lang.String name):用于获取初始化参数
ServletConfig获取配置参数的方法和ServletContext获取配置参数的方法完全一样,只是ServletConfig是取得当前Servlet的配置参数,而ServletContext是获取整个Web应用的配置参数。
如果load-on-startup元素存在,而且也指定了jsp-file元素,则JSP文件会被重新编译成Servlet,同时产生的Servlet也被载入内存。
举个例子:如果有两个Servlet元素都含有
容器的Context对象对请求路径(URL)做出处理,去掉请求URL的上下文路径后,按路径映射规则和Servlet映射路径(
- <servlet>
- <servlet-name>businessservlet-name>
- <servlet-class>org.springframework.web.servlet.DispatcherServletservlet-class>
- <init-param>
- <param-name>publishContextparam-name>
- <param-value>falseparam-value>
- init-param>
- <load-on-startup>1load-on-startup>
- servlet>
配置Spring MVC,指定处理请求的Servlet,有两种方式:
l 默认查找MVC配置文件的地址是:/WEB-INF/${servletName}-servlet.xml
l 可以通过配置修改MVC配置文件的位置,需要在配置DispatcherServlet时指定MVC配置文件的位置。
我们在平台项目两个工程中分别使用了不同的配置方式,介绍如下:
我们在business-client工程中按照默认方式查找MVC的配置文件,配置文件目录为: /WEB-INF/business-servlet.xml。工程目录结构如下所示:
我们在public-base-server工程中,通过第2种方式进行配置,把spring-servlet.xml放到src/main/resources/config/spring-servlet.xml,则需要在配置DispatcherServlet时指定标签。具体代码如下:
- <servlet>
- <servlet-name>springservlet-name>
- <servlet-class>org.springframework.web.servlet.DispatcherServletservlet-class>
- <init-param>
- <param-name>publishContextparam-name>
- <param-value>falseparam-value>
- init-param>
- <init-param>
- <param-name>contextConfigLocationparam-name>
- <param-value>classpath:config/spring-servlet.xmlparam-value>
- init-param>
- <load-on-startup>1load-on-startup>
- servlet>
工程目录结构如下:
其中,classpath是web项目的类路径,可以理解为classes下面。因为无论这些配置文件放在哪,编译之后如果没有特殊情况的话都直接在classes下面。jar包的话虽然放在lib文件夹里,但实际上那些类可以直接引用,比如:com.test.ABC,仿佛也在classes下面一样。
在我们的工程里,经过验证,maven工程这两个
路径经过编译后生成的文件都位于classes目录下,即这两个路径相当于类路径,在下面创建config文件夹(folder),然后创建自定义的xml配置文件即可。
classpath和classpath*区别:
同名资源存在时,classpath只从第一个符合条件的classpath中加载资源,而classpath*会从所有的classpath中加载符合条件的资源。classpath*,需要遍历所有的classpath,效率肯定比不上classpath,因此在项目设计的初期就尽量规划好资源文件所在的路径,避免使用classpath*来加载。
从上图可以看出,ContextLoaderListener初始化的上下文加载的Bean是对于整个应用程序共享的,一般如:DAO层、Service层Bean;DispatcherServlet初始化的上下文加载的Bean是只对Spring MVC有效的Bean,如:Controller、HandlerMapping、HandlerAdapter等,该初始化上下文只加载Web相关组件。
注意:用户可以配置多个DispatcherServlet来分别处理不同的url请求,每个DispatcherServlet上下文都对应一个自己的子Spring容器,他们都拥有相同的父Spring容器(业务层,持久(dao)bean所在的容器)。
- <welcome-file-list>
- <welcome-file>index.htmlwelcome-file>
- welcome-file-list>
包含一个子元素 , 用来指定首页文件名称。 元素可以包含一个或多个 子元素。如果在第一个 元素中没有找到指定的文件,Web容器就会尝试显示第二个,以此类推。