统一返回结果集

乐闻-LONG

已于 2023-09-28 10:07:07 修改

阅读量68

点赞数

分类专栏：开发实用文章标签： java 网络服务器

于 2023-09-28 09:52:52 首次发布

本文链接：https://blog.csdn.net/2201_75287416/article/details/133376694

版权

开发实用专栏收录该内容

8 篇文章 0 订阅

订阅专栏

文章讲述了SpringBoot项目中如何通过ResultModel类实现接口调用的统一返回结果，包括code状态码、message描述和data数据，以减少开发沟通成本。

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

SpringBoot统一返回结果：
在实际开发中，为了降低开发人员之间的沟通成本，一般返回结果会定义成一个统一格式，具体的格式根据实际开发业务不同有所区别，但至少包括三要素：

code状态码：由后端统一定义各种返回结果的状态码
message 描述：本次接口调用的结果描述
data 数据：本次返回的数据。

{
	"code": 200,
	"msg": "操作成功",
	"data": "OK",
}

@Data
@NoArgsConstructor
@Accessors(chain = true)
public class ResultModel<T> implements Serializable {

    /**
     * 请求是否成功
     */
    private boolean success;

    /**
     * 响应码
     */
    private Integer errorCode;

    /**
     * 响应信息
     */
    private String message = "";

    private T data;

    private String tranceId;

    public static <T> ResultModel<T> success() {
        ResultModel<T> resultModel = new ResultModel<>();
        resultModel.setSuccess(true);
        return resultModel;
    }

    public static <T> ResultModel<T> success(T data) {
        ResultModel<T> resultModel = new ResultModel<>();
        resultModel.setData(data);
        resultModel.setSuccess(true);
        return resultModel;
    }

    public static <T> ResultModel<T> fail(Integer errorCode, String message) {
        ResultModel<T> resultModel = new ResultModel<>();
        resultModel.setErrorCode(errorCode);
        resultModel.setMessage(StringUtils.isNotBlank(message) ? message : "成功");
        return resultModel;
    }

    public static <T> ResultModel<T> success(Integer errorCode, String message) {
        ResultModel<T> resultModel = new ResultModel<>();
        resultModel.setErrorCode(errorCode);
        resultModel.setMessage(StringUtils.isNotBlank(message) ? message : "成功");
        resultModel.setSuccess(true);
        return resultModel;
    }

    public static <T> ResultModel<T> successOrFail(Integer errorCode, String message) {
        ResultModel<T> resultModel = new ResultModel<>();
        resultModel.setErrorCode(errorCode);
        resultModel.setMessage(message);
        if(errorCode!=200){
            resultModel.setSuccess(false);
        }else{
            resultModel.setSuccess(true);
        }
        return resultModel;
    }

    public static <T> ResultModel<T> fail(GlobalExceptionCode errorCode) {
        ResultModel<T> resultModel = new ResultModel<>();
        resultModel.setErrorCode(errorCode.getCode());
        resultModel.setMessage(errorCode.getMessage());
        return resultModel;
    }
    public static <T> ResultModel<T> fail(ErrorCodeEnum errorCode, String message) {
        ResultModel<T> resultModel = new ResultModel<>();
        resultModel.setErrorCode(Integer.valueOf(errorCode.getErrorCode()));
        resultModel.setMessage(StringUtils.isNotBlank(message) ? message : errorCode.getMessage());
        return resultModel;
    }

    public static <T> ResultModel<T> fail(ErrorCodeEnum errorCode) {
        ResultModel<T> resultModel = new ResultModel<>();
        resultModel.setErrorCode(Integer.valueOf(errorCode.getErrorCode()));
        resultModel.setMessage(errorCode.getMessage());
        return resultModel;
    }