SpringBoot的过滤器和拦截器

过滤器和拦截器

一：作用：实现启动初始化信息，统计在线人数，在线用户数，过滤敏感高词汇，访问权限控制（URL级别）等业务需求
二：过滤器和拦截器的执行路径

三：过滤器和拦截器的异同

1. 过滤器(Filter)：当你有一堆东西的时候，你只希望选择符合你要求的某一些东西。定义这些要求的工具，就是过滤器。
2. 拦截器(Interceptor)：在一个流程正在进行的时候，你希望干预它的进展，甚至终止它进行，这是拦截器做的事情。
3. 相同点
   都是aop编程思想的体现，可以在程序执行前后做一些操作
4. 不同点：
   过滤器依赖于servlet容器，拦截器不依赖
   过滤器的执行由Servlet容器回调完成，而拦截器通常通过动态代理的方式来执行。触发时机不一样，过滤器是在请求进入Tomcat容器后，而进入servlet前进行预处理的；拦截器是在进入servlet之后，而进入controller之前处理的。
5. 拦截器可以获取IOC容器中的各个bean，而过滤器就不行，拦截器归Spring管理。

四：过滤器Filter

1. 使用场景：判断用户是否登录、判断url是否有访问权限等。
2. 原埋：过滤器的实现基于回调函数。
3. 注解和类说明：
   @WebFilter时Servlet3.0新增的注解，原先实现过滤器，需要在web.xml中进行配置，而现在通过此注解，启动启动时会自动扫描自动注册。FilterRegistrationBean是springboot提供的，此类提供setOrder方法，可以为filter设置排序值，让spring在注册web filter之前排序后再依次注册。
   实现方式一
   1.创建类实现Filter接口

package com.zuxia.filter;

import javax.servlet.*;
import java.io.IOException;

public class CustomFilter implements Filter {

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("CustomFilter初始化方法。。。。。。。。。");
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("doFilter方法。。。。。。。。。。");
        filterChain.doFilter(servletRequest,servletResponse);
    }

    @Override
    public void destroy() {
        System.out.println("destroy方法。。。。。。。。。。");
    }
}

2. 注入SpringBoot容器

package com.zuxia.config;

import com.zuxia.filter.CustomFilter;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * 代替了Web.xml中Filter配置
 */
@Configuration
public class FilterConfig {
    @Bean
    public FilterRegistrationBean<CustomFilter>filterRegistrationBean(){
        FilterRegistrationBean<CustomFilter> filterRegistrationBean=new FilterRegistrationBean<>();
            filterRegistrationBean.setFilter(new  CustomFilter());
            filterRegistrationBean.addUrlPatterns("/*");
            filterRegistrationBean.setOrder(0);//决定注册的优先级
        return filterRegistrationBean;
    }
}

实现方式二：
1. 创建类实现Filter接口，@WebFilter(filterName=“customFilter”,url={"/"})

package com.zuxia.filter;

import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import java.io.IOException;
@WebFilter(filterName = "customFilter2",urlPatterns = {"/"})
public class CustomFilter2 implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("CustomFilter初始化方法。。。。。。。。。");
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("doFilter方法。。。。。。。。。。");
        filterChain.doFilter(servletRequest,servletResponse);
    }

    @Override
    public void destroy() {
        System.out.println("destroy方法。。。。。。。。。。");
    }
}

2. 入口类增加注解@ServletComponentScan

package com.zuxia;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.web.servlet.ServletComponentScan;

/**
 * @ServletComponentScan扫描过滤器的注解
 */
@SpringBootApplication
@ServletComponentScan
public class SpringBootFilterAndListenerApplication {

    public static void main(String[] args) {
        SpringApplication.run(SpringBootFilterAndListenerApplication.class, args);
    }

}

五：拦截器Interceptor

1. 原理：拦截器（代理模式)的实现基于反射，代理又分静态代理和动态代理，动态代理是拦截器的简单实现。被访问的目标方法通过代理类(方法)来执行，这样就可以在正要执行的方法执行前、后做一些处理。
2. 使用场景：读取cookie得到用户信息并将用户对象放入请求、统计日志等。

实现方式：

1. 创建拦截器类实现HandlerInterceptor接口

package com.zuxia.interceptor;

import org.springframework.lang.Nullable;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
@Service
public class CustomInterceptor implements HandlerInterceptor {
    public  boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("处理之前。。。。。");
        return true;
    }

    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable ModelAndView modelAndView) throws Exception {
        System.out.println("处理之中。。。。。");
    }

    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable Exception ex) throws Exception {
        System.out.println("完成之后。。。。。");
    }
}

2. 创建配置类实现WebMvcConfigurer接口

package com.zuxia.config;

import com.zuxia.interceptor.CustomInterceptor;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
@Configuration
public class InterceptorConfig implements WebMvcConfigurer {
    @Autowired
    private CustomInterceptor customInterceptor;
    
    public  void addInterceptors(InterceptorRegistry registry) {
        //注册自定义的拦截器，并且定义拦截路径
        registry.addInterceptor(customInterceptor).addPathPatterns("/**");
    }
}