Spring MVC拦截器与过滤器执行顺序冲突的排查思路 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

Spring MVC 拦截器与过滤器执行顺序冲突排查思路

大家好，今天我们来聊聊 Spring MVC 中拦截器 (Interceptor) 和过滤器 (Filter) 执行顺序冲突的排查思路。这个问题在实际开发中经常遇到，理解其背后的原理和掌握排查方法对于构建健壮的 Web 应用至关重要。

1. 拦截器与过滤器的基本概念

首先，我们快速回顾一下拦截器和过滤器的基本概念，以便于后续的讨论。

1.1 过滤器 (Filter)

定义： Filter 是 Servlet 规范中的组件，它拦截 Servlet 容器的处理请求和响应。
作用范围： Filter 作用于 Servlet 容器级别，可以拦截所有进入 Servlet 容器的请求。
实现方式： 通过实现 javax.servlet.Filter 接口来创建。
执行时机： 在 Servlet 被调用之前和之后执行。
主要用途： 请求预处理、响应后处理、安全性检查、日志记录、字符编码转换等。

1.2 拦截器 (Interceptor)

定义： Interceptor 是 Spring MVC 框架中的组件，它拦截 Spring MVC 的处理器 (Handler) 请求和响应。
作用范围： Interceptor 作用于 Spring MVC 框架级别，只能拦截 Spring MVC 控制器中的请求。
实现方式： 实现 org.springframework.web.servlet.HandlerInterceptor 接口来创建，或者继承 org.springframework.web.servlet.handler.HandlerInterceptorAdapter 类。
执行时机： 在 Handler 执行之前、之后以及视图渲染完成之后执行。
主要用途： 权限验证、日志记录、性能监控、数据预处理等。

1.3 关键区别

特性	Filter	Interceptor
规范	Servlet 规范	Spring MVC 框架
作用范围	Servlet 容器级别	Spring MVC 框架级别
拦截对象	所有进入 Servlet 容器的请求	Spring MVC 控制器中的请求
实现接口	`javax.servlet.Filter`	`org.springframework.web.servlet.HandlerInterceptor`
执行时机	Servlet 调用前后	Handler 执行前后以及视图渲染完成后
依赖容器	依赖 Servlet 容器	依赖 Spring MVC 框架

2. 执行顺序的理论分析

理解拦截器和过滤器的执行顺序是解决冲突的关键。Spring MVC 的执行流程大致如下：

请求到达 Servlet 容器
Filter 链执行： Servlet 容器根据 web.xml (或注解) 中配置的顺序，依次执行 Filter 链中的每个 Filter。
DispatcherServlet 处理： 请求到达 Spring MVC 的核心组件 DispatcherServlet。
HandlerMapping 查找 Handler： DispatcherServlet 根据请求的 URL 查找对应的 Handler (通常是一个 Controller 方法)。
Interceptor 链执行： 在 Handler 执行之前，按照配置顺序执行 Interceptor 链中的 preHandle 方法。
Handler 执行： 调用 Handler 处理请求。
Interceptor 链执行 (postHandle)： Handler 执行完毕后，按照配置顺序的逆序执行 Interceptor 链中的 postHandle 方法。
视图渲染： 根据 Handler 的返回值，进行视图渲染。
Interceptor 链执行 (afterCompletion)： 视图渲染完成后，按照配置顺序的逆序执行 Interceptor 链中的 afterCompletion 方法。
Filter 链执行： 在响应返回给客户端之前，按照 Filter 链配置顺序的逆序执行 Filter 链中的 doFilter 方法 (Servlet 容器的响应处理部分)。

总结：

Filter 先于 Interceptor 执行。
Filter 和 Interceptor 都以链式结构执行。
Interceptor 的 postHandle 和 afterCompletion 方法以逆序执行。

3. 常见的执行顺序冲突场景

理解了执行顺序后，我们来看看常见的冲突场景。

3.1 字符编码问题

场景： Filter 中设置了字符编码 (例如 UTF-8)，但是 Interceptor 中使用了 request.getParameter() 获取参数，由于 Filter 的编码设置晚于参数获取，导致中文乱码。
原因： Filter 的执行顺序晚于 Interceptor 中参数的获取。
解决方法： 确保字符编码 Filter 在所有 Interceptor 之前执行。

示例代码：

// Filter - CharacterEncodingFilter
@WebFilter("/*")
public class CharacterEncodingFilter implements Filter {

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        request.setCharacterEncoding("UTF-8");
        response.setCharacterEncoding("UTF-8");
        chain.doFilter(request, response);
    }

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {}

    @Override
    public void destroy() {}
}

