SpringBoot中如何实现统一的请求返回格式？

本文共计1044个文字，预计阅读时间需要5分钟。

当前我们的回复是直接将实体类信息赋予请求方，这种方式很不友好。一方面，缺乏统一的格式，另一方面，请求方无法得知请求是否成功，也没有明确的判断依据和说明性回复。本文旨在探讨改进方案。

目前我们的返回是直接把实体类扔给请求方，这样很不友好，一方面没有统一的格式，二来请求方不知道请求成功与否，没有一个可以判断的东西，也没有说明性的返回。

本篇就来为所有接口提供一个统一的友好返回。

确定返回结构

首先，我们先确定好我们接口返回的格式是什么样的，然后再一步一步实现下面的。

{ "code": 200, "msg": "ok", "data": "" }

• code 字段表示状态码，调用方根据该码来作为后续逻辑的依据，比如 code 值为 200 表示操作成功，没有逻辑错误，此时可以提示用户操作成功等；code 值不为 200 表示操作失败，比如为 1001 ，表示用户名已存在，此时前端做一些相应操作。
• msg 字段用来充当额外说明，比如上面说的状态为 1001，这里的 msg 就可以是 username exists 这样的说明性文字，帮助调用方更好的理解。
• data 字段一般是在 code 值为 200 的时候，返回具体的业务数据，可以是数组，也可以是对象。