com.pupilcc.common.rest.ApiResult Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of common-rest Show documentation
REST API
There is a newer version: 1.2.1
package com.pupilcc.common.rest;

import java.io.Serializable;
import java.util.Optional;

/**
 * REST API 返回结果
 *
 * @author Mybatis Plus
 * @author pupilcc
 * @since 2022-07-02
 */
public class ApiResult implements Serializable {
    private static final long serialVersionUID = 1L;

    /**
     * 业务错误码
     */
    private long code;

    /**
     * 描述
     */
    private String msg;

    /**
     * 结果集
     */
    private T data;

    public ApiResult() {
    }

    public ApiResult(IErrorCode errorCode) {
        errorCode = Optional.ofNullable(errorCode).orElse(BaseErrorCode.FAILED);
        this.code = errorCode.getCode();
        this.msg = errorCode.getMsg();
    }

    public static  ApiResult restResult(T data, IErrorCode errorCode) {
        return restResult(data, errorCode.getCode(), errorCode.getMsg());
    }

    private static  ApiResult restResult(T data, long code, String msg) {
        ApiResult apiResult = new ApiResult<>();
        apiResult.setCode(code);
        apiResult.setData(data);
        apiResult.setMsg(msg);
        return apiResult;
    }

    /* success */

    public static  ApiResult success() {
        return restResult(null, BaseErrorCode.SUCCESS);
    }

    public static  ApiResult success(T data) {
        BaseErrorCode aec = BaseErrorCode.SUCCESS;
        if (data instanceof Boolean && Boolean.FALSE.equals(data)) {
            aec = BaseErrorCode.FAILED;
        }

        return restResult(data, aec);
    }

    /* failed */

    public static  ApiResult failed(String msg) {
        return restResult(null, BaseErrorCode.FAILED.getCode(), msg);
    }

    public static  ApiResult failed(IErrorCode errorCode) {
        return restResult(null, errorCode);
    }

    public boolean failed() {
        return BaseErrorCode.SUCCESS.getCode() != this.code;
    }

    /**
     * 服务间调用非业务正常，异常直接释放
     *
     * @return data
     */
    public T serviceData() {
        if (!this.failed()) {
            throw new ApiException(this.msg);
        } else {
            return this.data;
        }
    }

    public long getCode() {
        return code;
    }

    public void setCode(long code) {
        this.code = code;
    }

    public String getMsg() {
        return msg;
    }

    public void setMsg(String msg) {
        this.msg = msg;
    }

    public T getData() {
        return data;
    }

    public void setData(T data) {
        this.data = data;
    }
}