在后端接口封装中,我们一般都会对返回的数据做一个封装,以防止系统出现不可预期的数据结构和类型。比如这样:
结构体 1
结构体 2
不论如何定义,多一个或少一个字段,我们都需要统一规范。接下来我们拆解一下,
首先,通过观察,一定要有状态码,也就是案例中的 code
和 ret
,通过状态码可以知道当前程序哪里出了问题,比如 200
就是成功。有同学会问,为何不用 data
来判断,为空或者为 0
就是错误,当然不行。
比如:下面这个结构,data
长度虽然等于 0
,但是这属于确实没查到数据,而不是程序出错。
再看 data
,这个毋庸置疑,它是接口的核心数据,也是接口对外提供的业务数据。
再看 message
或者称为 msg
,它是给状态做一个文字说明。比如,有个老六在定义了一个状态码(666),第一次调用这个接口的同学可能并不知道返回的状态码含义、也不想去查接口文档,我加个描述:(老六的接口不通啦),调用者就一目了然了。
最后看 success
字段,这个字段是为了更规范而加的,方便前端直接将接口响应状态展示。比如:用户登录成功,可以展示一个 true
,或者前端在判断时也可以写更简洁的代码 if result.success:
。毕竟将(老六的接口不通啦)描述直接展示出来显得不太正式。
基于以上几点,我们的返回结构这样定义:
ApiResponse.class
定义完返回结构后,我们需要定义状态的枚举值。这是为了定一个统一的规范,方便开发时状态码搞混。
如何使用呢
这里使用了 Spring 自带的返回结构体 ResponseEntity
进行封装。
获取到的结果是这样的: