非官方常用类:Result 统一结果类

场景

我们在业务处理的时候,远程接口或者方法调用返回结果的时候,往往会需要返回以下的内容

  • 成功与否
  • 处理结果的描述
  • 结果数据
    以上内容并非一定都需要。但返回消息满足了这样的结构,就基本上符合了绝大部分场景的需要。

这样常用的结构,其实应该在JDK或者某个框架中应该有才是,但是,目前看来没有找到,但是类似的代码,在大量的项目代码中存在着。

代码

/**
 * 结果类 Result
 * 接口或者方法返回时的公共类。
 * 包含了返回码,返回消息以及数据
 *
 * @param  数据主体的类型
 */
@Data
public class Result implements Serializable {
    /**
     * code:返回码
     * 一般情况下,消息返回的时候,根据返回码判断是否正常返回
     * 主要用于逻辑判断
     */
    private String code;

    /**
     * message:消息
     * 当消息返回时,message 是对成功或者失败的描述
     * 主要用于展示,比如 处理失败时返回,message:数据库异常。
     */
    private String message;
    private D data;

    public Result(String code, String message) {
        this.code = code;
        this.message = message;
    }

    public Result(String code, String message, D data) {
        this.code = code;
        this.message = message;
        this.data = data;
    }
}

你可能感兴趣的:(非官方常用类:Result 统一结果类)