SpringBoot接口 - 如何优雅的对接口返回内容统一封装？

最新推荐文章于 2025-01-09 22:00:20 发布

原创

最新推荐文章于 2025-01-09 22:00:20 发布

· 428 阅读

版权

文章标签：

在以SpringBoot开发Restful接口时，统一返回方便前端进行开发和封装，以及出现时给出响应编码和信息。@pdai

Representational State Transfer，翻译是“表现层状态转化”。可以总结为一句话：REST 是所有 Web 应用都应该遵守的架构设计指导原则。

面向资源是 REST 最明显的特征，对于同一个资源的一组不同的操作。资源是服务器上一个可命名的抽象概念，资源是以名词为核心来组织的，首先关注的是名词。REST 要求，必须通过统一的接口来对资源执行各种操作。对于每个资源只能执行一组有限的操作。

符合 REST 设计标准的 API，即 RESTful API。REST 架构设计，遵循的各项标准和准则，就是 HTTP 协议的表现，换句话说，HTTP 协议就是属于 REST 架构的设计模式。比如，无状态，请求-响应。

Restful相关文档可以参考 https://restfulapi.net/

现在大多数项目采用前后分离的模式进行开发，统一返回方便前端进行开发和封装，以及出现时给出响应编码和信息。

以查询某个用户接口而言，如果没有封装, 返回结果如下

{
   
  "userId": 1,
  "userName": "赵一"
}

如果封装了，返回正常的结果如下：

{
   
  "timestamp": 11111111111,
  "status": 200,
  "message": "success",
  "data": {
   
    "userId": 1,
    "userName": "赵一"
  }
}

异常返回结果如下：

{
   
  "timestamp": 11111111111,
  "status": 10001,
  "message": "User not exist",
  "data": null
}

如何实现上面的封装呢？

这里以常见的状态码为例，包含responseCode 和 description两个属性。

如果还有其它业务状态码，也可以放到这个类中。

/**
 * @author pdai
 */
@Getter
@AllArgsConstructor
public enum