一、 json数据格式规范目的
a) 增强前台和后台配合工作效率
b) 标准化json数据格式
一、 总结工作中遇到的问题
a) 使用低版本jquery库，在ajax接收到不严谨的json数据，比如最后多逗号的数据。会出现接口访问成功，但是ajax跳入error的情况。
b) 数据格式没有约定，前后台配合出现问题。比如一次数据请求数据为空，后台可能返回如下{”Data”: null}、{”Data”: }、{”Data”: “”}，这样的数据对前端判断造成不便。
c) ‘Data’这个关键字，在ie6下，会出现识别不出来的情况。
d) 非参与开发人员继续开发此功能，不能及时了解json数据的含义。
二、 json数据标准格式
a) JSON数据用“key/value”对应表示，key要用双引号引起来，value值除true和false以外，都要用双引号引起来。示例：{ "name": "张三"}、{ "name": true}、{ "name": “123”}
b) DataSet相当于数组，最后一个不能有逗号{ "DataSet": [{"account": "张三", "price": 2500.00, "time": "10:30:20"}, {"account": "李四", "price": 2400.00, "time": "10:30:10"},] }这种格式是错误的。
c) 中文unicode编码
三、 异步请求Json数据的通用格式
Json通用格式如下：
{ "IsSuccess": false, "DataSet":
null, "PriAttr": null, "Message":"XXX" }
{ "IsSuccess": true, "DataSet": null, "PriAttr":
null , "Message":"XXX" }
{ "IsSuccess": true, "DataSet": [{"content":
"XXXXX", "title": "公告"},{"content":
"XXXXX", "title": "公告"}],
"PriAttr": {"ToUrl": ""}, "Message":"XXX"
}
四、 Json数据key说明
|
key |
说明 |
|
IsSuccess |
请求成功失败的标示，成功为true失败为false |
|
DataSet |
存放数据数组 |
|
PriAttr |
用于存放私有属性，除了IsSuccess、DataSet，Message全放在这里，也可以不写 |
|
Message |
提示信息 |
请求成功与请求失败对应的格式
|
是否请求成功 |
IsSuccess值 |
DataSet值 |
PriAttr值 |
Message值 |
|
请求失败 |
false |
null |
null |
填入正确的提示文字 |
|
请求成功 |
true |
没有数据可以为null |
没有可以为null |
没有可以为null |
|
请求成功 |
true |
根据功能需求填写标准格式数据数组 |
根据功能需要填写对应的key/value |
根据需要填入提示文字 |