网站权重对优化的作用,深夜18款免费软件app下载,wordpress 站点地址 wordpress地址,国内永久免费crm系统软件为什么需要统一数据返回格式#xff1f;
⽅便前端程序员更好的接收和解析后端数据接⼝返回的数据。降低前端程序员和后端程序员的沟通成本#xff0c;按照某个格式实现就⾏了#xff0c;因为所有接⼝都是这样返回的。有利于项⽬统⼀数据的维护和修改。有利于后端技术部⻔的…为什么需要统一数据返回格式
⽅便前端程序员更好的接收和解析后端数据接⼝返回的数据。降低前端程序员和后端程序员的沟通成本按照某个格式实现就⾏了因为所有接⼝都是这样返回的。有利于项⽬统⼀数据的维护和修改。有利于后端技术部⻔的统⼀规范的标准制定不会出现稀奇古怪的返回内容。
统一数据返回格式的实现
类上添加 ControllerAdvice 注解表示对 Controller 的通知实现 ResponseBodyAdvice 接口并重写 supports 和 beforeBodyWrite 方法, 拦截返回的数据, 并对数据格式进行重写
ControllerAdvice
public class ResponseAdvice implements ResponseBodyAdvice {Resourceprivate ObjectMapper objectMapper;/*** 内容是否需要重写通过此⽅法可以选择性部分控制器和⽅法进⾏重写* 返回 true 表示重写 进入下面的 beforeBodyWrite 方法*/Overridepublic boolean supports(MethodParameter returnType, Class converterType) {return true;}/*** ⽅法返回之前调⽤此⽅法*/SneakyThrows // 这个注解, 等价于 方法上加 Throws ExceptionOverridepublic Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType,Class selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {// 构造统⼀返回对象HashMapString, Object result new HashMap();result.put(state, 1);result.put(msg, );result.put(data, body);if (body instanceof String) {// 如果数据类型是 String 的话, 比较特殊, 需要 使用 jackson单独处理return objectMapper.writeValueAsString(request);}return result;}
}统一数据返回格式举例
假如说约定返回格式为一个类 AjaxResult
/*** 统一数据返回格式* 实现 Serializable 接口支持序列化*/
Data
public class AjaxResult implements Serializable {// 状态码private Integer code;// 状态码描述信息private String msg;// 返回的数据private Object data;/*** 操作成功返回的结果*/public static AjaxResult success(Object data) {AjaxResult result new AjaxResult();result.setCode(200);result.setMsg();result.setData(data);return result;}/*** 根据需要调用不同的重载的 方法*/public static AjaxResult success(Integer code, Object data) {AjaxResult result new AjaxResult();result.setCode(code);result.setMsg();result.setData(data);return result;}public static AjaxResult success(Integer code, String msg, Object data) {AjaxResult result new AjaxResult();result.setCode(code);result.setMsg(msg);result.setData(data);return result;}/*** 操作失败返回的结果*/public static AjaxResult fail(Integer code, String msg) {AjaxResult result new AjaxResult();result.setCode(code);result.setMsg(msg);result.setData(null);return result;}public static AjaxResult fail(Integer code, String msg, Object data) {AjaxResult result new AjaxResult();result.setCode(code);result.setMsg(msg);result.setData(data);return result;}
}拦截返回的数据, 对不满足条件的数据进行封装使满足格式.
/*** 实现统一数据返回的保底类* 说明: 在返回数据之前, 检测数据的类型是否是统一的对象, 如果不是, 封装成统一的对象*/ControllerAdvice
public class ResponseAdvice implements ResponseBodyAdvice {Autowiredprivate ObjectMapper objectMapper;/*** 开关, 如果是 true, 才会调用 beforeBodyWrite 方法*/Overridepublic boolean supports(MethodParameter returnType, Class converterType) {return true;}/*** 对数据格式进行校验和封装*/SneakyThrows // 这个注解, 等价于 方法上加 Throws ExceptionOverridepublic Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {if (body instanceof AjaxResult) {// 本身格式就是 AjaxResult 了return body;}if (body instanceof String) {// 是字符串的话比较特殊, 需要使用 jacksonreturn objectMapper.writeValueAsString(AjaxResult.success(body));}// 如果不是字符串, 直接返回对象即可return AjaxResult.success(body);}
}好啦 以上就是对 统⼀数据返回格式 的讲解希望能帮到你 评论区欢迎指正 !
