为什么使用
项目中我们会将响应封装成JSON返回,一般我们会将所有接口的数据格式统一, 使前端对数据的操作更一致、轻松。 一般情况下,统一返回数据格式没有固定的格式,只要能描述清楚返回的数据状态以及要返回的具体数 据就可以。但是一般会包含状态码、返回消息、数据这几部分内容
一. 统一返回数据格式
{
"success": 布尔, //响应是否成功
"code": 数字, //响应码
"message": 字符串, //返回消息
"data": HashMap //返回数据,放在键值对中
}
二 . 创建统一结果返回类
- 抽取出来作为公共部分
1. 创建公共部分模块Common
2. 创建接口定义返回码 也可使用枚举 也可以不定义,直接写入
public interface ResultCode {
public static Integer SUCCESS = 20000;
public static Integer ERROR = 20001;
}
3. 创建结果类
//统一返回结果的类
@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>();
//把构造方法私有 不让别人new该类
private R() {}
//实现链式编程
//R.ok().code().message().data();
//成功静态方法
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; //返回this 实现链式编程
}
//实现链式编程
//R.ok().code().message().data();
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;
}
}
4. 项目结构
三. 使用
1.在使用的包中先导依赖
2.接口方法返回结果都改为R(导包时记得引对)
// 1 查询所有数据
@GetMapping("findAll")
public R findAllTeacher(){
//调用service的方法实现查询所有的操作
List<EduTeacher> list = teacherService.list(null);
return R.ok().data("items",list); //链式编程
}
// 2. 逻辑删除方法
@DeleteMapping("{id}")
public R removeTeacher(@PathVariable String id){
boolean flag = teacherService.removeById(id);
if(flag){
return R.ok();
}else
return R.error();
}