拦截器(Interceptor)同 Filter 过滤器一样,它俩都是面向切面编程——AOP 的具体实现(AOP切面编程只是一种编程思想而已)。
你可以使用 Interceptor 来执行某些任务,例如在 Controller 处理请求之前编写日志,添加或更新配置…
在 Spring中,当请求发送到 Controller 时,在被Controller处理之前,它必须经过 Interceptors(0或多个)。
Spring Interceptor是一个非常类似于Servlet Filter 的概念 。
Java中的拦截器是动态拦截 action调用的对象,然后提供了可以在action执行前后增加一些 操作,也可以在action执行前停止操作。其实拦截器也可以做和过滤器同样的操作,以下是拦截器的常用场景。
登录认证:在一些简单应用中,可能会通过拦截器来验证用户的登录状态,如果没有登录或者登录失效,就会给用户一个友好的提示或者返回登录页面。
记录系统日志:在Web应用中,通常需要记录用户的请求信息,比如请求的IP、方法执行时 常等,通过这些记录可以监控系统的状况,以便于对系统进行信息监控、信息统计、计算PV (PageView)和性能调优等。
通用处理:在应用程序中可能存在所有方法都要返回的信息,这时可以使用拦截器来实现 省去每个方法冗余重复的代码实现。
日志记录:记录请求信息的日志,以便进行信息监控、信息统计、计算 PV(Page View)等;
权限检查:如登录检测,进入处理器检测是否登录;
性能监控:通过拦截器在进入处理器之前记录开始时间,在处理完后记录结束时间,从而得到该请求的处理时间。(反向代理,如 Apache也可以自动记录)
通用行为:读取 Cookie 得到用户信息并将用户对象放入请求,从而方便后续流程使用,还有如提取 Locale、Theme 信息等,只要是多个处理器都需要的即可使用拦截器实现。
这里以使用Spring拦截器为例,在类上需要实现HandlerInterceptor类,并且重写类中的3个方法,分别是:
preHandle:控制器方法请求之前执行,在业务处理器处理请求之前被调用,方法在请求处理之前被调用。该方法在 Interceptor 类中最先执行,用来进行一些前置初始化操作或是对当前请求做预处理,也可以进行一些判断来决定请求是否要继续进行下去。该方法的返回至是 Boolean 类型,当它返回 false 时,表示请求结束,后续的 Interceptor 和 Controller 都不会再执行;当它返回为 true 时会继续调用下一个 Interceptor 的 preHandle 方法,如果已经是最后一个 Interceptor 的时候就会调用当前请求的 Controller 方法。
postHandle:控制器方法请求执行完成之后执行,在业务处理器处理请求执行完成后、生成视图前执行。方法在当前请求处理完成之后,也就是 Controller 方法调用之后执行,但是它会在 DispatcherServlet 进行视图返回渲染之前被调用,所以我们可以在这个方法中对 Controller 处理之后的 ModelAndView 对象进行操作。
afterCompletion:处理完视图和模型数据,渲染视图完毕之后执行,在DispatcherServlet完全处理请求后被调用,通常用于记录消耗时间,也可以进行一些资源处理操作。方法需要在当前对应的 Interceptor 类的 postHandler 方法返回值为 true 时才会执行。顾名思义,该方法将在整个请求结束之后,也就是在 DispatcherServlet 渲染了对应的视图之后执行。此方法主要用来进行资源清理。
自定义拦截器有一下两种方式:
实现 org.springframework.web.servlet.HandlerInterceptor接口 继承 org.springframework.web.servlet.handler.HandlerInterceptorAdapter类 如记录一下请求的处理时间,得到一些慢请求(如处理时间超过500毫秒),从而进行性能改进,一般的反向代理服务器如 apache 都具有这个功能,但此处我们演示一下使用拦截器怎么实现。
1、在进入处理器之前记录开始时间,即在拦截器的 preHandle 记录开始时间;
2、在结束请求处理之后记录结束时间,即在拦截器的 afterCompletion 记录结束实现,并用结束时间-开始时间得到这次请求的处理时间。 3、在测试时需要把 stopWatchHandlerInterceptor 放在拦截器链的第一个,这样得到的时间才是比较准确的。
我们的拦截器是单例,因此不管用户请求多少次都只有一个拦截器实现,即线程不安全,那我们应该怎么记录时间呢?
比如一个A发送了请求浏览器开始计时为时间为1:31分,这个控制器方法中操作的方法比较多,执行完方法会慢一点,然后B发送请求时间已经到1:32分开始计时,他的控制器方法操作的方法比较少,很快就执行完了,用了1分钟,所以A的开始时间已经被32分给覆盖了,所以A执行完后所用的时间是不对的。
解决方案是使用 ThreadLocal,它是线程绑定的变量,提供线程局部变量(一个线程一个 ThreadLocal,A线程的ThreadLocal 只能看到A线程的 ThreadLocal,不能看到B线程的 ThreadLocal),一个请求创建一个对象不会影响到其他请求,所以时间不会混乱。
/**
* 配置拦截器
*/
public class MyInterceptor implements HandlerInterceptor {
//NamedThreadLocal:Spring提供的一个命名的ThreadLocal实现。线程安全的,每进来一个请求都会创建一个单独的对象,其他用户不会收到影响
//ThreadLocal,它是线程绑定的变量,提供线程局部变量(一个线程一个 ThreadLocal,A线程的ThreadLocal 只能看到A线程的 ThreadLocal,不能看到B线程的 ThreadLocal)
//一个请求创建一个对象不会影响到其他请求,所以时间不会混乱
private NamedThreadLocal startTimeThreadLocal = new NamedThreadLocal<>("StopWatch-StartTime");
//日志对象,
private Logger logger = LoggerFactory.getLogger(MyInterceptor.class);
//控制器方法执行之前执行
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
long beginTime = System.currentTimeMillis();//1、开始时间
startTimeThreadLocal.set(beginTime);//线程绑定变量(该数据只有当前请求的线程可见)
return true;//继续流程
}
//控制器方法执行以后执行
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
//HandlerInterceptor.super.postHandle(request, response, handler, modelAndView);
}
//处理完视图和模型数据,渲染视图完毕之后执行afterCompletion()
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
long endTime = System.currentTimeMillis();//2、结束时间
long beginTime = startTimeThreadLocal.get();//得到线程绑定的局部变量(开始时间)
long consumeTime = endTime - beginTime;//3、消耗的时间
System.out.println("开始时间:"+beginTime);
System.out.println("结束时间:"+endTime);
System.out.println("消耗时间:"+consumeTime);
if(consumeTime > 500) {//此处认为处理时间超过500毫秒的请求为慢请求
//TODO 记录到日志文件 设置日志
logger.info(String.format("%s consume %d millis", request.getRequestURI(), consumeTime));
} else {
// 测试的时候由于请求时间未超过500,所以启用该代码
//request.getRequestURI():请求路径:/test/filter
//consumeTime:销毁时间
// 日志打印:/test/filter consume 13 millis
logger.info(String.format("%s consume %d millis", request.getRequestURI(), consumeTime));
}
}
}
/**
* 拦截器配置
*/
@Configuration
public class WebConfig implements WebMvcConfigurer {
@Override
public void addInterceptors(InterceptorRegistry registry) {
// registry.addInterceptor(拦截器类).addPathPatterns("路径路径");
registry.addInterceptor(new MyInterceptor()).addPathPatterns("/test/*");
}
}
controller层测试:
@RestController
@RequestMapping("/test")
public class FilterController {
@RequestMapping(value = "filter")
public String filter1(){
return "成功";
}
}