SpringBoot过滤器与拦截器

为什么要有过滤器和拦截器？
在实际开发过程中，经常会碰见一些比如系统启动初始化信息、统计在线人数、在线用户数、过滤敏高词汇、访问权限控制(URL级别)等业务需求。这些对于业务来说一般上是无关的，业务方是无需关注的，业务只需要关注自己内部业务的事情。所以一般上实现以上的功能，都会或多或少的用到过滤器,拦截器来实现以上功能。

（过滤器和拦截器发挥作用的位置）

过滤器的配置

1.使用注解方式： @WebFilter 过滤器的注解

1.编写一个过滤器, 实现javax.servlet.Filter接口
2.通过 @WebFilter设置拦截的url
3.Springboot启动,内嵌Tomcat, Tomcat作为对象存储在Spring容器中, Tomcat要想管理过滤器就需要把过滤器也存储到Spring容器中，所以还需要加上一个@Component注解

图示：

当过滤器较多的时候，@Component注解就需要重复的写，这样不太友好，所以Spring提供了@ServletComponetScan注解，可以指定扫描某一个包下面的过滤器。
使用方式：在启动类/配置类上添加注解@ServletComponetScan
图示：

补充：@WebFilter这个注解是Servlet3.0的规范，并不是Spring boot提供的

2.利用SpringBoot的配置类来添加过滤器
上面使用注解的方式，当有多个过滤器的时候，不能指定过滤器的执行顺序。之前学习javaweb的时候，可以在web.xml中配置执行的顺序。在SpringBoot中可以通过配置文件来指定执行顺序，这个过程和在web.xml中配置其实没什么区别，只是形式不同而已。

使用方式：
1.编写一个过滤器, 实现javax.servlet.Filter接口
2.编写SpringBoot配置类
3.在配置类中使用FilterRegistrationBean注册过滤器，（不能直接将过滤器交给Spring容器）

代码演示：

/**
 * web配置类
 */
@SpringBootConfiguration
public class WebConfig {

    /**
     * 配置过滤器，有多个过滤器，则写多个方法
     */
    @Bean
    public FilterRegistrationBean<AFilter> registrationBean(){
        //创建了一个过滤器注册bean, 注册过滤器
        FilterRegistrationBean<AFilter> filterRegistrationBean = new FilterRegistrationBean<>();
        //设置过滤器
        filterRegistrationBean.setFilter(new AFilter());
        //设置过滤器拦截的url
        filterRegistrationBean.addUrlPatterns("/*");
        //设置执行顺序: 数字越小, 越先执行
        filterRegistrationBean.setOrder(2);

        return filterRegistrationBean;
    }
 }

拦截器的配置

在SpringMVC学习拦截器,配置拦截器,只有一种方式: 配置文件方式: <mvc:interceptors/>
在SpringBoot中, 使用SpringBoot提供的自动配置类,
1.编写一个类实现HandlerInterceptor接口

/**
 * 拦截器
 */
@Slf4j
public class AInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        log.info("AInterceptor的preHandle...");
        /**
         * 放行:  返回true,  返回false: 拦截
         */
        return true;
    }

    @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 {

    }
}

2.在配置类进行配置, 要求原来的SpringMVC自动配置类的基础上,添加额外的配置,要求这个配置类实现WebMvcConfigurer接口

/**
 * webmvc的相关配置类
 */
@SpringBootConfiguration
public class MyWebMvcConfig implements WebMvcConfigurer {

    /**
     * 配置跨域请求
     * @param registry
     */
    @Override
    public void addCorsMappings(CorsRegistry registry) {

    }

    /**
     * 配置静态资源映射器,
     * @param registry
     */
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {

    }

    /**
     * 配置拦截器
     * @param registry
     */
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        //addInterceptor(new AInterceptor()) 添加拦截器对象
        //addPathPatterns("/**") 设置拦截的url
        //excludePathPatterns() 设置排除那些url
        registry.addInterceptor(new AInterceptor()).addPathPatterns("/**");
    }
}

补充：

继承WebMvcConfigurationSupport类, 也可以进行拦截器的配置。但是WebMvc的自动配置类会失效，一般不建议这么做