告别接口响应乱象！统一封装，轻松搞定！

2023-10-25 19:04:05

接口响应的统一封装：使用 SpringBoot ResponseBodyAdvice 和 Result

在现代 Web 开发中，接口返回响应的统一封装至关重要。它简化了前端开发，提高了项目的可维护性，并确保了数据的一致性。本文将深入探讨如何使用 SpringBoot 的 ResponseBodyAdvice 和 Result 实现接口响应的统一封装。

ResponseBodyAdvice

SpringBoot 提供了一个名为 ResponseBodyAdvice 的接口，允许我们拦截和修改返回给客户端的 HTTP 响应体。通过实现此接口，我们可以将接口返回响应包装到自定义数据结构中。

Result

为了进行统一封装，我们需要定义一个 Result 数据结构，它包含了接口返回响应的基本信息，例如状态码、消息和数据。

public class Result<T> {

    private int code;

    private String message;

    private T data;
}

使用步骤

定义 Result 数据结构： 定义一个符合项目需求的 Result 数据结构。
实现 ResponseBodyAdvice： 创建一个 ResponseBodyAdvice 接口的实现类，并重写 beforeBodyWrite() 方法来封装响应体。
在 SpringBoot 配置文件中配置： 在 SpringBoot 的配置文件中，配置 ResponseBodyAdvice 实现类的 bean。

示例代码

// 定义 Result 数据结构
public class Result<T> {

    private int code;

    private String message;

    private T data;
}

// 实现 ResponseBodyAdvice 接口
public class ResponseBodyAdviceImpl implements ResponseBodyAdvice<Object> {

    @Override
    public boolean supports(MethodParameter returnType, Class converterType) {
        return true;
    }

    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
        if (body instanceof Result) {
            return body;
        }
        return new Result(0, "success", body);
    }
}

// 在 SpringBoot 配置文件中配置 ResponseBodyAdvice 实现类
@Configuration
public class ResponseBodyAdviceConfig {

    @Bean
    public ResponseBodyAdvice responseBodyAdvice() {
        return new ResponseBodyAdviceImpl();
    }
}