【第二十篇】Spring Boot中使用拦截器

1.1 概述

拦截器的原理很简单,是 AOP的一种实现,专门拦截对动态资源的后台请求,即拦截对控制层的请求。使用场景比较多的是判断用户是否有权限请求后台,更拔高一层的使用场景也有,比如拦截器可以结合websocket一起使用,用来拦截 websocket请求,然后做相应的处理等等。拦截器不会拦截静态资源,Spring Boot的默认静态目录为resources/static,该目录下的静态页面、js、css、图片等等,不会被拦截(也要看如何实现,有些情况也会拦截,我在下文会指出)。

1.2 拦截器的快速使用

使用拦截器很简单,只需要两步即可:定义拦截器和配置拦截器。在配置拦截器中,Spring Boot 2.0 以后的版本和之前的版本有所不同,我会重点讲解一下这里可能出现的坑。

1.2.1 定义拦截器

定义拦截器,只需要实现HandlerInterceptor接口,HandlerInterceptor 接口是所有自定义拦截器或者 Spring Boot 提供的拦截器的鼻祖,所以,首先来了解下该接口。该接口中有三个方法: preHandle(……)、postHandle(……) 和 afterCompletion(……)

preHandle(……)方法:该方法的执行时机是,当某个url已经匹配到对应的Controller中的某个方法,且在这个方法执行之前。所以 preHandle(……)方法可以决定是否将请求放行,这是通过返回值来决定的,返回 true 则放行,返回false 则不会向后执行。

postHandle(……)方法:该方法的执行时机是,当某个 url已经匹配到对应的Controller中的某个方法,且在执行完了该方法,但是在DispatcherServlet视图渲染之前。所以在这个方法中有个 ModelAndView参数,可以在此做一些修改动作。

afterCompletion(……)方法:顾名思义,该方法是在整个请求处理完成后(包括视图渲染)执行,这时做一些资源的清理工作,这个方法只有在 preHandle(……)被成功执行后并且返回 true才会被执行。

了解了该接口,接下来自定义一个拦截器。

/**
 * 自定义拦截器
 */
public class MyInterceptor implements HandlerInterceptor {

    private static final Logger logger = LoggerFactory.getLogger(MyInterceptor.class);

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {

        HandlerMethod handlerMethod = (HandlerMethod) handler;
        Method method = handlerMethod.getMethod();
        String methodName = method.getName();
        logger.info("====拦截到了方法:{},在该方法执行之前执行====", methodName);
        // 返回true才会继续执行,返回false则取消当前请求
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        logger.info("执行完方法之后进执行(Controller方法调用之后),但是此时还没进行视图渲染");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        logger.info("整个请求都处理完咯,DispatcherServlet也渲染了对应的视图咯,此时我可以做一些清理的工作了");
    }
}

OK,到此为止,拦截器已经定义完成,接下来就是对该拦截器进行拦截配置。

1.2.2 配置拦截器

Spring Boot 2.0之前,我们都是直接继承WebMvcConfigurerAdapter类,然后重写addInterceptors方法来实现拦截器的配置。但是在Spring Boot 2.0之后,该方法已经被废弃了(当然,也可以继续用),取而代之的是 WebMvcConfigurationSupport方法,如下:

@Configuration
public class MyInterceptorConfig extends WebMvcConfigurationSupport {

    @Override
    protected void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new MyInterceptor()).addPathPatterns("/**");
        super.addInterceptors(registry);
    }
}

在该配置中重写 addInterceptors方法,将我们上面自定义的拦截器添加进去,addPathPatterns方法是添加要拦截的请求,这里我们拦截所有的请求。这样就配置好拦截器了,接下来写一个 Controller测试一下:

@Controller
@RequestMapping("/interceptor")
public class InterceptorController {

    @RequestMapping("/test")
    public String test() {
        return "hello";
    }
}

让其跳转到hello.html 页面,直接在hello.html中输出 hello interceptor即可。启动项目,在浏览器中输入 localhost:8080/interceptor/test看一下控制台的日志:

====拦截到了方法:test,在该方法执行之前执行====  
执行完方法之后进执行(Controller方法调用之后),但是此时还没进行视图渲染  
整个请求都处理完咯,DispatcherServlet也渲染了对应的视图咯,此时我可以做一些清理的工作了

可以看出拦截器已经生效,并能看出其执行顺序。

1.2.3 解决静态资源被拦截问题

上文中已经介绍了拦截器的定义和配置,但是这样是否就没问题了呢?其实不然,如果使用上面这种配置的话,我们会发现一个缺陷,那就是静态资源被拦截了。可以在 resources/static/目录下放置一个图片资源或者html文件,然后启动项目直接访问,即可看到无法访问的现象。

也就是说,虽然 Spring Boot 2.0 废弃了WebMvcConfigurerAdapter,但是 WebMvcConfigurationSupport又会导致默认的静态资源被拦截,这就需要我们手动将静态资源放开。

