聊聊Spring里那个不打扰Controller就能统一改响应的“神器”

01 引言

在程序编码的时候，我们总会统一返回响应参数，以规范开发。但是面对老项目改造的时候，有没有遇到过返回的参数不统一的情况，自己又不原因一个个的纠正。那么这篇文章将从不同的角度给你带来思路。

02 ResponseBodyAdvice

类似一个切面，在响应参数返回之前执行。按照官方文档的释义就是在使用HttpMessageConverter之前，执行@ResponseBody或者ResponseEntity之后被触发。

可以直接向RequestMappingHandlerAdapter和ExceptionHandlerExceptionResolver注册，也可以直接通过@ControllerAdvice被触发。

2.1 场景假设

假设我们系统中有以下三种返回方式：

@GetMapping(\"/testResponseEntity\")
public ResponseEntity testResponseEntity() {
    return ResponseEntity.ok(new Wjson(\"test_ResponseEntity\", \"v1\"));
}

@GetMapping(\"/testWjson\")
public Wjson testWjson() {
    return new Wjson(\"test_wjson\", \"v2\");
}


@GetMapping(\"/testJsonResult\")
public JsonResult testJsonResult() {
    return JsonResult.success(new Wjson(\"test_json\", \"v3\"));
}

现在来了一个技术Leader，想要重构现有的结构，需要统一返回参数，决定最终的返回结果如下：

{
  \"code\": \"0000\",
  \"data\": {
    \"content\": \"test_json\",
    \"version\": \"v3\"
  },
  \"success\": true
}

并给出了统一返回参数的实体：

@Data
public class JsonResult {

    private String code;
    private String msg;
    private T data;
    private boolean success;

    public static  JsonResult success(T data) {
        JsonResult jr = new JsonResult();
        jr.setData(data);
        jr.setSuccess(true);
        jr.setCode(\"0000\");
        return jr;
    }

    public static  JsonResult fail(String code, String msg) {
        JsonResult jr = new JsonResult();
        jr.setSuccess(false);
        jr.setCode(code);
        jr.setMsg(msg);
        return jr;
    }
}

2.2 问题解决

强迫症的解决方案，就是一个个的修改每一个方法。这种方案自然可行，但是当方法很多时，工作量就非常大，显然不太适合。

于是，就想从框架层面解决统一返回的问题。ResponseBodyAdvice该上场了。我们需要定于属于自己的请求体切面。

@ControllerAdvice
public class MyResponseBodyAdvice implements ResponseBodyAdvice