SpringBoot：将控制器响应包装到另一个对象中

Question

考虑下面的控制器方法，

@GetMapping("/getdata")
public Data getDetails() {
                
    try {
        Data obj = template.getForObject("http://localhost:8090/details/get", Data.class);
        return obj; 

    } catch (Exception e) {
        .....
    }       
}

假设上面endpoint的响应对象如下所示，

data : {
 name : "ABCD",
 age  : "20"
}

现在我试图实现的是将整个响应对象包装在另一个对象下，因此最终响应应该看起来像，

{
   status : "SOMETHING",
   response : {
     name : "ABCD",
     age  : "20"
   },
   extra : null
}

所以问题是，我不想在每个控制器方法下创建一个函数来向这个包装器对象发送值。我的问题是，在Spring框架中是否有可能允许我在某个地方创建一个全局包装器函数，它会自动选择它并包装来自控制器的响应？

Answer 1

您需要以@ControllerAdvice的形式实现一个ResponseBodyAdvice。首先，您需要有一个通用响应的模型。

public class GenericResponse<T> {
    private String status;
    private String extra;
    private T response;
}

然后您需要实现ResponseBodyAdvice本身：

@ControllerAdvice
public class CustomResponseBodyAdvice implements ResponseBodyAdvice<Object> {

    @Override
    public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
        return true;
    }

    @Override
    public Object beforeBodyWrite(Object response, MethodParameter returnType, MediaType selectedContentType,
                                  Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request,
                                  ServerHttpResponse response) {    
        GenericResponse<Object> genericResponse = new GenericResponse<>();
        output.setStatus("SOMETHING"); // I guess that you need some logic here
        output.setResponse(response);
        return genericResponse;
    }
}