springboot 拦截器实现注意要点

原创已于 2022-05-06 10:58:20 修改 · 586 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#java #spring boot #spring cloud #后端

于 2022-05-04 21:53:31 首次发布

本文详细介绍了SpringBoot中Interceptor的两种实现方式，包括继承WebRequestInterceptor和实现HandlerInterceptor接口的区别。主要关注配置类实现WebMvcConfigurer加载拦截器，并通过@Autowired注入拦截器以方便调用其他服务。同时，文章提及了全局异常处理类GlobalExceptionAdvice如何捕获并处理拦截器中的异常。最后，列举了拦截器可能失效的几种情况，如其他配置类继承WebMvcConfigurationSupport导致拦截器失效等。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

一、Interceptor 实现方式

实现HandlerInterceptor
继承WebRequestInterceptor
两者的区别不大，针对于 preHandle 这个方法的时候，继承WebRequestInterceptor类的不需要返回值，但是实现HandlerInterceptor接口的，需要一个Boolean类型的返回值，true 的才会往下走，false的话就会中断请求，常用的是第一种。

继承WebRequestInterceptor

@Override
    public void preHandle(WebRequest request) throws Exception {
    }
    @Override
    public void postHandle(WebRequest request, ModelMap model) throws Exception {
    }
    @Override
    public void afterCompletion(WebRequest request, Exception ex) throws Exception {
    }

实现HandlerInterceptor

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

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

二、针对于springboot 需要的一些配置参数

需要一个配置类实现 WebMvcConfigurer来加载拦截器

@Configuration
public class Config implements WebMvcConfigurer {

    @Autowired
    private ApiSignInterceptor apiSignInterceptor;


    @Override //拦截器配置
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(apiSignInterceptor) //拦截器注册对象
                .addPathPatterns("/**") //指定要拦截的请求
        /*.excludePathPatterns("/user/login")*/; //排除请求
    }

}

这里有一个很重要的点，就是拦截器引入，主要是针对 addInterceptors方法。一些人可能会这么去写：
通过new 的方式直接去加载拦截器

@Override //拦截器配置
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new ApiSignInterceptor()) 
    }

实际上，这两种都是可以实现的，通过@Autowired 的方式去引入你的拦截器，你可以直接在拦截器里面引入其他service来写你的一些业务代码，比如存表之类的，不然的话，你通过new 的方式引入拦截器，你在拦截器里面引入其他的service，会是null，无法使用。

三、异常处理

拦截器里的异常是可以被全局异常捕获的，所以写个全局异常类就可以了，不需要额外在跳到controller里面或者通过response来传递。

@RestControllerAdvice
public class GlobalExceptionAdvice {
/**
     * 业务异常
     * @return ResponseBean<T> WEB层统一返回对象
     */
    @ExceptionHandler({ BizException.class })
    public ResponseBean<T> handleBizException(BizException e) {
        LogUtil.warn(e, "业务异常");
        return new ResponseBean<>(e.getErrorCode(), e.getErrorMsg());
    }
}