java 的过滤器（Filter）和拦截器（Interceptor）的区别，以及过滤器与拦截器在 springboot 中的使用

叁歲伎倆 2023-10-08 12:20 4阅读 0赞

#### 主要区别 ####

*  拦截器是基于java的反射机制的，而过滤器是基于函数回调
 *  拦截器不依赖于servlet容器，过滤器依赖于servlet容器
 *  过滤器Filter是只在请求（Servlet启动）的前后起作用；而拦截器能够深入到各个方法前后、异常抛出前后等
 *  过滤器可以修改request的值，而拦截器不能
 *  在请求中，拦截器可以通过反射机制多次被调用，而过滤器只能在容器初始化时被调用一次
 *  拦截器是要注册进spring的，而过滤器是依赖servlet，要注册到web.xml里，所以拦截器可以获取IOC容器中的各个bean，而过滤器就不行，这点很重要，在拦截器里可以注入一个service，调用业务逻辑
 *  过滤器Filter主要是针对URL地址做编码、过滤掉没用的参数、安全校验等，因为过滤器可以修改request的值

#### **执行顺序** ####

过滤前 - 拦截前 - 请求处理 - 拦截后 - 过滤后。个人认为过滤是一个横向的过程，首先把客户端提交的内容进行过滤(例如未登录用户不能访问内部页面的处理)；过滤通过后，拦截器将检查用户提交数据的验证，做一些前期的数据处理，接着把处理后的数据发给对应的接口请求；接口请求处理完成返回后，拦截器还可以做其他过程，再向上返回到过滤器的后续操作。

#### **使用原则（使用场景）** ####

因为有些功能比如判断用户是否登录，既可以用过滤器，也可以用拦截器，用哪一个才是合理的呢？如果我们把整个项目的流程比作一条河，里面有鱼啊虾啊什么的，然后过滤器就是能够过滤出其中的鱼，而拦截器则是拦截其中的某部分鱼，并且作标记。所以当需要过滤掉其中的部分信息，只留一部分时，就用过滤器；当需要对其流程进行更改，做相关的记录时用拦截器。

换句话说：

1.  当你有一堆东西的时候，你只希望选择符合你要求的某一些东西，就使用过滤器
2.  在一个流程，一个功能，它正在进行的时候，你希望干预它的进展，甚至终止它进行，就是用拦截器

#### **过滤器** ####

Servlet中的过滤器Filter是实现了javax.servlet.Filter接口的服务器端程序，主要的用途是过滤字符编码、做一些业务逻辑判断等。其工作原理是，只要你在web.xml文件配置好要拦截的客户端请求，它都会帮你拦截到请求，此时你就可以对请求或响应(Request、Response)统一设置编码，简化操作；同时还可以进行逻辑判断，如用户是否已经登录、有没有权限访问该页面等等工作，它是随你的web应用启动而启动的，只初始化一次，以后就可以拦截相关的请求，有http请求过来就会触发对应的过滤器，只有当你的web应用停止或重新部署的时候才能触发销毁的方法。

Filter可以认为是Servlet的一种“加强版”，它主要用于对用户请求进行预处理，也可以对HttpServletResponse进行后处理，是个典型的处理链。Filter也可以对用户请求生成响应，这一点与Servlet相同，但实际上很少会使用Filter向用户请求生成响应。使用Filter完整的流程是：Filter对用户请求进行预处理，接着将请求交给Servlet进行预处理并生成响应，最后Filter再对服务器响应进行后处理。

过滤器使用的核心是实现Filer接口，重写doFilter方法，在里面调用 filterChain.doFilter(servletRequest,servletResponse); ，这个相当于原本的接口的调用，在该方法调用这一句的前面的代码，就是前置过滤，在后面就是后置过滤。他其实就是一个代理模式。

*  **过滤器的用法（springboot中）**

1.  定义一个类，实现 Filter 接口，重写里面的方法 init、doFilter、destroy
2.  这个类上面加上注解 @WebFilter(urlPatterns = \{"/\*"\}) ，参数urlPatterns是指过滤的url，可以指定多个，用英文逗号分隔开
3.  在springboot的启动类加上注解 @ServletComponentScan(basePackages = \{"com.liqiye.springboot.filter"\}) ，参数basePackages是你过滤器的类所在的包

