spring boot 拦截器获取接口返回值-CFANZ编程社区

如何在 Spring Boot 中使用拦截器获取接口返回值

在微服务架构下，拦截器作为一种重要的设计模式，允许我们在请求处理的不同阶段进行处理，比如记录日志、权限校验等。对于新手开发者来说，了解如何使用 Spring Boot 拦截器获取接口的返回值非常重要。本文将为你详细解说这个过程，帮助你掌握这一技巧。

流程概述

首先，让我们来梳理一下实现拦截器获取接口返回值的整体流程。以下是实现步骤的概览表：

步骤	描述
1	创建一个自定义拦截器类
2	实现 `HandlerInterceptor` 接口
3	在拦截器中添加逻辑获取返回值
4	注册拦截器
5	测试拦截器功能

接下来，我们将逐步实现这些步骤。

步骤详解

步骤 1: 创建自定义拦截器类

首先，我们需要创建一个自定义的拦截器类。这个类将用来编写我们自己的拦截逻辑。

import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;

@Component
public class MyInterceptor implements HandlerInterceptor {
    // We will add methods here later
}

@Component 注解用于将自定义拦截器注册为 Spring 的一个组件，以便能够被 Spring 自动发现和装配。

步骤 2: 实现 `HandlerInterceptor` 接口

接下来，我们需要实现 HandlerInterceptor 接口，主要重写其中的 postHandle 方法，以在请求经过处理后获取返回值。

import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

@Component
public class MyInterceptor implements HandlerInterceptor {

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response,
                           Object handler, ModelAndView modelAndView) throws Exception {
        // 在这里获取接口返回值
        if (modelAndView != null) {
            Object result = modelAndView.getModel().get("result");
            System.out.println("Intercepted Response: " + result);
        }
    }
}

postHandle 方法在请求处理后的处理阶段被调用。我们通过 modelAndView.getModel() 获取返回模型，然后从中提取我们需要的结果。

步骤 3: 在拦截器中添加逻辑获取返回值

在 postHandle 中，我们通过日志打印或其他逻辑处理接口的返回值。在上面示例中，我们已完成了这一功能。

步骤 4: 注册拦截器

接下来，我们需要注册拦截器。在 Spring Boot 中，我们可以通过实现 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("/api/**"); // 只拦截/api/路径下的请求
    }
}

使用 addPathPatterns 方法指定拦截器在哪些请求路径下生效。

步骤 5: 测试拦截器功能

现在，我们已经完成了拦截器的创建和配置。在这一步，您可以通过创建一个简单的 REST 控制器来测试拦截器。

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class MyController {

    @GetMapping("/api/test")
    public String test() {
        // 这里简单返回一个字符串作为结果
        return "Hello, World!";
    }
}

当我们访问 /api/test 的时候，拦截器会被触发，并打印出返回值。

饼状图

pie
    title 拦截器功能分布
    "请求验证": 30
    "日志记录": 50
    "返回值处理": 20

类图

classDiagram
    class MyInterceptor {
        +postHandle(HttpServletRequest, HttpServletResponse, Object, ModelAndView)
    }
    class WebConfig {
        +addInterceptors(InterceptorRegistry)
    }
    class MyController {
        +test()
    }