服务端数据返回规范格式探讨
开发中,服务端返回的数据格式很重要,如果格式不统一,程序的Bug就会很多,服务端一个字段可以导致客户端各种奇葩的异常,还有不必要的非空判断,代码极为难看。
那么 好的服务端 json 数据格式是怎么样的呢?
废话不多说,下面这种格式还是比较好的,不能说最好,但是最好规范了一把。
来人呐,上json
{
"code":100,
"data": {},
"msg":"success"
}
就?这么简单??对,就这么简单,格式由 大括号包裹{ },表示json对象
大括号里,由三个字段组成(若有需求,可以再添加字段)code 表示 请求成功与否状态码,data内包裹着请求结果,如果没数据,data内部不需要返回任何东西,但是data的打括号还是需要,这很重要, msg 字段表示请求成功与否的状态信息,字符串表示。
规定好规范之后,返回的数据只能是这样的
请求成功:
{
"code":100,
"data":{
"username":"json",
"info":{
"pic":"http:www.baidu.com",
"title":"标题",
"content":"内容"
}
},
"msg":"success"
}
请求失败:
{
"code":101,
"data":{
},
"msg":"failure because params..."
}
数组格式 :
{
"code":200,
"data":[
{
"name":"zhangsan",
"age":23,
"sex":"男"
},
{
"name":"李四",
"age":25,
"sex":"男"
}
],
"msg":""
}
没有数据的时候:
{
"code":200,
"data":[ ],
"msg":"xxxx"
}
事儿不大,也不麻烦,20秒理解,规范很重要!!!不然,以后有得哭的。