【Java定义统一返回类型】

Dotclv

已于 2022-04-26 13:26:15 修改

阅读量2.7k

点赞数

分类专栏：个人笔记 Java 文章标签： spring springboot intellij-idea java

于 2022-04-26 13:25:30 首次发布

本文链接：https://blog.csdn.net/yumingyang0212/article/details/124425674

版权

个人笔记同时被 2 个专栏收录

25 篇文章 0 订阅

订阅专栏

Java

18 篇文章 0 订阅

订阅专栏

本文介绍了Java中用于接口返回的Result类，展示了如何自定义成功与失败响应，以及包含核心元素如message、code和data。通过实例说明了如何创建和使用Success/Fail方法来标准化结果。

摘要由CSDN通过智能技术生成

@Data
@ApiModel(value = "接口返回对象", description = "接口返回对象")
public class Result<T> implements Serializable {

    private static final long serialVersionUID = 1L;

    /**
     * 返回处理消息
     */
    @ApiModelProperty(value = "返回处理消息")
    private String message = "操作成功！";

    /**
     * 返回代码
     */
    @ApiModelProperty(value = "返回代码")
    private Integer code = 0;

    /**
     * 返回数据对象 data
     */
    @ApiModelProperty(value = "返回数据对象")
    private T data;

    /**
     * 时间戳
     */
    @ApiModelProperty(value = "时间戳")
    private long timestamp = System.currentTimeMillis();

    public boolean ok()
    {
        return CommonConstant.SC_OK_200.equals(this.code);
    }

    public Result() {

    }

    /**
     * success自定义返回信息
     */
    public static <T> Result<T> success(String msg, T data) {
        Result<T> r = new Result<T>();
        r.setCode(CommonConstant.SC_OK_200);
        r.setMessage(msg);
        r.setData(data);
        return r;
    }

    /**
     * fail自定义返回信息
     */
    public static <T> Result<T> fail(String msg, T data) {
        Result<T> r = new Result<T>();
        r.setCode(CommonConstant.SC_INTERNAL_SERVER_ERROR_500);
        r.setMessage(msg);
        r.setData(data);
        return r;
    }

    public static <T> Result<T> success(T data) {
        Result<T> r = new Result<T>();
        r.setCode(CommonConstant.SC_OK_200);
        r.setMessage(CommonConstant.SUCCESS);
        r.setData(data);
        return r;
    }

    public static <T> Result<T> fail(T data) {
        Result<T> r = new Result<T>();
        r.setCode(CommonConstant.SC_INTERNAL_SERVER_ERROR_500);
        r.setMessage(CommonConstant.FAIL);
        r.setData(data);
        return r;
    }

    public static <T> Result<T> success(String msg) {
        Result<T> r = new Result<T>();
        r.setCode(CommonConstant.SC_OK_200);
        r.setMessage(msg);
        return r;
    }

    public static <T> Result<T> fail(String msg) {
        Result<T> r = new Result<T>();
        r.setCode(CommonConstant.SC_INTERNAL_SERVER_ERROR_500);
        r.setMessage(msg);
        return r;
    }
}

public interface CommonConstant {

	/** {@code 500 Server Error} (HTTP/1.0 - RFC 1945) */
    public static final Integer SC_INTERNAL_SERVER_ERROR_500 = 500;
    /** {@code 200 OK} (HTTP/1.0 - RFC 1945) */
    public static final Integer SC_OK_200 = 200;

    /**
     *调用接口状态：成功
     */
    public static final String SUCCESS = "成功";

    /**
     *调用接口状态：失败
     */
    public static final String FAIL = "失败";

}