SpringBoot拦截器与过滤器

一、二者理解

过滤器(Filter)

过滤器，是在java web中将你传入的request、response提前过滤掉一些信息，或者提前设置一些参数。然后再传入Servlet或Struts2的 action进行业务逻辑处理。比如过滤掉非法url（不是login.do的地址请求，如果用户没有登陆都过滤掉），或者在传入Servlet或Struts2的action前统一设置字符集，或者去除掉一些非法字符。

拦截器(Interceptor)

拦截器，是面向切面编程（AOP，Aspect Oriented Program）的。就是在你的Service或者一个方法前调用一个方法，或者在方法后调用一个方法。比如动态代理就是拦截器的简单实现，在你调用方法前打印出字符串（或者做其它业务逻辑的操作），也可以在你调用方法后打印出字符串，甚至在你抛出异常的时候做业务逻辑的操作。

通俗理解

（1）过滤器（Filter）：当你有一堆东西的时候，你只希望选择符合你要求的某一些东西。定义这些要求的工具，就是过滤器。（理解：就是一堆字母中取一个B）
（2）拦截器（Interceptor）：在一个流程正在进行的时候，你希望干预它的进展，甚至终止它进行，这是拦截器做的事情。（理解：就是一堆字母中，干预它，通过验证的少点，顺便干点别的东西）

二、拦截器与过滤器的区别

区别

①：拦截器是基于java的反射机制的，而过滤器是基于函数的回调。
②：拦截器不依赖于servlet容器，而过滤器依赖于servlet容器。
③：拦截器只对action请求起作用，而过滤器则可以对几乎所有的请求起作用。
④：拦截器可以访问action上下文、值、栈里面的对象，而过滤器不可以。
⑤：在action的生命周期中，拦截器可以多次被调用，而过滤器只能在容器初始化时被调用一次。
⑥：拦截器可以获取IOC容器中的各个bean，而过滤器不行，这点很重要，在拦截器里注入一个service，可以调用业务逻辑。

三、拦截器与过滤器的触发时机

拦截器与过滤器触发时机不一样

• 过滤器是在请求进入容器后，但请求进入servlet之前进行预处理的
• 拦截器是在servlet处理完后，返回给前端之前。
• 过滤器包裹servlet，servlet包裹住拦截器

四、使用场景

SpringMVC的处理器拦截器类似于Servlet开发中的过滤器Filter，用于对处理器进行预处理和后处理。

1、日志记录：记录请求信息的日志，以便进行信息监控、信息统计、计算PV（Page View）等。
2、权限检查：如登录检测，进入处理器检测检测是否登录，如果没有直接返回到登录页面；
3、性能监控：有时候系统在某段时间莫名其妙的慢，可以通过拦截器在进入处理器之前记录开始时间，在处理完后记录结束时间，从而得到该请求的处理时间（如果有反向代理，如apache可以自动记录）；
4、通用行为：读取cookie得到用户信息并将用户对象放入请求，从而方便后续流程使用，还有如提取Locale、Theme信息等，只要是多个处理器都需要的即可使用拦截器实现。
5、OpenSessionInView：如hibernate，在进入处理器打开Session，在完成后关闭Session。

五、图解

六、使用

Filter

• 实现filter接口

public class Test1Filter implements Filter {

     @Override
    public void init(final FilterConfig filterConfig)
            throws ServletException {
        Properties properties = new Properties()
        // 从配置文件中读取相关配置
        String configFilePath = Constants.APP_HOME + "/conf" + "/application.properties"
        //加载到properties中
        properties.load(new FileInputStream)
            
        //给属性赋值
    }
    
    @Override
    public void doFilter(ServletRequest arg0, ServletResponse arg1, FilterChain arg2)
            throws IOException, ServletException {
        HttpServletRequest httpRequest = (HttpServletRequest)request;
        HttpServletResponse httpResponse = (HttpServletResponse)response;
        String authorization = httpRequest.getHeader("authorization")
        if(null != authorization && authorization.length() > "Basic".length){
            authorization = authorization.substring("Basic".length,authorization.length())
            if((rootUsername+":"+rootPassword).equals(new String(Base64.decodeBase64(authorization)))){
                response.setStatus(200)
                response.setHeader("Paragma","No-cache")
                response.setHeader("Cache-Control","No-store")
                response.setDateHeader("Expires",0)
                response.setHeader("identify","root")
                chain.doFilter(httpRequest,httpResponse)
            }else if((guestUsername+":"+guestPassword).equals(new String(Base64.decodeBase64(authorization)))){
                response.setStatus(200)
                response.setHeader("Paragma","No-cache")
                response.setHeader("Cache-Control","No-store")
                response.setDateHeader("Expires",0)
                response.setHeader("identify","guest")
                chain.doFilter(httpRequest,httpResponse)
            }
        }else{
            response.setStatus(401)
            response.setHeader("Cache-Control","No-store")
            response.setDateHeader("Expires",0)
            response.setHeader("www-authenticate","Base Realm= xxxxx")
        }
    }
}

• 通过FilterRegistrationBean注册

@Configuration
public class DemoConfiguration {

    @Bean
    public FilterRegistrationBean<Test1Filter> RegistTest1(){
        //通过FilterRegistrationBean实例设置优先级可以生效
        //通过@WebFilter无效
        FilterRegistrationBean<Test1Filter> bean = new FilterRegistrationBean<Test1Filter>();
        bean.setFilter(new Test1Filter());//注册自定义过滤器
        bean.setName("flilter1");//过滤器名称
        bean.addUrlPatterns("/*");//过滤所有路径
        bean.setOrder(1);//优先级，最顶级
        return bean;
    }
}

interceptor

public class LogInterceptor extends HandlerInterceptorAdapter(HandlerInterceptorAdapter ) {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        long startTime = System.currentTimeMillis();
        System.out.println("\n-------- LogInterception.preHandle --- ");
        System.out.println("Request URL: " + request.getRequestURL());
        System.out.println("Start Time: " + System.currentTimeMillis());

        request.setAttribute("startTime", startTime);

        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("\n-------- LogInterception.postHandle --- ");
        System.out.println("Request URL: " + request.getRequestURL());
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("\n-------- LogInterception.afterCompletion --- ");

        long startTime = (Long) request.getAttribute("startTime");
        long endTime = System.currentTimeMillis();
        System.out.println("Request URL: " + request.getRequestURL());
        System.out.println("End Time: " + endTime);

        System.out.println("Time Taken: " + (endTime - startTime));
    }
}

• 配置拦截器

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LogInterceptor());

        registry.addInterceptor(new OldLoginInterceptor()).addPathPatterns("/admin/oldLogin");

        registry.addInterceptor(new AdminInterceptor()).addPathPatterns("/admin/*").excludePathPatterns("/admin/oldLogin");
    }
}

参考资料:Spring MVC拦截器（Interceptor ）详解 - Louis军 - 博客园 (cnblogs.com)

参考资料:Document (gitee.io)