@WebFilter(urlPatterns = {"/index","/index2"})
    public class LoginFilter implements Filter {
    
        private Map<String, String[]> params = new HashMap<String, String[]>();
    
        @Override
        public void init(FilterConfig filterConfig) throws ServletException {
            System.out.println("过滤器初始化...");
        }
    
        @Override
        public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse,
                             FilterChain filterChain) throws IOException, ServletException {
            System.out.println("过滤器执行前...");
            // 获取所有请求url中的参数列表map
            Map<String, String[]> map = servletRequest.getParameterMap();
            if(map != null){
                Set<Map.Entry<String, String[]>> set = map.entrySet();
                for (Map.Entry<String, String[]> entry : set) {
                    System.out.println(entry.getKey() + " : " + entry.getValue()[0]);
                    params.put(entry.getKey(), entry.getValue());
                }
            }
            //在这里修改params中的数据，不管是添加、修改
    
            //将修改好的params重新放入RequestWrapper对象中
    
            filterChain.doFilter(servletRequest,servletResponse);
            System.out.println("过滤器执行后...");
        }
    
        @Override
        public void destroy() {
            System.out.println("过滤器销毁...");
        }
    }

@SpringBootApplication
    @ServletComponentScan(basePackages = {"com.liqiye.springboot.filter"})
    public class SpringbootApplication {
    
        public static void main(String[] args) {
            SpringApplication.run(SpringbootApplication.class, args);
        }
    
    }

#### **拦截器** ####

拦截器是在面向切面编程中应用的，就是在你的service或者一个方法前调用一个方法，或者在方法后调用一个方法比如动态代理就是拦截器的简单实现，在你调用方法前打印出字符串（或者做其它业务逻辑的操作），也可以在你调用方法后打印出字符串，甚至在你抛出异常的时候做业务逻辑的操作。拦截器不是在web.xml配置的，是在比如struts在struts.xml配置，在springMVC在spring与springMVC整合的配置文件中配置。在springMVC中，定义拦截器要实现HandlerInterceptor接口，并实现该接口中提供的三个方法：preHandle、postHandle、afterCompletion，然后注册到spring配置文件的标签<mvc:interceptors>中。

*  **拦截器的用法（springboot中）**

1.  定义一个类，实现HandlerInterceptor接口，重写他的三个方法 preHandle、postHandle、afterCompletion
2.  创建一个配置类InterceptorConfig，并实现WebMvcConfigurer接口， 覆盖接口中的addInterceptors方法，该方法中调用registry注册我们上面定义的拦截器类，传入拦截器类的对象，和拦截的url和不拦截的url列表数组，并为该配置类添加@Configuration注解，标注此类为一个配置类，让Spring Boot 启动的时候扫描到，这里的操作就相当于在SpringMVC的配置文件注册拦截器

public class LoginInterceptor implements HandlerInterceptor {
    
        @Override
        public boolean preHandle(HttpServletRequest request, HttpServletResponse response,
                                 Object handler) throws Exception {
            System.out.println("执行 pre 拦截器...   当前访问接口为："+request.getRequestURI().toString());
            // 这里可以验证用户是否登录，或者有无权限等
            //继续提交请求，false 请求就会被拦截不提交
            return true;
        }
    
        @Override
        public void postHandle(HttpServletRequest request, HttpServletResponse response,
                               Object handler, @Nullable ModelAndView modelAndView) throws Exception {
            System.out.println("执行 post 拦截器...");
        }
    
        @Override
        public void afterCompletion(HttpServletRequest request, HttpServletResponse response,
                                    Object handler, @Nullable Exception ex) throws Exception {
            System.out.println("执行 afterCompletion 拦截器...");
        }
    
    }

@Configuration
    public class InterceptorConfig implements WebMvcConfigurer {
    
        @Override
        public void addInterceptors(InterceptorRegistry registry) {
            // 需要拦截的路径，/**表示需要拦截所有请求
            String[]addPathPatterns={"/**"};
            // 不需要拦截的路径
            String [] excludePathPaterns={
                    "/index2",
                    "/index3"
            };
            // 注册一个拦截器，传入我们定义的拦截器的对象进去，和拦截不拦截的url列表
            registry.addInterceptor(new LoginInterceptor())
                    .addPathPatterns(addPathPatterns)
                    .excludePathPatterns(excludePathPaterns);
            // 再注册一个权限拦截器
            //registry.addInterceptor(new AuthorityInterceptor())
            // .addPathPatterns(addPathPatterns)
            // .excludePathPatterns(excludePathPatterns);
        }
    
    }