过滤器（Filter）和拦截器（Interceptor）的实现 - 执行顺序以及区别

最新推荐文章于 2024-05-05 00:05:37 发布

小非肥

最新推荐文章于 2024-05-05 00:05:37 发布

阅读量646

点赞数 1

分类专栏：框架 SpringBoot 文章标签：过滤器 springmvc

原文链接：https://www.cnblogs.com/kuotian/p/13176186.html

版权

SpringBoot 同时被 2 个专栏收录

20 篇文章 1 订阅

订阅专栏

框架

10 篇文章 0 订阅

订阅专栏

文章目录

测试代码

首先建立一个SpringBoot工程，增加一个IndexController供测试使用。

@Controller
public class IndexController {

    @GetMapping("/hello")
    @ResponseBody
    public String index(){
        return "hello";
    }
}

过滤器 Filter

过滤器（ Filter），是 JavaEE 的标准，依赖于 Servlet 容器，使用的时候是在 SpringMVC 框架中的web.xml 文件中配置，可以配置多个，执行的顺序是根据配置顺序从上到下。在 SpringBoot 项目中采用注解的形式实现。

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

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

Filter有如下几个用处。

在HttpServletRequest到达Servlet之前，拦截客户的HttpServletRequest。
根据需要检查HttpServletRequest，也可以修改HttpServletRequest头和数据。
在HttpServletResponse到达客户端之前，拦截HttpServletResponse。
根据需要检查HttpServletResponse，也可以修改HttpServletResponse头和数据。

Filter有如下几个种类。

用户授权的Filter：Filter负责检查用户请求，根据请求过滤用户非法请求。
日志Filter：详细记录某些特殊的用户请求。
负责解码的Filter:包括对非标准编码的请求解码。
能改变XML内容的XSLT Filter等。
Filter可以负责拦截多个请求或响应；一个请求或响应也可以被多个Filter拦截。

过滤器的实现

创建Filter必须实现javax.servlet.Filter接口，在该接口中定义了如下三个方法。

void init(FilterConfig config):用于完成Filter的初始化。
void destory():用于Filter销毁前，完成某些资源的回收。
void doFilter(ServletRequest request,ServletResponse response,FilterChain chain):实现过滤功能，该方法就是对每个请求及响应增加的额外处理。该方法可以实现对用户请求进行预处理(ServletRequest request)，也可实现对服务器响应进行后处理(ServletResponse response)—它们的分界线为是否调用了chain.doFilter(),执行该方法之前，即对用户请求进行预处理；执行该方法之后，即对服务器响应进行后处理。

1.通过@WebFilter 注解配置

用这种方式配置TestFilter1、TestFilter2

@WebFilter(urlPatterns = “/hello”)
@Order(4) //预期order值越小，过滤器越靠前，此处配置无效

public class TestFilter1 implements Filter {
    @Override
    public void init(javax.servlet.FilterConfig filterConfig) throws ServletException {
        System.out.println("##############Filter1 init##############");
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        //在DispatcherServlet之前执行
        System.out.println("##############doFilter1 before##############");
        filterChain.doFilter(servletRequest, servletResponse);
        // 在视图页面返回给客户端之前执行，但是执行顺序在Interceptor之后
        System.out.println("##############doFilter1 after##############");
    }

    @Override
    public void destroy() {
        System.out.println("##############Filter1 destroy##############");
    }
}

并且在启动类添加 @ServletComponentScan

@SpringBootApplication
@ServletComponentScan
public class TestbootApplication {
    public static void main(String[] args) {
        SpringApplication.run(TestbootApplication.class, args);
    }
}

2.通过@Bean来配置

用这种方式配置TestFilter3、TestFilter4

创建过滤器。

@Component
public class TestFilter3 implements Filter{
    @Override
    public void init(javax.servlet.FilterConfig filterConfig) throws ServletException {
        System.out.println("##############Filter3 init##############");
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        //在DispatcherServlet之前执行
        System.out.println("##############doFilter3 before##############");
        filterChain.doFilter(servletRequest, servletResponse);
        // 在视图页面返回给客户端之前执行，但是执行顺序在Interceptor之后
        System.out.println("##############doFilter3 after##############");
    }

    @Override
    public void destroy() {
        System.out.println("##############Filter3 destroy##############");
    }
}

注册过滤器

@Configuration
public class FilterConfig {

    @Bean
    public FilterRegistrationBean testFilter3RegistrationBean() {
        FilterRegistrationBean registration = new FilterRegistrationBean(new TestFilter3());
        registration.addUrlPatterns("/hello");
        registration.setOrder(1); // 值越小越靠前，此处配置有效
        return registration;
    }

    @Bean
    public FilterRegistrationBean testFilter4RegistrationBean() {
        FilterRegistrationBean registration = new FilterRegistrationBean(new TestFilter4());
        registration.addUrlPatterns("/hello");
        registration.setOrder(2);
        return registration;
    }
}

3.Spring MVC在web.xml配置

创建一个Filter只需两个步骤