// Interceptor
public class MyInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
            throws Exception {
        String username = request.getParameter("username"); // 可能出现乱码
        System.out.println("Username: " + username);
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
            ModelAndView modelAndView) throws Exception {}

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
            throws Exception {}
}

3.2 权限验证问题

场景： Filter 中进行了一次权限验证，Interceptor 中又进行了一次验证，导致重复验证，影响性能。或者 Filter 的权限验证不通过，但是 Interceptor 的验证通过了，导致安全漏洞。
原因： 权限验证逻辑分散在 Filter 和 Interceptor 中，导致不一致。
解决方法： 统一权限验证逻辑，避免重复验证。

3.3 请求参数修改问题

场景： Filter 中修改了请求参数，Interceptor 中又使用了修改后的参数，但是 Filter 的修改逻辑有误，导致 Interceptor 获取到的参数不正确。
原因： Filter 和 Interceptor 都修改了请求参数，导致冲突。
解决方法： 尽量避免在 Filter 和 Interceptor 中同时修改请求参数，如果必须修改，需要仔细考虑修改逻辑的正确性。

3.4 事务管理问题

场景: Filter 中开启了一个事务，Interceptor 中又开启了一个事务，导致事务嵌套，可能出现事务管理混乱。
原因： Filter 和 Interceptor 都进行了事务管理，导致冲突。
解决方法： 避免在 Filter 和 Interceptor 中同时进行事务管理，通常事务管理放在 Service 层。

4. 排查思路与方法

当遇到拦截器和过滤器执行顺序冲突问题时，可以按照以下步骤进行排查：

4.1 确认问题现象

首先，要明确问题的具体表现。例如：中文乱码、权限验证失败、数据不一致等。

4.2 分析可能原因

根据问题现象，初步分析可能的原因。例如：字符编码 Filter 的顺序不对、权限验证逻辑不一致、请求参数修改冲突等。

4.3 查看配置信息

web.xml (或 @WebFilter 注解)： 检查 Filter 的配置顺序，以及 Filter 的 URL 匹配模式。
Spring MVC 配置 (例如 applicationContext.xml 或 @Configuration 类)： 检查 Interceptor 的配置顺序，以及 Interceptor 的 URL 匹配模式。

4.4 调试代码

设置断点： 在 Filter 和 Interceptor 的 doFilter、preHandle、postHandle 和 afterCompletion 方法中设置断点，观察执行顺序和参数值。
打印日志： 在 Filter 和 Interceptor 中添加日志输出，记录执行时间、参数值等信息，帮助分析问题。

4.5 修改配置

根据分析结果，修改 Filter 和 Interceptor 的配置顺序，或者修改代码逻辑，解决冲突。

4.6 重复测试

修改配置后，重新测试，确认问题是否解决。

4.7 使用工具

IDE 的调试器： 使用 IDE 的调试器可以方便地查看代码的执行流程和变量的值。
性能分析工具： 使用性能分析工具可以帮助分析 Filter 和 Interceptor 的性能瓶颈。

5. 具体案例分析

我们通过一个具体的案例来演示如何排查和解决拦截器和过滤器执行顺序冲突问题。

案例：

一个 Web 应用需要进行用户身份验证和请求日志记录。使用了一个 Filter 进行用户身份验证，一个 Interceptor 进行请求日志记录。但是，发现请求日志记录的用户名总是空的。

代码：

// Filter - AuthenticationFilter
@WebFilter("/*")
public class AuthenticationFilter implements Filter {

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        HttpServletRequest httpRequest = (HttpServletRequest) request;
        String username = httpRequest.getHeader("username"); // 从 Header 中获取用户名

        if (username == null || username.isEmpty()) {
            System.out.println("Authentication failed: Username is missing.");
            ((HttpServletResponse) response).setStatus(HttpServletResponse.SC_UNAUTHORIZED);
            return;
        }

        request.setAttribute("username", username); // 将用户名放入 request 属性中
        chain.doFilter(request, response);
    }

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {}

    @Override
    public void destroy() {}
}

// Interceptor - LoggingInterceptor
public class LoggingInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
            throws Exception {
        String username = (String) request.getAttribute("username"); // 从 request 属性中获取用户名

        if (username == null || username.isEmpty()) {
            System.out.println("Warning: Username is missing in LoggingInterceptor.");
        }

        System.out.println("Request URL: " + request.getRequestURI() + ", Username: " + username);
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
            ModelAndView modelAndView) throws Exception {}

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
            throws Exception {}
}

问题：

LoggingInterceptor 记录的用户名总是空的。

排查步骤：

