返回统一的JSON数据格式
- 一、统一返回的JSON数据格式
- 1. 列表数据
- 2.分页数据
- 3.没有返回数据
- 4.失败
- 统一定义格式
- 二、创建统一结果返回类
- 1. 创建接口定义返回码
- 2. 创建结果类
- 3. Controller中的返回统一数据格式的JSON举例
项目中我们会将响应封装成json返回,一般我们会将所有接口的数据格式统一, 使前端(iOS Android,
Web)对数据的操作更一致、轻松。
一、统一返回的JSON数据格式
- 一般情况下,统一返回数据格式没有固定的格式,只要能描述清楚返回的数据状态以及要返回的具体数据就可以。
- 但是一般会包含状态码、返回消息、数据这几部分内容
- 例如,本文介绍的统一返回的基本数据格式如下:
1. 列表数据
{
"success": true,
"code": 20000,
"message": "成功",
"data": {
"items": [
{
"id": "1",
"name": "刘德华",
"intro": "毕业于师范大学数学系,热爱教育事业,执教数学思维6年有余"
}
]
}
}
2.分页数据
{
"success": true,
"code": 20000,
"message": "成功",
"data": {
"total": 17,
"rows": [
{
"id": "1",
"name": "刘德华",
"intro": "毕业于师范大学数学系,热爱教育事业,执教数学思维6年有余"
}
]
}
}
3.没有返回数据
{
"success": true,
"code": 20000,
"message": "成功",
"data": {}
}
4.失败
{
"success": false,
"code": 20001,
"message": "失败",
"data": {}
}
统一定义格式
{
"success": 布尔, //响应是否成功
"code": 数字, //响应码
"message": 字符串, //返回消息
"data": HashMap //返回数据,放在键值对中
}
二、创建统一结果返回类
1. 创建接口定义返回码
- 创建一个工具包utils,创建接口ResultCode.java
package com.atguigu.commonutils;
public interface ResultCode {
public static Integer SUCCESS = 20000; //成功码
public static Integer ERROR = 20001; //失败码
}
2. 创建结果类
- 创建类 R.java
@Data
public class R {
@ApiModelProperty(value = "是否成功")
private Boolean success;
@ApiModelProperty(value = "返回码")
private Integer code;
@ApiModelProperty(value = "返回消息")
private String message;
@ApiModelProperty(value = "返回数据")
private Map<String, Object> data = new HashMap<String, Object>();
private R(){}
public static R ok(){
R r = new R();
r.setSuccess(true);
r.setCode(ResultCode.SUCCESS);
r.setMessage("成功");
return r;
}
public static R error(){
R r = new R();
r.setSuccess(false);
r.setCode(ResultCode.ERROR);
r.setMessage("失败");
return r;
}
public R success(Boolean success){
this.setSuccess(success);
return this;
}
public R message(String message){
this.setMessage(message);
return this;
}
public R code(Integer code){
this.setCode(code);
return this;
}
public R data(String key, Object value){
this.data.put(key, value);
return this;
}
public R data(Map<String, Object> map){
this.setData(map);
return this;
}
}
3. Controller中的返回统一数据格式的JSON举例
- 列表数据
- 在返回的json的中,有一个键值为data的hashmap
- 使用mybatis plus无条件(wrapper为null,查询全部)查询所有老师的信息
- 所有老师信息返回一个list
- 将list放入hashmap中,键值为items
@ApiOperation(value = "所有讲师列表")
@GetMapping("findAllTeacher")
public R list(){
List<Teacher> list = teacherService.list(null);
return R.ok().data("items", list);
}
- 空数据
- 这里是根据id删除老师信息,因此无返回数据
@ApiOperation(value = "根据ID删除讲师")
@DeleteMapping("{id}")
public R removeById(
@ApiParam(name = "id", value = "讲师ID", required = true)
@PathVariable String id){
teacherService.removeById(id);
return R.ok();
}