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

* @author www.howardliu.cn

* @since 1.0.0

*/

@RestController

public class HelloWorldController {

@RequestMapping(“hello2”)

public String hello2() {

return “Hello, World!”;

}

@RequestMapping(“user1”)

public User user1() {

User u = new User();

u.setUid(System.currentTimeMillis() + “”);

u.setName(“测试1”);
自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数Java工程师，想要提升技能，往往是自己摸索成长或者是报班学习，但对于培训机构动则几千的学费，着实压力不小。自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！

因此收集整理了一份《2024年Java开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Java开发知识点，真正体系化！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！

如果你觉得这些内容对你有帮助，可以扫码获取！！（备注Java获取）

最后

针对以上面试题，小编已经把面试题+答案整理好了

面试专题

除了以上面试题+答案，小编同时还整理了微服务相关的实战文档也可以分享给大家学习

《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取！
题+答案，小编同时还整理了微服务相关的实战文档也可以分享给大家学习**

[外链图片转存中…(img-aGTaiys0-1713400350566)]

[外链图片转存中…(img-6jEPAhHg-1713400350567)]

[外链图片转存中…(img-OOaGZJJj-1713400350567)]
《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取！