如何放开呢?除了在 MyInterceptorConfig配置类中重写 addInterceptors方法外,还需要再重写一个方法:addResourceHandlers,将静态资源放开:

/**
 * 用来指定静态资源不被拦截,否则继承WebMvcConfigurationSupport这种方式会导致静态资源无法直接访问
 * @param registry
 */
@Override
protected void addResourceHandlers(ResourceHandlerRegistry registry) {
    registry.addResourceHandler("/**").addResourceLocations("classpath:/static/");
    super.addResourceHandlers(registry);
}

这样配置好之后,重启项目,静态资源也可以正常访问了。如果你是个善于学习或者研究的人,那肯定不会止步于此,没错,上面这种方式的确能解决静态资源无法访问的问题,但是,还有更方便的方式来配置。

我们不继承 WebMvcConfigurationSupport类,直接实现 WebMvcConfigurer接口,然后重写 addInterceptors方法,将自定义的拦截器添加进去即可,如下:

@Configuration
public class MyInterceptorConfig implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 实现WebMvcConfigurer不会导致静态资源被拦截
        registry.addInterceptor(new MyInterceptor()).addPathPatterns("/**");
    }
}

这样就非常方便了,实现 WebMvcConfigure接口的话,不会拦截Spring Boot 默认的静态资源。

这两种方式都可以,具体他们之间的细节,感兴趣的读者可以做进一步的研究,由于这两种方式的不同,继承 WebMvcConfigurationSupport类的方式可以用在前后端分离的项目中,后台不需要访问静态资源(就不需要放开静态资源了);实现 WebMvcConfigure接口的方式可以用在非前后端分离的项目中,因为需要读取一些图片、css、js文件等等。

1.3 拦截器使用实例

1.3.1 判断用户有没有登录

一般用户登录功能我们可以这么做,要么往session 中写一个user,要么针对每个 user 生成一个 token,第二种要更好一点,那么针对第二种方式,如果用户登录成功了,每次请求的时候都会带上该用户的 token,如果未登录,则没有该token,服务端可以检测这个token 参数的有无来判断用户有没有登录,从而实现拦截功能。我们改造一下preHandle方法,如下:

@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {

    HandlerMethod handlerMethod = (HandlerMethod) handler;
    Method method = handlerMethod.getMethod();
    String methodName = method.getName();
    logger.info("====拦截到了方法:{},在该方法执行之前执行====", methodName);

    // 判断用户有没有登陆,一般登陆之后的用户都有一个对应的token
    String token = request.getParameter("token");
    if (null == token || "".equals(token)) {
        logger.info("用户未登录,没有权限执行……请登录");
        return false;
    }

    // 返回true才会继续执行,返回false则取消当前请求
    return true;
}

重启项目,在浏览器中输入localhost:8080/interceptor/test后查看控制台日志,发现被拦截,如果在浏览器中输入localhost:8080/interceptor/test?token=123即可正常往下走。

1.3.2 取消拦截操作

根据上文,如果我要拦截所有 /admin开头的url请求的话,需要在拦截器配置中添加这个前缀,但是在实际项目中,可能会有这种场景出现:某个请求也是 /admin开头的,但是不能拦截,比如/admin/login等等,这样的话又需要去配置。那么,可不可以做成一个类似于开关的东西,哪里不需要拦截,我就在哪里弄个开关上去,做成这种灵活的可插拔的效果呢?

是可以的,我们可以定义一个注解,该注解专门用来取消拦截操作,如果某个 Controller中的方法我们不需要拦截掉,即可在该方法上加上我们自定义的注解即可,下面先定义一个注解:

/**
 * 该注解用来指定某个方法不用拦截
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface UnInterception {
}

然后在 Controller中的某个方法上添加该注解,在拦截器处理方法中添加该注解取消拦截的逻辑,如下:

@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {

    HandlerMethod handlerMethod = (HandlerMethod) handler;
    Method method = handlerMethod.getMethod();
    String methodName = method.getName();
    logger.info("====拦截到了方法:{},在该方法执行之前执行====", methodName);

    // 通过方法,可以获取该方法上的自定义注解,然后通过注解来判断该方法是否要被拦截
    // @UnInterception 是我们自定义的注解
    UnInterception unInterception = method.getAnnotation(UnInterception.class);
    if (null != unInterception) {
        return true;
    }
    // 返回true才会继续执行,返回false则取消当前请求
    return true;
}

Controller 中的方法代码可以参见源码,重启项目在浏览器中输入 http://localhost:8080/interceptor/test2?token=123测试一下,可以看出,加了该注解的方法不会被拦截。

1.4 总结

本节主要介绍了 Spring Boot中拦截器的使用,从拦截器的创建、配置,到拦截器对静态资源的影响,都做了详细的分析。Spring Boot 2.0 之后拦截器的配置支持两种方式,可以根据实际情况选择不同的配置方式。最后结合实际中的使用,举了两个常用的场景,希望读者能够认真消化,掌握拦截器的使用。


版权声明:本文为weixin_42039228原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。