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

关注我的公众号：【编程朝花夕拾】，可获取首发内容。

01 引言

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

02 ResponseBodyAdvice

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

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

2.1 场景假设

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

java 复制代码

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

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


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

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

json 复制代码

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

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

java 复制代码

@Data
public class JsonResult<T> {

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

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

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

2.2 问题解决

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

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

java 复制代码

@ControllerAdvice
public class MyResponseBodyAdvice implements ResponseBodyAdvice<Object> {
    @Override
    public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
        return returnType.getContainingClass().isAnnotationPresent(RestController.class);
    }

    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType,
                                  Class<? extends HttpMessageConverter<?>> selectedConverterType,
                                  ServerHttpRequest request, ServerHttpResponse response) {
        if (body instanceof JsonResult) {
            return body;
        }

        if (body instanceof Wjson) {
            return JsonResult.success(body);
        }
        if (body instanceof ResponseEntity) {
            return JsonResult.success(((ResponseEntity<?>) body).getBody());
        }

        return JsonResult.fail("30002", "请求失败");
    }
}

supports ：什么样的条件进入，允许处理，类似开关。案例中，返回的方法上是否包含RestController.class。

beforeBodyWrite ：supports返回true之后进入。案例中，如果返回JsonResult不处理。如果是Wjson或者ResponseEntity，需要转化成JsonResult，否则返回错误信息。

2.3 结果演示

这样就不在修改Controller的情况下，完成响应参数的统一封装。

03 番外

原本上面的解决方案已经是常见的解决方案了。但是前两天在整理SpringBoot配置项时，发现HandlerMethodReturnValueHandler同样可以解决此类问题，功能甚至更丰富。

3.1 自定统一返回处理

java 复制代码

public class JsonResultHandlerMethodReturnValueHandler implements HandlerMethodReturnValueHandler {

    @Override
    public boolean supportsReturnType(MethodParameter returnType) {
        return returnType.getContainingClass().isAnnotationPresent(RestController.class);
    }

    @Override
    public void handleReturnValue(Object returnValue, MethodParameter returnType, ModelAndViewContainer mavContainer, NativeWebRequest webRequest) throws Exception {
        // 标记请求已处理，避免视图解析
        mavContainer.setRequestHandled(true);
        HttpServletResponse response = webRequest.getNativeResponse(HttpServletResponse.class);
        response.setContentType(MediaType.APPLICATION_JSON_VALUE);
        response.setCharacterEncoding("UTF-8");
        PrintWriter writer = response.getWriter();
        
        if (returnValue instanceof JsonResult) {
            writer.write(JSON.toJSONString(returnValue));
            return;
        }

        if (returnValue instanceof Wjson) {
            writer.write(JSON.toJSONString(JsonResult.success(returnValue)));
            return;
        }

        if (returnValue instanceof ResponseEntity) {
            writer.write(JSON.toJSONString(JsonResult.success(((ResponseEntity<?>) returnValue).getBody())));
            return;
        }
        
        writer.write(JSON.toJSONString(JsonResult.fail("30001", "请求失败")));
    }
}

3.2 配置

为防止自定义的方法返回解析器被系统默认的解析器有限取代执行，我们需要调整解析器的位置。

java 复制代码

@Autowired
private RequestMappingHandlerAdapter handlerAdapter;

@PostConstruct
public void init() {
    List<HandlerMethodReturnValueHandler> returnValueHandlers = handlerAdapter.getReturnValueHandlers();
    List<HandlerMethodReturnValueHandler> list = new ArrayList<>(returnValueHandlers);
    list.add(0, new JsonResultHandlerMethodReturnValueHandler());
    handlerAdapter.setReturnValueHandlers(list);
}

结果这里就不演示了，和上面的结果一致。

04 小结

条条道路通罗马，每一种方式都能解决问题。但是不同方案处理数据的时机不同，HandlerMethodReturnValueHandler处理的方式更加灵活，可以随意定制。而ResponseBodyAdvice更像一个定制好的半成品，使用起来更加简单。