瑞吉外卖返回通用结果类R-自学笔记

Echo丶洛尘

已于 2022-06-22 10:35:07 修改

阅读量911

点赞数 2

文章标签： java 开发语言

于 2022-06-21 10:08:31 首次发布

本文链接：https://blog.csdn.net/Leol_emon/article/details/125385488

版权

通用结果类是什么？

在看别人的项目的时候会发现，他们的项目后端返回值是R或者是一些没有听说过的字母或者是单词，这些通常是自己或是公司开发定义的一个类，即通用结果类，这类中封装了一些属性和方法，这个类中通常包含的属性有：

private Boolean success 表示请求是否成功
private Integer code 请求的响应码
private String message 返回信息
private Map<String, Object> data = new HashMap<String, Object>() 返回的数据
使用这些属性可以表示出一个请求的状态和请求所想传递的信息。
习惯将R放在一公共包或者公共的项目中，因为其他项目都大概率需要使用到R，公共属性直接调用即可。

通用结果类的特征

该类里面的属性是私有的，即属性是受到保护的不能随意访问
构造器私有化，为了不让其他类new这个对象，即只能自己new自己
大部分方法是静态方法，为了可以直接使用类名.方法名的方式调用方法
每个方法的返回值都是这个类自己，即为了链式调用。java1.8新特性

为什么使用通用结果类

在大型的项目需要编写很多Controller,其中的方法有很多，几乎都是响应客户端发送来的请求，Controller处理完会返回给页面一个结果，所以就把这个结果统一的封装成一个类R，此类是一个通用结果类，服务端响应的所有结果最终都会包装成此种类型返回给前端页面.
如果不使用通用结果类，则需要不断的写重复的返回结果，而且每个人写的返回结果不一定时相同的，这就给团队合作带来了不便，比如小王返回的的结果为 success，而小李返回的是true，其他人的结果更是有无限种可能，那么前端在接收不同人员的结果时就会很头疼，分不清到底哪个才是成功，哪个才是失败，而通用结果类则可以完美的解决此问题。

代码实现

/**
 * 通用返回结果，服务端响应的数据最终都会封装成此对象
 * @param <T>
 */
@Data
public class R<T> {
    private Integer code;       //编码：1成功，0和其它数字为失败
    private String msg;         //错误信息
    private T data;             //数据
    private Map map = new HashMap();   //动态数据
 
    public static <T> R<T> success(T object) {
        R<T> r = new R<T>();
        r.data = object;
        r.code = 1;
        return r;
    }
    public static <T> R<T> error(String msg) {
        R r = new R();
        r.msg = msg;
        r.code = 0;
        return r;
    }
    public R<T> add(String key, Object value) {
        this.map.put(key, value);
        return this;
    }
}