spring boot 注入拦截器方式

原创

mob64ca12ed4084 2024-08-31 10:15:31 ©著作权

文章标签 拦截器 spring java 文章分类 spring boot 后端开发

©著作权归作者所有：来自51CTO博客作者mob64ca12ed4084的原创作品，请联系作者获取转载授权，否则将追究法律责任

Spring Boot 注入拦截器方式

在开发中，我们常常需要对请求进行过滤或处理，这时就可以使用拦截器。下面，我将带你了解如何在 Spring Boot 中注入拦截器。我们将通过一个简单的流程图和序列图来展示整个步骤。

流程步骤

步骤	描述
1	创建拦截器类
2	注册拦截器
3	配置需要拦截的路径和方法
4	编写自定义逻辑
5	测试拦截器功能

每一步的详细实现

步骤 1: 创建拦截器类

首先，我们需要创建一个拦截器类，通常实现 HandlerInterceptor 接口。该接口提供了 preHandle、postHandle 和 afterCompletion 三个方法，分别在请求处理前、处理后和请求完成后执行。

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.getRequestURI());
        // 返回 true 继续请求，返回 false 中止请求
        return true;
    }

    // 请求处理后
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("请求处理完成: " + request.getRequestURI());
    }

    // 请求完成后
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("请求结束: " + request.getRequestURI());
    }
}

步骤 2: 注册拦截器

接下来，我们需要注册我们的拦截器。这可以通过自定义一个 WebMvcConfigurer 实现。

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("/**") // 拦截所有请求
                .excludePathPatterns("/ignore/**"); // 排除不拦截的路径
    }
}

步骤 3: 配置需要拦截的路径和方法

在注册拦截器时，我们可以指定需要拦截的路径和需要排除的路径，如上面的示例所示。

步骤 4: 编写自定义逻辑

在 preHandle、postHandle 和 afterCompletion 方法中，我们编写自定义逻辑，比如记录日志、权限检查等。

步骤 5: 测试拦截器功能

启动 Spring Boot 应用并测试请求，确保拦截器按预期工作。你可以使用 Postman 或浏览器发送请求，观察控制台输出。

序列图

以下是整个流程的序列图，可以帮助更清晰地理解请求和拦截器的执行顺序。

sequenceDiagram
    participant Client
    participant WebServer
    participant Interceptor

    Client->>WebServer: 发起请求
    WebServer->>Interceptor: 调用 preHandle()
    Interceptor->>WebServer: 返回 true
    WebServer->>WebServer: 处理请求
    WebServer->>Interceptor: 调用 postHandle()
    Interceptor->>WebServer: 返回
    WebServer->>Client: 返回响应
    WebServer->>Interceptor: 调用 afterCompletion()
    Interceptor->>WebServer: 结束