最近在学SpringBoot的时候,偶然又看到了统一数据格式这一块的内容,所有打算写点东西总结一下。
以前写项目的时候,代码满天飞,想返回什么就返回什么,想返回一个字符串就返回一个字符串,想返回一个对象就返回一个对象,完全不考虑别人受不受的了。然鹅在现在这种提倡前后端分离的时代,这么搞显然是不行的,不然会被同事打死滴。
举例子来看,比如注册用户的时候,验证用户的年龄是否符合条件,根据年龄给出不同的提示
// 字段验证@Min(value = 18, message = "未成年人禁止入内")private Integer age;//其他字段省略
插入一条记录
@GetMapping("/insertMan") public Object insertOne(@Validated Man man, BindingResult br) { // 如果不符合条件,则不插入
if(br.hasErrors()) { return "插入失败";
}
man.setName(man.getName());
man.setAge(man.getAge()); return manDao.save(man);
}可以看到,如果年龄不满18岁,就返回一个字符串,否则返回插入的对象。如果你一个人包揽前后端,那随便你写,反正是你自己的事,但如果你分工合作的话,这样写显然就不太合适了,一个方法这样,那几十个上百个呢,我前端还怎么接收数据啊。
所以我们得统一下返回的格式啊,暂且先定义一个类ResultData吧
public class ResultData{ // 信息状态码,0表示成功,1表示失败 private Integer code; // 提示信息 private String msg; // 返回的对象 private T data; //省略set/get方法。。。。。}
有了这么一个类,那我不可能每次要都new一个ResultData然后调用set方法设置属性后返回吧,这样肯定会有大量的重复代码。所以我们还得定义一个类去专门封装这些属性并进行返回。暂且定义为ResultUtils吧。
public class ResultUtils { // 统一结果集对象
private static ResultData有了这两个类,我们基本的也就实现了,修改上面插入数据的代码如下
@GetMapping("/insertMan") public Object insertOne(@Validated Man man, BindingResult br) { // 如果不符合条件,则不插入
if(br.hasErrors()) { return ResultUtils.fail(1, "插入失败");
}
man.setName(man.getName());
man.setAge(man.getAge()); return ResultUtils.success(manDao.save(man));
}发送请求看看返回的结果
首先插入一个年龄10岁的对象
15.png
再插入一个年龄20岁的对象
16.png
可以看到,不论插入成功或者插入失败,都返回一个统一的数据格式。
现在我们来通过id查询一条记录
public void queryById(Integer id) throws Exception {
Man man = manDao.findOne(id); if(man.getAge() < 10) { throw new Exception("年龄太小了,好好学习");
} else if(man.getAge() > 10 && man.getAge() < 16) { throw new Exception("你也太小了,多吃点饭");
} else { throw new Exception("未知错误");
}
}在controller里进行调用
@RequestMapping("/queryById/{id}") public void queryById(@PathVariable("id") Integer id) throws Exception {
manService.queryById(id);
}现在我们来进行查询看看返回什么
17.png
可以看到返回了一个非常不友好的东西,这肯定不是我们想要的。
现在我们试着来定义一个自己的异常MyException
@SuppressWarnings("serial")public class MyException extends RuntimeException { // 状态码
private Integer code;
public MyException(String message, Integer code) { super(message); this.code = code;
} public Integer getCode() { return code;
} public void setCode(Integer code) { this.code = code;
}
}
作者:Java攻城玩家
链接:https://www.jianshu.com/p/5e67b1d2f895



