Spring Boot Interceptor没有起作用的原因及解决方法

在使用Spring Boot开发Web应用时，拦截器（Interceptor）是一个非常重要的功能。通过拦截器，我们可以在请求到达Controller之前，对请求进行处理，或在请求处理完成后对响应进行操作。然而，有些开发者在配置拦截器时发现，拦截器并没有按照预期工作，本文将分析可能的原因并提供相应的解决方案。

什么是Spring Boot拦截器？

在Spring Boot中，拦截器的主要功能是拦截HTTP请求，在请求到达Controller之前或响应返回客户端之前执行特定的逻辑。常见用途包括：

  • 认证与授权
  • 日志记录
  • 请求计时
  • 请求数据修改

配置Spring Boot拦截器

下面是一个简单的Spring Boot拦截器的配置示例：

import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

@Component
public class MyInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("Request intercepted: " + request.getRequestURI());
        return true; // 返回true表示继续执行后续的handler（Controller），返回false则阻止执行
    }
}

为了让这个拦截器生效，我们还需要在配置类中注册它：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Autowired
    private MyInterceptor myInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(myInterceptor).addPathPatterns("/**"); // 拦截所有请求
    }
}

拦截器没起作用的常见原因

尽管我们已经进行了上述配置，拦截器仍然没有生效，可能存在以下几种原因：

1. 拦截器未注册

确保你的拦截器类上有 @Component 注解，并且在 WebConfig 中被正确注入。如果拦截器没有被Spring容器管理或未注册，应用就会忽略它。

2. 拦截路径配置错误

在调用 addPathPatterns("/**") 时，确保匹配的路径是你所需要的。有可能你输入了错误的路径或者不符合RESTful风格的路径，从而导致拦截器没有被触发。

3. 由其他配置干扰

有时，其他配置（如WebSecurityConfigurer）中的内容可能会影响到拦截器的执行顺序。当Spring Security被使用时，某些请求可能会直接被Security过滤掉，而不经过拦截器。需要检查这部分配置。

4. 使用了WebFlux

如果你的应用使用的是Spring WebFlux而不是Spring MVC，该拦截器将不生效。在WebFlux中，使用的是不同的拦截器机制。

示例：使用拦截器进行请求计时

为了更清晰地展示拦截器的作用，我们可以扩展我们的 MyInterceptor，为请求计时：

import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

@Component
public class TimingInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        request.setAttribute("startTime", System.currentTimeMillis());
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        long startTime = (long) request.getAttribute("startTime");
        long endTime = System.currentTimeMillis();
        System.out.println("Request processing time: " + (endTime - startTime) + " ms");
    }
}

在这里，我们在 preHandle 中记录请求开始时间，并在 postHandle 中计算并输出请求处理时间。

结论

Spring Boot的拦截器功能强大，但在使用过程中可能遇到一些阻碍拦截器成功工作的情况。确保拦截器被正确注册、路径配置合理、不被其他配置干扰等，都是确保其正常工作的关键。通过本文的解析与示例，相信您已经对Spring Boot的拦截器有了更深的理解。

接下来，借助如下饼状图，展示使用拦截器的主要理由。

pie
    title 拦截器使用原因
    "请求处理": 30
    "日志记录": 30
    "权限验证": 25
    "性能监控": 15

希望这篇文章能帮助你解决Spring Boot拦截器未生效的问题，进一步提升你的开发效率！