SpringBoot拦截器、过滤器介绍和使用

1. 过滤器（Filter）简介

它依赖于servlet容器。它可以对几乎所有请求进行过滤，但是缺点是一个过滤器实例只能在容器初始化时调用一次。使用过滤器的目的，是用来做一些过滤操作，获取我们想要获取的数据，比如：在Javaweb中，对传入的request、response提前过滤掉一些信息，或者提前设置一些参数，然后再传入servlet或者Controller进行业务逻辑操作。通常用的场景是：在过滤器中修改字符编码（CharacterEncodingFilter）、在过滤器中修改HttpServletRequest的一些参数（XSSFilter(自定义过滤器)），如：过滤低俗文字、危险字符等。

拦截器（Inteceptor）简介

它依赖于web框架，在SpringMVC中就是依赖于SpringMVC框架。在实现上，基于Java的反射机制，属于面向切面编程（AOP）的一种运用，就是在service或者一个方法前，调用一个方法，或者在方法后，调用一个方法，比如动态代理就是拦截器的简单实现，在调用方法前打印出字符串（或者做其它业务逻辑的操作），也可以在调用方法后打印出字符串，甚至在抛出异常的时候做业务逻辑的操作。由于拦截器是基于web框架的调用，因此可以使用Spring的依赖注入（DI）进行一些业务操作，同时一个拦截器实例在一个controller生命周期之内可以多次调用。拦截器可以对静态资源的请求进行拦截处理。

区别

过滤器（Filter）：

• 是Servlet规范的一部分，可以过滤所有类型的请求。
• 在请求到达Servlet之前以及响应返回给客户端之前执行。
• 可以用来设置请求的字符编码、管理会话等。
• 通过实现javax.servlet.Filter接口来创建。

拦截器（Interceptor）：

• 是Spring MVC框架的一部分，只能拦截Spring MVC管理的请求。
• 在处理器方法执行前后执行，可以进行预处理和后处理。
• 可以用来进行权限检查、日志记录等。
• 通过实现org.springframework.web.servlet.HandlerInterceptor接口来创建。

图中afterHandler应该对应重写方法的afterCompletion

拦截器使用-拦截swagger

在springboot框架中一般是使用拦截器来处理一些请求。其实拦截器和过滤器能够实现的功能差不多，因为拦截器是springboot框架中集成的，用起来也比较的方便，所以经常使用拦截器来处理请求。

最近遇到一个需求，就是在生产环境中完全禁用swagger的api文档，目前通过配置文件更改配置那文件状态的方式都不能够完全禁用swagger的状态，查阅资料发现拦截器能够比较好的实现需求。

拦截器使用的步骤：：

1.创建拦截器

- 实现HandlerInterceptor接口或继承HandlerInterceptorAdapter类。

- 实现拦截器的方法：通常需要实现preHandle、postHandle和afterCompletion方法。

2.注册拦截器

- 将拦截器注册到Spring MVC的拦截器链中。

import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
* Swagger拦截器
*@author 
*@Date 
*/
@Component
public class SwaggerInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        response.setStatus(HttpServletResponse.SC_NOT_FOUND);
        return false;
    }
}

@Configuration
public class WebConfig implements WebMvcConfigurer{

        @Value("${yudao.swagger.enabled}")
        Boolean swaggerEnabled;

        @Resource
        SwaggerInterceptor swaggerInterceptor;

        @Override
        public void addInterceptors(InterceptorRegistry registry){
                if(!swaggerEnabled) {
                   //注册⾃定义拦截器对象
                   registry.addInterceptor(swaggerIntercepter)
                      .addPathPatterns("/webjars/**")
                      .addPathPatterns("/doc.html")
                      .addPathPatterns("/v3/api-docs/**");//设置拦截器拦截的请求路径（ /** 表示拦截所有请求）
                }
        }
}