Spring Boot中实现配置自定义拦截器

程序员文章站 2022-04-30 15:56:47

...

Spring Boot拦截器的配置方式和Spring MVC差不多，不同的是Spring Boot不需要使用XML注册拦截器。

拦截器应用场景

日志记录，可以记录请求信息的日志，以便进行信息监控、信息统计等。
权限检查：如登陆检测，进入处理器检测是否登陆，如果没有直接返回到登陆页面。
. 性能监控：典型的是慢日志。

Spring Boot配置拦截器的步骤

创建自定义拦截器实现HandlerInterceptor接口
需要一个配置类实现WebMvcConfigurer 接口，并添加@Configuration注解
在配置类中重写addInterceptors方法，添加要拦截的url地址

这里需要注意的WebMvcConfiguerAdapter虽然还能用，但在Spring 5.0版本后已被丢弃。

直接WebMvcConfigurationSupport会出现自动配置的静态资源路径（classpath:/META/resources/，classpath:/resources/，classpath:/static/，classpath:/public/）不生效的问题，需要额外配置。

所以推荐实现WebMvcConfigurer接口来配置拦截器。

使用示例

首先引入依赖

版本号默认即可

            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>

创建拦截器

创建一个MyInterceptor类实现HandlerInterceptor接口

@Component
public class MyInterceptor implements HandlerInterceptor {
  /**
   * 预处理回调方法，实现控制器的预处理
   * Object handler为响应的控制器(自定义的Controller)
   * 返回值：true表示继续执行流程；false表示中断流程，不再调用拦截器或控制器,直接调用afterCompletion
   */
  @Override
  public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
    System.out.println("preHandle");
    //这里写业务代码
    return true;
  }
  /**
   * 后处理回调方法，实现处理器的后处理(但在渲染视图之前)
   * 此时我们可以通过modelAndView（模型和视图对象）对模型数据进行处理或对视图进行处理，modelAndView也可能为null。
   */
  @Override
  public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
    System.out.println("postHandle");
  }

  /**
   * 整个请求处理完毕回调方法，即在视图渲染完毕时回调，
   * 如性能监控中我们可以在此记录结束时间并输出消耗时间，还可以进行一些资源清理，
   * 类似于try-catch-finally中的finally，但仅调用处理器执行链中.
   */
  @Override
  public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
    System.out.println("afterCompletion");
  }
}

创建控制器

创建HelloController类

@RestController
public class HelloController {
  @GetMapping("hello")
  public String hello(){
    return "hello interceptor";
  }
  @GetMapping("hello2")
  public String hello2(){
    return "hello interceptor";
  }
}

创建配置类，实现 WebMvcConfigurer接口

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {

  @Autowired
  private MyInterceptor myInterceptor;

  @Override
  public void addInterceptors(InterceptorRegistry registry) {
   //addPathPatterns用于添加拦截路径
    //excludePathPatterns用于添加不拦截的路径
    registry.addInterceptor(myInterceptor).addPathPatterns("/hello")
    .excludePathPatterns("/hello2");

  }
//此方法用于配置静态资源路径
  @Override
  public void addResourceHandlers(ResourceHandlerRegistry registry) {
     registry.addResourceHandler("/**").addResourceLocations("classpath:/my/");
  }
}