创建Filter处理类
web.xml文件中配置Filter
示例：

<filter>
    <filter-name>CharacterEncodingFilter</filter-name>
    <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
    <init-param>
        <param-name>encoding</param-name>
        <param-value>UTF-8</param-value>
    </init-param>
    <init-param>
        <param-name>forceEncoding</param-name>
        <param-value>true</param-value>
    </init-param>
</filter>

<filter-mapping>
    <filter-name>CharacterEncodingFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

过滤器启动测试
不使用order结果：

##############Filter4 init##############
##############Filter3 init##############
##############Filter2 init##############
##############Filter1 init##############
##############doFilter3 before##############
##############doFilter4 before##############
##############doFilter1 before##############
##############doFilter2 before##############
##############doFilter2 after##############
##############doFilter1 after##############
##############doFilter4 after##############
##############doFilter3 after##############
配置order，值越小越靠前

Filter Order
TestFilter1 4（注解@Order配置）
TestFilter2 3（注解@Order配置）
TestFilter3 2
TestFilter4 1
##############Filter4 init##############
##############Filter3 init##############
##############Filter2 init##############
##############Filter1 init##############
##############doFilter4 before##############
##############doFilter3 before##############
##############doFilter1 before##############
##############doFilter2 before##############
##############doFilter2 after##############
##############doFilter1 after##############
##############doFilter3 after##############
##############doFilter4 after##############
由此可见，@Order的顺序配置没有起作用，registration.setOrder()是有效的。

拦截器 Interceptor

拦截器（Interceptor）不依赖 Servlet 容器，依赖 Spring 等 Web 框架，在 SpringMVC 框架中是配置在SpringMVC 的配置文件中，在 SpringBoot 项目中也可以采用注解的形式实现。

拦截器是 AOP 的一种应用，底层采用 Java 的反射机制来实现的。与过滤器一个很大的区别是在拦截器中可以注入 Spring 的 Bean，能够获取到各种需要的 Service 来处理业务逻辑，而过滤器则不行。

HandlerInterceptor接口：

preHandle (HttpServletRequest request, HttpServletResponse response, Object handle) 方法，顾名思义，该方法将在请求处理之前进行调用。SpringMVC 中的Interceptor 是链式的调用的，在一个应用中或者说是在一个请求中可以同时存在多个Interceptor 。每个Interceptor 的调用会依据它的声明顺序依次执行，而且最先执行的都是Interceptor 中的preHandle 方法，所以可以在这个方法中进行一些前置初始化操作或者是对当前请求的一个预处理，也可以在这个方法中进行一些判断来决定请求是否要继续进行下去。该方法的返回值是布尔值Boolean类型的，当它返回为false 时，表示请求结束，后续的Interceptor 和Controller 都不会再执行；当返回值为true 时就会继续调用下一个Interceptor 的preHandle 方法，如果已经是最后一个Interceptor 的时候就会是调用当前请求的Controller 方法。

postHandle (HttpServletRequest request, HttpServletResponse response, Object handle, ModelAndView modelAndView) 方法，由preHandle 方法的解释我们知道这个方法包括后面要说到的afterCompletion 方法都只能是在当前所属的Interceptor 的preHandle 方法的返回值为true 时才能被调用。postHandle 方法，顾名思义就是在当前请求进行处理之后，也就是Controller 方法调用之后执行，但是它会在DispatcherServlet 进行视图返回渲染之前被调用，所以我们可以在这个方法中对Controller 处理之后的ModelAndView 对象进行操作。postHandle 方法被调用的方向跟preHandle 是相反的，也就是说先声明的Interceptor 的postHandle 方法反而会后执行。

afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handle, Exception ex) 方法，该方法也是需要当前对应的Interceptor 的preHandle 方法的返回值为true 时才会执行。顾名思义，该方法将在整个请求结束之后，也就是在DispatcherServlet 渲染了对应的视图之后执行。这个方法的主要作用是用于进行资源清理工作的。

拦截器的使用

interceptor 的执行顺序大致为：

请求到达 DispatcherServlet
DispatcherServlet 发送至 Interceptor ，执行 preHandle
请求达到 Controller
请求结束后，postHandle 执行

Spring 中主要通过 HandlerInterceptor 接口来实现请求的拦截，实现 HandlerInterceptor 接口需要实现下面三个方法：

preHandle() – 在handler执行之前，返回 boolean 值，true 表示继续执行，false 为停止执行并返回。
postHandle() – 在handler执行之后, 可以在返回之前对返回的结果进行修改
afterCompletion() – 在请求完全结束后调用，可以用来统计请求耗时等等
配置实现拦截器

1.创建拦截器

自定义一个拦截器实现HandlerInterceptor,实现preHandle，postHandle，afterCompletion三个方法。

@Component
public class TestInterceptor1 implements HandlerInterceptor {

