在SpringBoot中使用ResponseBodyAdvice自定义响应

在SpringBoot中使用ResponseBodyAdvice自定义响应

ResponseBodyAdvice是Spring Framework中的一个接口，允许您在将响应写入客户端之前自定义响应。它通常与@ControllerAdvice注释结合使用，以跨多个控制器将全局更改应用于响应主体。

以下是如何使用ResponseBodyAdvice的基本概述：

1.创建ResponseBodyAdvice实现：

创建一个实现ResponseBodyAdvice接口的类。这个接口有两个泛型参数：响应主体的类型和MessageConverter的类型。

import org.springframework.core.MethodParameter;
import org.springframework.http.MediaType;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;

@ControllerAdvice
public class CustomResponseBodyAdvice implements ResponseBodyAdvice<Object> {

    @Override
    public boolean supports(MethodParameter returnType, Class converterType) {
        // This method is called to determine if the advice should be applied
        // based on the return type and converter type.
        // Return true if you want to apply the advice, false otherwise.
        return true;
    }

    @Override
    public Object beforeBodyWrite(
            Object body,
            MethodParameter returnType,
            MediaType selectedContentType,
            Class selectedConverterType,
            ServerHttpRequest request,
            ServerHttpResponse response) {
        // This method is called just before the response body is written to the client.
        // You can modify the body or the response before it's sent to the client.

        // For example, you can wrap the original response in a custom wrapper.
        CustomResponseWrapper wrapper = new CustomResponseWrapper(body);
        return wrapper;
    }
}

2.自定义响应：

在beforeBodyWrite方法中，您可以自定义响应主体或响应本身。例如，您可以将原始响应包装在自定义包装器中，修改内容，添加标题等。

public class CustomResponseWrapper {

    private Object data;

    public CustomResponseWrapper(Object data) {
        this.data = data;
    }

    public Object getData() {
        return data;
    }

    // You can add more methods or properties as needed
}

3.在控制器中使用自定义响应：

当控制器返回响应时，将调用beforeBodyWrite方法，允许您自定义响应。

@RestController
public class MyController {

    @GetMapping("/api/data")
    public ResponseEntity<String> getData() {
        // Your original response
        String responseData = "Hello, World!";
        return ResponseEntity.ok(responseData);
    }
}

使用此设置，当调用/api/data端点时，将调用beforeBodyWrite中的CustomResponseBodyAdvice方法，并且响应主体将在发送到客户端之前包装在您的CustomResponseWrapper中。

这只是一个基本的示例，您可以根据您的特定用例扩展它以包括更复杂的逻辑。