Java数据传输结构设计 - 接口数据封包

Java数据传输结构设计 - 接口数据封包

#

接口的数据结构

* 接口应该有统一的数据格式

* 接口应该具有良好的容错性

* 接口应该具有安全性

* 接口应该提供高可读性

#

接口数据返回的最外层结构

{
  "result": "8002",
  "msg": "Success",
  "data": "// 返回的数据",
  "sign": "// 数据签名"
}

接口的数据返回都封包在data字段下，result是接口请求的状态码，msg是接口请求的信息，sign是接口请求返回的数据签名。

- 前面两层result和msg，无论接口请求是否成功，都应该对接口调用者做出响应。

- 第三层data数据封包，接口调用者根据状态码来获取数据封包中的内容。

- 第四层数据签名，用来保证请求接口返回的数据是合法的。

#

#

1 . 无论接口成功执行与否，请求者都应该知道请求的结果。
2 . 请求接口的状态码应该有统一定义，让熟悉的调用者很快读的解读。
3 . 请求接口的返回信息应该明确而精简，让不熟悉的调用者能够快速定位失败的原因。
4 . 接口的数据返回应该统一放置在一个封包下，无论什么接口，无论什么调用者，只要知道这个原则，都可以快速的拿到数据。
5 . 接口应该具备安全性，为了防止接口被劫持，导致调用者向劫持者发送用户敏感数据，我们应该对数据进行签名，以确保这是我们的服务器返回给我们的数据，我们才能够安心的使用这些数据，而不是直接就拿来用。