spring 拦截器

参考网址：

http://sishuok.com/forum/blogPost/list/5934.html

只截取部分内容，查看完成请前往原网址

、常见应用场景

1、日志记录：记录请求信息的日志，以便进行信息监控、信息统计、计算PV（PageView）等。

2、权限检查：如登录检测，进入处理器检测检测是否登录，如果没有直接返回到登录页面；

3、性能监控：有时候系统在某段时间莫名其妙的慢，可以通过拦截器在进入处理器之前记录开始时间，在处理完后记录结束时间，从而得到该请求的处理时间（如果有反向代理，如apache可以自动记录）；

4、通用行为：读取cookie得到用户信息并将用户对象放入请求，从而方便后续流程使用，还有如提取Locale、Theme信息等，只要是多个处理器都需要的即可使用拦截器实现。

5、OpenSessionInView：如Hibernate，在进入处理器打开Session，在完成后关闭Session。

…………本质也是AOP（面向切面编程），也就是说符合横切关注点的所有功能都可以放入拦截器实现

5.1.2、拦截器接口

java代码：

packageorg.springframework.web.servlet;

publicinterfaceHandlerInterceptor{

booleanpreHandle(

HttpServletRequestrequest,HttpServletResponseresponse,

Objecthandler)

throwsException;

voidpostHandle(

HttpServletRequestrequest,HttpServletResponseresponse,

Objecthandler,ModelAndViewmodelAndView)

throwsException;

voidafterCompletion(

HttpServletRequestrequest,HttpServletResponseresponse,

Objecthandler,Exceptionex)

throwsException;

}

preHandle：预处理回调方法，实现处理器的预处理（如登录检查），第三个参数为响应的处理器（如我们上一章的Controller实现）；

返回值：true表示继续流程（如调用下一个拦截器或处理器）；

false表示流程中断（如登录检查失败），不会继续调用其他的拦截器或处理器，此时我们需要通过response来产生响应；

postHandle：后处理回调方法，实现处理器的后处理（但在渲染视图之前），此时我们可以通过modelAndView（模型和视图对象）对模型数据进行处理或对视图进行处理，modelAndView也可能为null。

afterCompletion：整个请求处理完毕回调方法，即在视图渲染完毕时回调，如性能监控中我们可以在此记录结束时间并输出消耗时间，还可以进行一些资源清理，类似于try-catch-finally中的finally，但仅调用处理器执行链中preHandle返回true的拦截器的afterCompletion。

5.1.3、拦截器适配器

有时候我们可能只需要实现三个回调方法中的某一个，如果实现HandlerInterceptor接口的话，三个方法必须实现，不管你需不需要，此时spring提供了一个HandlerInterceptorAdapter适配器（一种适配器设计模式的实现），允许我们只实现需要的回调方法。

java代码：

publicabstractclassHandlerInterceptorAdapterimplementsHandlerInterceptor{

//省略代码此处所以三个回调方法都是空实现，preHandle返回true。

}

接下来看一下DispatcherServlet内部到底是如何工作的吧：

java代码：

//doDispatch方法

//1、处理器拦截器的预处理（正序执行）

HandlerInterceptor[]interceptors=mappedHandler.getInterceptors();

if(interceptors!=null){

for(inti=0;i<interceptors.length;i++){

HandlerInterceptorinterceptor=interceptors[i];

if(!interceptor.preHandle(processedRequest,response,mappedHandler.getHandler())){

//1.1、失败时触发afterCompletion的调用

triggerAfterCompletion(mappedHandler,interceptorIndex,processedRequest,response,null);

return;

}

interceptorIndex=i;//1.2、记录当前预处理成功的索引

}

}

//2、处理器适配器调用我们的处理器

mv=ha.handle(processedRequest,response,mappedHandler.getHandler());

//当我们返回null或没有返回逻辑视图名时的默认视图名翻译（详解4.15.5RequestToViewNameTranslator）

if(mv!=null&&!mv.hasView()){

mv.setViewName(getDefaultViewName(request));

}

//3、处理器拦截器的后处理（逆序）

if(interceptors!=null){

for(inti=interceptors.length-1;i>=0;i--){

HandlerInterceptorinterceptor=interceptors[i];

interceptor.postHandle(processedRequest,response,mappedHandler.getHandler(),mv);

}

}

