SpringBoot 实战：一招实现结果的优雅响应

对于业务状态码分为两个派系：一个是推荐使用 HTTP 响应码作为接口业务返回；另一种是 HTTP 响应码全部返回 200，在响应体中通过单独的字段表示响应状态。两种方式各有优劣，个人推荐使用第二种，因为很多 Web 服务器对 HTTP 状态码有拦截处理功能，而且状态码数量有限，不够灵活。比如返回 200 表示接口处理成功且正常响应，现在需要有一个状态码表示接口处理成功且正常响应，但是请求数据状态不对，可以返回 2001 表示。

自定义响应体

---

定义一个数据响应体是返回统一响应格式的第一步，无论接口正常返回，还是发生异常，返回给调用方的结构格式都应该不变。给出一个示例：

@ApiModel

@Data

public class Response {

@ApiModelProperty(value = “返回码”, example = “200”)

private Integer code;

@ApiModelProperty(value = “返回码描述”, example = “ok”)

private String desc;

@ApiModelProperty(value = “响应时间戳”, example = “2020-08-12 14:37:11”)

private Date timestamp = new Date();

@ApiModelProperty(value = “返回结果”)

private T data;

}

这样，只要在 Controller 的方法返回Response就可以了，接口响应就一致了，但是这样会形成很多格式固定的代码模板，比如下面这种写法：

@RequestMapping(“hello1”)

public Response hello1() {

final Response response = new Response<>();

response.setCode(200);

response.setDesc(“返回成功”);

response.setData(“Hello, World!”);

return response;

}

调用接口响应结果为：

{

“code”: 200,

“desc”: “返回成功”,

“timestamp”: “2020-08-12 14:37:11”,

“data”: “Hello, World!”

}

这种重复且没有技术含量的代码，怎么能配得上程序猿这种优（lan）雅（duo）的生物呢？最好能在返回响应结果的前提下，减去那些重复的代码，比如：

@RequestMapping(“hello2”)

public String hello2() {

return “Hello, World!”;

}

这就需要借助 Spring 提供的ResponseBodyAdvice来实现了。

全局处理响应数据

---

先上代码：

/**

* 
created at 2020/8/12

* @author www.howardliu.cn

* @since 1.0.0

*/

@RestControllerAdvice

public class ResultResponseAdvice implements ResponseBodyAdvice {

@Override

public boolean supports(final MethodParameter returnType, final Class<? extends HttpMessageConverter<?>> converterType) {

return !returnType.getGenericParameterType().equals(Response.class);// 1

}

@Override

public Object beforeBodyWrite(final Object body, final MethodParameter returnType, final MediaType selectedContentType,

final Class<? extends HttpMessageConverter<?>> selectedConverterType,

final ServerHttpRequest request, final ServerHttpResponse response) {

if (body == null || body instanceof Response) {

return body;

}

final Response result = new Response<>();

result.setCode(200);

result.setDesc(“查询成功”);

result.setData(body);

if (returnType.getGenericParameterType().equals(String.class)) {// 2

ObjectMapper objectMapper = new ObjectMapper();

try {

return objectMapper.writeValueAsString(result);

} catch (JsonProcessingException e) {

throw new RuntimeException(“将 Response 对象序列化为 json 字符串时发生异常”, e);

}

}

return result;

}

}

/**

* 
created at 2020/8/12

总结

虽然我个人也经常自嘲，十年之后要去成为外卖专员，但实际上依靠自身的努力，是能够减少三十五岁之后的焦虑的，毕竟好的架构师并不多。

架构师，是我们大部分技术人的职业目标，一名好的架构师来源于机遇(公司)、个人努力(吃得苦、肯钻研)、天分(真的热爱)的三者协作的结果，实践+机遇+努力才能助你成为优秀的架构师。

如果你也想成为一名好的架构师，那或许这份Java成长笔记你需要阅读阅读，希望能够对你的职业发展有所帮助。

努力，是能够减少三十五岁之后的焦虑的，毕竟好的架构师并不多。

架构师，是我们大部分技术人的职业目标，一名好的架构师来源于机遇(公司)、个人努力(吃得苦、肯钻研)、天分(真的热爱)的三者协作的结果，实践+机遇+努力才能助你成为优秀的架构师。

如果你也想成为一名好的架构师，那或许这份Java成长笔记你需要阅读阅读，希望能够对你的职业发展有所帮助。

[外链图片转存中…(img-81J10zHx-1714459439879)]

本文已被CODING开源项目：【一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码】收录