确认问题现象： LoggingInterceptor 记录的用户名总是空的。
分析可能原因： 可能是 AuthenticationFilter 没有正确地将用户名放入 request 属性中，或者 LoggingInterceptor 在 AuthenticationFilter 之前执行，导致无法获取到用户名。

查看配置信息：

web.xml 中 AuthenticationFilter 的配置如下：

<filter>
    <filter-name>authenticationFilter</filter-name>
    <filter-class>com.example.AuthenticationFilter</filter-class>
</filter>
<filter-mapping>
    <filter-name>authenticationFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

Spring MVC 配置中 LoggingInterceptor 的配置如下：

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {

    @Autowired
    private LoggingInterceptor loggingInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(loggingInterceptor).addPathPatterns("/**");
    }
}

调试代码： 在 AuthenticationFilter 的 doFilter 方法中设置断点，确认用户名已经放入 request 属性中。在 LoggingInterceptor 的 preHandle 方法中设置断点，发现 request.getAttribute("username") 返回 null。

修改配置： 根据分析，问题原因是 Filter 在 Interceptor 之前执行，导致 Interceptor 无法获取到用户名。因此，我们需要确保 AuthenticationFilter 在 LoggingInterceptor 之前执行。由于 Filter 的执行顺序由 web.xml (或 @WebFilter 注解) 中配置的顺序决定，而 Interceptor 的执行顺序由 Spring MVC 配置决定，我们需要调整 Filter 的配置，使其在 Interceptor 之前执行。但是Filter的执行顺序依赖于web.xml中<filter-mapping>的声明顺序，无法直接与Spring MVC Interceptor的顺序进行精确控制。在这个案例中，更好的解决办法是避免使用request attribute进行数据传递。 AuthenticationFilter将username放入HttpSession，LoggingInterceptor从HttpSession中获取。

// Filter - AuthenticationFilter
@WebFilter("/*")
public class AuthenticationFilter implements Filter {

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        HttpServletRequest httpRequest = (HttpServletRequest) request;
        HttpServletResponse httpResponse = (HttpServletResponse) response;
        HttpSession session = httpRequest.getSession();
        String username = httpRequest.getHeader("username"); // 从 Header 中获取用户名

        if (username == null || username.isEmpty()) {
            System.out.println("Authentication failed: Username is missing.");
            httpResponse.setStatus(HttpServletResponse.SC_UNAUTHORIZED);
            return;
        }

        session.setAttribute("username", username); // 将用户名放入 Session 中
        chain.doFilter(request, response);
    }

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {}

    @Override
    public void destroy() {}
}

// Interceptor - LoggingInterceptor
public class LoggingInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
            throws Exception {
        HttpSession session = request.getSession(false);
        String username = (String) (session != null ? session.getAttribute("username") : null); // 从 Session 中获取用户名

        if (username == null || username.isEmpty()) {
            System.out.println("Warning: Username is missing in LoggingInterceptor.");
        }

        System.out.println("Request URL: " + request.getRequestURI() + ", Username: " + username);
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
            ModelAndView modelAndView) throws Exception {}

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
            throws Exception {}
}

重复测试： 修改代码后，重新测试，确认 LoggingInterceptor 可以正确记录用户名。

6. 最佳实践

为了避免拦截器和过滤器执行顺序冲突，建议遵循以下最佳实践：

明确职责： 明确 Filter 和 Interceptor 的职责，避免功能重叠。Filter 主要负责 Servlet 容器级别的处理，例如字符编码、安全检查等；Interceptor 主要负责 Spring MVC 框架级别的处理，例如权限验证、日志记录等。
统一配置： 尽量使用统一的方式配置 Filter 和 Interceptor，例如都使用注解配置，或者都使用 XML 配置，避免配置不一致导致的问题。
避免修改请求参数： 尽量避免在 Filter 和 Interceptor 中同时修改请求参数，如果必须修改，需要仔细考虑修改逻辑的正确性。
使用 Session 传递数据： 如果需要在 Filter 和 Interceptor 之间传递数据，可以使用 Session，避免使用 request 属性可能导致的顺序问题。
充分测试： 在开发过程中，充分测试 Filter 和 Interceptor 的执行顺序和功能，确保没有冲突。

7.总结陈词

拦截器与过滤器在Spring MVC中扮演着重要的角色，理解它们的执行顺序是解决冲突问题的关键。通过细致地分析问题，查看配置信息，以及使用调试工具，可以有效地排查和解决执行顺序冲突问题。同时，遵循最佳实践可以最大限度地避免此类问题的发生，构建更加健壮的Web应用。