io.github.taills.common.response.ApiResult Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-boot-common Show documentation
Taills's Spring Boot Project Common
There is a newer version: 1.3.0
package io.github.taills.common.response;


import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import lombok.Getter;
import lombok.ToString;
/**
 * @author taills
 * @date 2019/05/01
 */
@Getter
@ToString
public class ApiResult {
    /**
     * 业务错误码
     */
    private Integer code;
    /**
     * 信息描述
     */
    private String message;
    /**
     * 返回参数
     */
    private T data;

    private final static Gson GSON = new GsonBuilder().setDateFormat("yyyy-MM-dd HH:mm:ss").serializeNulls().create();

    private ApiResult(ApiResultStatus apiResultStatus, T data) {
        this.code = apiResultStatus.getCode();
        this.message = apiResultStatus.getMessage();
        this.data = data;
    }

    private ApiResult(Integer code, String message, T data) {
        this.code = code;
        this.message = message;
        this.data = data;
    }

    /**
     * 业务成功，无参
     * @return
     */
    public static ApiResult success() {
        return new ApiResult(ApiResultStatus.SUCCESS, null);
    }

    /**
     * 业务成功，返回正常业务码及 data
     * @param data
     * @param 
     * @return
     */
    public static  ApiResult success(T data) {
        return new ApiResult(ApiResultStatus.SUCCESS, data);
    }

    /**
     * 业务成功，使用预设的 ApiResultStatus 外加 data
     * @param apiResultStatus
     * @param data
     * @param 
     * @return
     */
    public static  ApiResult success(ApiResultStatus apiResultStatus, T data) {
        if (apiResultStatus == null) {
            return success(data);
        }
        return new ApiResult(apiResultStatus, data);
    }

    /**
     * 业务异常，无参数
     * @param 
     * @return
     */
    public static  ApiResult failure() {
        return new ApiResult(ApiResultStatus.BAD_REQUEST, null);
    }

    /**
     * 业务异常，使用预设的 ApiResultStatus
     * @param apiResultStatus
     * @param 
     * @return
     */
    public static  ApiResult failure(ApiResultStatus apiResultStatus) {
        return failure(apiResultStatus, null);
    }

    /**
     * 业务异常，使用预设的 ApiResultStatus 及附加 data
     * @param apiResultStatus
     * @param data
     * @param 
     * @return
     */
    public static  ApiResult failure(ApiResultStatus apiResultStatus, T data) {
        if (apiResultStatus == null) {
            return new ApiResult(ApiResultStatus.INTERNAL_SERVER_ERROR, null);
        }
        return new ApiResult(apiResultStatus, data);
    }

    /**
     * 业务异常，使用自定义的 code、message、data
     * @param code
     * @param message
     * @param data
     * @param 
     * @return
     */
    public static  ApiResult failure(Integer code, String message, T data) {
        return new ApiResult<>(code, message, data);
    }

    public static  ApiResult failure(Integer code, String message) {
        return new ApiResult<>(code, message, null);
    }

    public String toJsonString() {
        return GSON.toJson(this);
    }
}