//4、视图的渲染

if(mv!=null&&!mv.wasCleared()){

render(mv,processedRequest,response);

if(errorView){

WebUtils.clearErrorRequestAttributes(request);

}

//5、触发整个请求处理完毕回调方法afterCompletion

triggerAfterCompletion(mappedHandler,interceptorIndex,processedRequest,response,null);

注：以上是流程的简化代码，中间省略了部分代码，不完整。

java代码：

//triggerAfterCompletion方法

privatevoidtriggerAfterCompletion(HandlerExecutionChainmappedHandler,intinterceptorIndex,

HttpServletRequestrequest,HttpServletResponseresponse,Exceptionex)throwsException{

//5、触发整个请求处理完毕回调方法afterCompletion（逆序从1.2中的预处理成功的索引处的拦截器执行）

if(mappedHandler!=null){

HandlerInterceptor[]interceptors=mappedHandler.getInterceptors();

if(interceptors!=null){

for(inti=interceptorIndex;i>=0;i--){

HandlerInterceptorinterceptor=interceptors[i];

try{

interceptor.afterCompletion(request,response,mappedHandler.getHandler(),ex);

}

catch(Throwableex2){

logger.error("HandlerInterceptor.afterCompletionthrewexception",ex2);

}

}

}

}

}

5.2.1、正常流程

（1、拦截器实现

java代码：

packagecn.javass.chapter5.web.interceptor;

//省略import

publicclassHandlerInterceptor1extendsHandlerInterceptorAdapter{//此处一般继承HandlerInterceptorAdapter适配器即可

@Override

publicbooleanpreHandle(HttpServletRequestrequest,HttpServletResponseresponse,Objecthandler)throwsException{

System.out.println("===========HandlerInterceptor1preHandle");

returntrue;

}

@Override

publicvoidpostHandle(HttpServletRequestrequest,HttpServletResponseresponse,Objecthandler,ModelAndViewmodelAndView)throwsException{

System.out.println("===========HandlerInterceptor1postHandle");

}

@Override

publicvoidafterCompletion(HttpServletRequestrequest,HttpServletResponseresponse,Objecthandler,Exceptionex)throwsException{

System.out.println("===========HandlerInterceptor1afterCompletion");

}

}

以上是HandlerInterceptor1实现，HandlerInterceptor2同理只是输出内容为“HandlerInterceptor2”。

（2、控制器

java代码：

packagecn.javass.chapter5.web.controller;

//省略import

publicclassTestControllerimplementsController{

@Override

publicModelAndViewhandleRequest(HttpServletRequestreq,HttpServletResponseresp)throwsException{

System.out.println("===========TestController");

returnnewModelAndView("test");

}

}

（3、Spring配置文件chapter5-servlet.xml

java代码：

<beanname="/test"class="cn.javass.chapter5.web.controller.TestController"/>

<beanid="handlerInterceptor1"

class="cn.javass.chapter5.web.interceptor.HandlerInterceptor1"/>

<beanid="handlerInterceptor2"

class="cn.javass.chapter5.web.interceptor.HandlerInterceptor2"/>

java代码：

<beanclass="org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping">

<propertyname="interceptors">

<list>

<refbean="handlerInterceptor1"/>

<refbean="handlerInterceptor2"/>

</list>

</property>

</bean>

另一种配置方式

<mvc:interceptors>

<mvc:interceptor>

<!--设置拦截的路径-->

<mvc:mappingpath="/login1.htm"/>

<mvc:mappingpath="/login2.htm"/>

<beanclass="com.yjde.web.interceptor.TimeInterceptor">

<!--继承拦截器类的参数设置property-->

<!--openingTime属性指定上班时间-->

<propertyname="openingTime">

<value>12</value>

</property>

<!--closingTime属性指定下班时间-->

<propertyname="closingTime">

<value>14</value>

</property>

<!--outsideOfficeHoursPage属性指定提示页面的URL-->

<propertyname="outsideOfficeHoursPage">

<value>http://localhost:8080/SpringMVCInterceptor/jsp/outsideOfficeHours.jsp

</value>

</property>

</bean>

</mvc:interceptor>

</mvc:interceptors>