(一)什么是过滤器

过滤器 Filter 基于 Servlet 实现,过滤器的主要应用场景是对字符编码、跨域等问题进行过滤。Servlet 的工作原理是拦截配置好的客户端请求,然后对 Request 和 Response 进行处理。Filter 过滤器随着 web 应用的启动而启动,只初始化一次。

Filter 的使用比较简单,继承 Filter 接口,实现对应的 init、doFilter 以及 destroy 方法即可。

1、init:在容器启动时调用初始化方法,只会初始化一次

2、doFilter:每次请求都会调用 doFilter 方法,通过 FilterChain 调用后续的方法

3、destroy:当容器销毁时,执行 destory 方法,只会被调用一次。

下面是详细的代码编写方式:

public class MyFilter implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("初始化拦截器");
    }
 
    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        //做一些处理
        chain.doFilter(request,response);
    }
 
    @Override
    public void destroy() {
        System.out.println("销毁拦截器");
    }
}
 
 

(二)什么是拦截器

拦截器是 SpringMVC 中实现的一种基于 Java 反射(动态代理)机制的方法增强工具,拦截器的实现是继承 HandlerInterceptor 接口,并实现接口的 preHandle、postHandle 和 afterCompletion 方法。

1、preHandle:请求方法前置拦截,该方法会在 Controller 处理之前进行调用,Spring 中可以有多个 Interceptor,这些拦截器会按照设定的 Order 顺序调用,当有一个拦截器在 preHandle 中返回 false 的时候,请求就会终止。

2、postHandle:preHandle 返回结果为 true 时,在 Controller 方法执行之后,视图渲染之前被调用

3、afterCompletion:在 preHandle 返回 ture,并且整个请求结束之后,执行该方法。

具体的代码实现如下,首先编写一个拦截器:

@Component
public class UserInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("preHandle");
        String userName=request.getParameter("userName");
        String password = request.getParameter("password");
        if (userName==null||password==null){
            response.setStatus(500);
            response.setContentType("text/html; charset=UTF-8");
            response.getWriter().print("参数缺失");
            return false;
        }
        //进行用户校验
        if (userName.equals("admin")&&password.equals("admin")){
            return true;
        }else {
            response.setStatus(500);
            response.setContentType("text/html; charset=UTF-8");
            response.getWriter().print("用户名或密码错误");
            return false;
        }
    }
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("postHandle");
    }
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("afterCompletion");
    }
}
 
 

编写完拦截器之后,通过一个配置类设置拦截器,并且可以通过 addPathPatternsexcludePathPatterns 执行哪些请求需要被拦截,哪些不需要被拦截。

@Configuration
public class MvcConfig implements WebMvcConfigurer {
    @Autowired
    private UserInterceptor userInterceptor;
 
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(userInterceptor)
                .addPathPatterns("/**")
                .excludePathPatterns("/error");
    }
}
 
 

(三)拦截器与过滤器的区别

相同点

1、拦截器与过滤器都是体现了 AOP 的思想,对方法实现增强,都可以拦截请求方法。

2、拦截器和过滤器都可以通过 Order 注解设定执行顺序

不同点

1、过滤器属于 Servlet 级别,拦截器属于 Spring 级别 Filter 是在 javax.servlet 包中定义的,要依赖于网络容器,因此只能在 web 项目中使用。

Interceptor 是 SpringMVC 中实现的,归根揭底拦截器是一个 Spring 组件,由 Spring 容器进行管理。

2、过滤器和拦截器的执行顺序不同

下面通过一张图展示 Filter 和 Interceprtor 的执行顺序

首先当一个请求进入 Servlet 之前,过滤器的 doFilter 方法进行过滤,

进入 Servlet 容器之后,执行 Controller 方法之前,拦截器的 preHandle 方法进行拦截,

执行 Controller 方法之后,视图渲染之前,拦截器的 postHandle 方法进行拦截,

请求结束之后,执行拦截器的 postHandle 方法。

3、过滤器基于函数回调方式实现,拦截器基于 Java 反射机制实现

(四)总结

实际开发中,拦截器的应用场景会比过滤器要更多,下面是拦截器和过滤器的主要应用场景

拦截器的应用场景:权限控制,日志打印,参数校验

过滤器的应用场景:跨域问题解决,编码转换

拦截器和过滤器算是比较常用的了,但是还是得注意两者的差距,我是鱼仔,我们下期再见!