spring MVC——拦截器实现登录检测和性能监控

1. 拦截器简介

Spring MVC中的拦截器，类似于Servlet开发中的过滤器Filter，主要用来拦截用户的请求并进行相应的处理，可以用来做日志记录、权限验证或者登陆检测。

（1） 常见的应用场景

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

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

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

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

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

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

（2） 拦截器的接口

public interface HandlerInterceptor {

    boolean preHandle(
            HttpServletRequest request, HttpServletResponse response,
            Object handler)
            throws Exception;

    void postHandle(
            HttpServletRequest request, HttpServletResponse response,
            Object handler, ModelAndView modelAndView)
            throws Exception;

    void afterCompletion(
            HttpServletRequest request, HttpServletResponse response,
            Object handler, Exception ex)
            throws Exception;
}

有3个方法，下面是这些方法的说明：

preHandle：预处理回调方法，实现处理器的预处理（如登录检查），第三个参数为响应的处理器（Controller）；返回值：true表示继续流程（如调用下一个拦截器或处理器）；

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

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

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

（3） 拦截器适配器

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

public abstract class HandlerInterceptorAdapter implements AsyncHandlerInterceptor {

    public HandlerInterceptorAdapter() {
    }

    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        return true;
    }

    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
    }

    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
    }

    public void afterConcurrentHandlingStarted(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
    }

}

2、登录检测

在访问某些资源时，需要用户登录后才能查看，因此需要进行登录检测。

流程：

1、访问需要登录的资源时，由拦截器重定向到登录页面；

2、如果访问的是登录页面，拦截器不应该拦截；

3、用户登录成功后，往cookie/session添加登录成功的标识（如用户编号）；

4、下次请求时，拦截器通过判断cookie/session中是否有该标识来决定继续流程还是到登录页面；

5、在此拦截器还应该允许游客访问的资源。

拦截器实现：

package com.etc.interceptor;

import org.springframework.web.servlet.AsyncHandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

public class LoginCheckInterceptor extends HandlerInterceptorAdapter{
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        //1、如果用户已经登录 放行
        if(request.getSession().getAttribute("user") != null){
            return true;
        }else {
            //2、非法请求 即这些请求需要登录后才能访问,重定向到登录页面
            response.sendRedirect(request.getContextPath()+"/login");
            return false;
        }
    }
}

拦截器配置：   

3、性能监控

如何记录请求的处理时间，得到一些慢请求（如处理时间超过500毫秒），从而进行性能改进，我们来看如何使用拦截器来实现。

实现分析：

1.在进入处理器之前记录开始时间，即在拦截器的preHandle记录开始时间；

2.在结束请求处理之后记录结束时间，即在拦截器的afterCompletion记录结束实现，并用结束时间-开始时间得到这次请求的处理时间。

问题：

我们的拦截器是单例，因此不管用户请求多少次都只有一个拦截器实现，即线程不安全，那我们应该怎么记录时间呢？

解决方案：

使用ThreadLocal，它是线程绑定的变量，提供线程局部变量（一个线程一个ThreadLocal，A线程的ThreadLocal只能看到A线程的ThreadLocal，不能看到B线程的ThreadLocal）。

Spring提供的一个命名的ThreadLocal实现（NamedThreadLocal）。

拦截器实现：

package com.etc.interceptor;

import org.springframework.core.NamedThreadLocal;
import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

public class PerformanceMonitorInterceptor extends HandlerInterceptorAdapter{

    private NamedThreadLocal threadLocal = new NamedThreadLocal<>("PerformanceMonitor");

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        //请求开始时间
        long startTime = System.currentTimeMillis();
        //线程绑定变量（该数据只有当前请求的线程可见）
        threadLocal.set(startTime);
        return true;
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        //请求结束时间
        long endTime = System.currentTimeMillis();
        //获取线程绑定的局部变量（开始时间）
        long startTime = threadLocal.get();
        long elapse = endTime - startTime;
        //为了测试只要大于0就记录，一般设置为一个比较大的数，比如300，代表300毫秒
        if(elapse > 0){
            System.out.println(String.format("%s elapse %d 毫秒", request.getRequestURI(), elapse));
        }

    }
}

拦截器配置：

在配置时将该拦截器放在拦截器链的第一个，这样得到的时间才是比较准确。

测试：

4. Spring MVC中的拦截器和Servlet中的过滤器的区别

（1） 拦截器是基于Java的反射机制的，而过滤器是JavaEE标准，基于函数回调

（2） 拦截器不依赖于Servlet容器，过滤器依赖于Servlet容器。

（3） 拦截器可以获取IOC容器中的各个bean，而过滤器就不行，在拦截器里注入一个Service，可以调用业务逻辑。

5. 总结

推荐能使用Servlet规范中的过滤器Filter实现的功能就用Filter实现，因为HandlerInteceptor只有在Spring MVC环境下才能使用，因此Filter是最通用的、最先应该使用的。比如如登录检测拦截器最好使用Filter来实现。