springboot 拦截器实现注意要点

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

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

一、Interceptor 实现方式

  1. 实现HandlerInterceptor
  2. 继承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 需要的一些配置参数

  1. 需要一个配置类实现 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());
    }
}

四、拦截器失效的几种情况

  1. 如果有其他config 继承了 WebMvcConfigurationSupport 类的,会导致拦截器失效。
  2. 拦截器没有加到配置里的。
  3. springboot 的Application 包位置未扫描到,需要加Scan的范围。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值