Spring Boot拦截器详解（附带实例）

拦截器在 Web 系统中非常常见，一般用于拦截用户请求，实现访问权限控制、日志记录、敏感过滤等功能。

拦截器在实际的应用开发中非常常见，对于某些全局统一的操作，我们可以把它提取到拦截器中实现。总结起来，拦截器大致有以下几种使用场景：

权限检查：如登录检测，进入处理程序检测是否登录，如果没有，则直接返回登录页面。
性能监控：有时系统在某段时间莫名其妙很慢，可以通过拦截器在进入处理程序之前记录开始时间，在处理完后记录结束时间，从而得到该请求的处理时间（如果有反向代理，如 Apache，可以自动记录）。
通用行为：读取 cookie 得到用户信息并将用户对象放入请求，从而方便后续流程使用，还有提取Locale、Theme信息等，只要是多个处理程序都需要的，即可使用拦截器实现。
OpenSessionInView：如 Hibernate，在进入处理程序时打开 Session（会话），在完成后关闭 Session。

Spring Boot 定义了 HandlerInterceptor 接口来实现自定义拦截器的功能。

HandlerInterceptor 接口定义了 preHandle、postHandle、afterCompletion 三种方法，通过重写这三种方法实现请求前、请求后等操作：

preHandle：预处理回调方法实现处理程序的预处理（如登录检查），第三个参数为响应的处理程序。返回值为 true 表示继续流程（如调用下一个拦截器或处理程序）；返回值为 false 表示流程中断（如登录检查失败），不会继续调用其他的拦截器或处理程序，此时需要通过 response 来产生响应；
postHandle：后处理回调方法，实现处理程序的后处理（但在渲染视图之前），此时可以通过 modelAndView（模型和视图对象）对模型数据进行处理或对视图进行处理，modelAndView 也可能为 null；
afterCompletion：整个请求处理完之后回调方法，即在视图渲染完毕时回调，如在性能监控中，可以在此记录结束时间并输出消耗时间，还可以进行一些资源清理，类似于 try-catch-finally 中的 finally，但是只调用处理程序执行 preHandle，返回 true 所对应的拦截器的 afterCompletion。

有时我们只需要实现 3 种回调方法之一，如果实现 HandlerInterceptor 接口，则无论是否需要 3 种方法都必须实现，此时 Spring 提供了一个 HandlerInterceptorAdapter 适配器（一种适配器设计模式的实现），允许我们只实现需要的回调方法。

HandlerInterceptor实现拦截器

我们在访问某些需要授权的页面，如订单详情、订单列表等需要用户登录后才能查看的功能时，需要对这些请求拦截，进行登录检测，符合规则的才允许请求通过。接下来通过登录状态检测的例子演示拦截器的使用。

首先，创建自定义登录拦截器，示例代码如下：

public class LoginInterceptor implements HandlerInterceptor {
    /*注册拦截器*/
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
            throws Exception {
        Object user = request.getSession().getAttribute("user");
        if (user == null){
            request.setAttribute("msg","您没有权限这么做！");
            request.getRequestDispatcher("/").forward(request,response);
            return false;
        }
        return true;
    }
}

在上面的示例中，LoginInterceptor 继承 HandlerInterceptor 接口，实现 preHandle 接口，验证用户的 Session 状态。如果当前用户有登录信息，则可以继续访问；如果当前用户没有登录信息，则返回无权限。

然后，将拦截器注入系统配置。定义 MyMvcConfig 配置类，将上面定义的 LoginInterceptor 拦截器注入系统中，示例代码如下：

@Configuration
public class MyMvcConfig implements WebMvcConfigurer {
   @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LoginInterceptor())
        .addPathPatterns("/**").excludePathPatterns("/",
        "/user/login","/asserts/**","/webjars/**");
    }
}

通过 WebMvcConfigurer 类的 addInterceptors 方法将刚刚自定义的 LoginInterceptor 拦截器注入系统中；
addPathPatterns 定义拦截的请求地址；
excludePathPatterns 的作用是排除某些地址不被拦截，例如登录地址 /user/login 不需要进行登录验证。

Spring Boot拦截器详解（附带实例）

HandlerInterceptor实现拦截器

相关文章