    //在DispatcherServlet之前执行
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("##############TestInterceptor1 preHandle##############");
        //true:拦截操作之后，放行 ；false:拦截之后不放行，请求终止；
        return true;
    }

    //在Controller之后的DispatcherServlet之后执行
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("##############TestInterceptor1 postHandle##############");
    }

    // 在页面渲染完成之后返回给客户端执行
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("##############TestInterceptor1 afterCompletion##############");
    }

}

2. 注册拦截器

自定义拦截器配置类继承自WebMvcConfigurer，重写addInterceptors将自定义的拦截器添加至注册中心。

@Component
public class WebMvcConfig implements WebMvcConfigurer {

    @Autowired
    private TestInterceptor1 testInterceptor1;

    @Autowired
    private TestInterceptor2 testInterceptor2;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(testInterceptor1)
                .excludePathPatterns("/**/*.css", "/**/*.js", "/**/*.png", "/**/*.jpg", "/**/*.jpeg")
                .addPathPatterns("/hello");

        registry.addInterceptor(testInterceptor2).addPathPatterns("/hello");
    }

}

注册顺序即为执行顺序。

3.Spring MVC使用mvc:interceptors标签

示例：

mvc:interceptors

过滤器拦截器启动测试执行顺序如下。

##############doFilter4 before##############
##############doFilter3 before##############
##############doFilter1 before##############
##############doFilter2 before##############
##############TestInterceptor1 preHandle##############
##############TestInterceptor2 preHandle##############
Index Controller
##############TestInterceptor2 postHandle##############
##############TestInterceptor1 postHandle##############
##############TestInterceptor2 afterCompletion##############
##############TestInterceptor1 afterCompletion##############
##############doFilter2 after##############
##############doFilter1 after##############
##############doFilter3 after##############
##############doFilter4 after##############

过滤器拦截器执行顺序

在这里插入图片描述

区别

Spring的Interceptor(拦截器)与Servlet的Filter有相似之处，比如二者都是AOP编程思想的体现，都能实现权限检查、日志记录等。不同的是：

Filter Interceptor Summary
Filter 接口定义在 javax.servlet 包中接口 HandlerInterceptor 定义在org.springframework.web.servlet 包中
Filter 定义在 web.xml 中
Filter在只在 Servlet 前后起作用。Filters 通常将请求和响应（request/response）当做黑盒子，Filter 通常不考虑servlet 的实现。拦截器能够深入到方法前后、异常抛出前后等，因此拦截器的使用具有更大的弹性。允许用户介入（hook into）请求的生命周期，在请求过程中获取信息，Interceptor 通常和请求更加耦合。在Spring构架的程序中，要优先使用拦截器。几乎所有 Filter 能够做的事情， interceptor 都能够轻松的实现
Filter 是 Servlet 规范规定的。而拦截器既可以用于Web程序，也可以用于Application、Swing程序中。使用范围不同
Filter 是在 Servlet 规范中定义的，是 Servlet 容器支持的。而拦截器是在 Spring容器内的，是Spring框架支持的。规范不同
Filter 不能够使用 Spring 容器资源拦截器是一个Spring的组件，归Spring管理，配置在Spring文件中，因此能使用Spring里的任何资源、对象，例如 Service对象、数据源、事务管理等，通过IoC注入到拦截器即可 Spring 中使用 interceptor 更容易
Filter 是被 Server(Tomcat等) 调用 Interceptor 是被 Spring 调用因此Filter总是优先于Interceptor执行
总结：
Filter需要在web.xml中配置，依赖于Servlet；

Interceptor需要在SpringMVC中配置，依赖于框架；

两者的本质区别：拦截器（Interceptor）是基于Java的反射机制，而过滤器（Filter）是基于函数回调。从灵活性上说拦截器功能更强大些，Filter能做的事情，都能做，而且可以在请求前，请求后执行，比较灵活。Filter主要是针对URL地址做一个编码的事情、过滤掉没用的参数、安全校验（比较泛的，比如登录不登录之类），太细的话，还是建议用interceptor。不过还是根据不同情况选择合适的。

引用资料：
https://blog.csdn.net/javageektech/article/details/94250382

https://www.cnblogs.com/junzi2099/p/8022058.html#_label0

https://blog.csdn.net/zxd1435513775/article/details/80556034

不知道拦截器是在前端控制器之前还是之后。博文中拦截器的执行顺序和图示有点矛盾。

小非肥

关注

1
点赞
踩
2

收藏

觉得还不错? 一键收藏
0
评论
过滤器（Filter）和拦截器（Interceptor）的实现 - 执行顺序以及区别

文章目录过滤器 FilterFilter有如下几个用处。Filter有如下几个种类。过滤器的实现1.通过@WebFilter 注解配置2.通过@Bean来配置3.Spring MVC在web.xml配置拦截器 InterceptorHandlerInterceptor接口：拦截器的使用1.创建拦截器2. 注册拦截器3.Spring MVC使用mvc:interceptors标签过滤器拦截器执行顺序区别测试代码首先建立一个SpringBoot工程，增加一个IndexController供测试使用。@C
复制链接

扫一扫