rebue.wheel.vertx.ro.Vro Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of wheel-vertx Show documentation
wheel利用vert.x框架进行开发常用的工具库
There is a newer version: 3.5.45
package rebue.wheel.vertx.ro;

import com.fasterxml.jackson.annotation.JsonIgnore;
import io.vertx.codegen.annotations.DataObject;
import io.vertx.core.json.JsonObject;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import rebue.wheel.api.dic.HttpStatusCodeDic;
import rebue.wheel.api.dic.ResultDic;

import java.io.Serializable;

/**
 * Vert.x的返回结果
 */
@Slf4j
@Data
@NoArgsConstructor
@AllArgsConstructor
@Builder
@DataObject
public class Vro implements Serializable {

    private static final long serialVersionUID = 1L;

    /**
     * 返回结果的类型
     */
    protected ResultDic result;

    /**
     * 返回结果的信息
     */
    protected String msg;

    /**
     * 详情
     */
    protected String detail;

    /**
     * 附加的内容
     * (如果前面的属性已经能够满足需求，可不需要附加的内容，设为null或不设置即可)
     */
    protected Object extra;

    /**
     * 返回结果的自定义编码
     * (如果通过result已经能够满足需求，可不需要自定义编码，设为null或不设置即可)
     */
    protected String code;

    public Vro(final ResultDic result, final String msg) {
        this.result = result;
        this.msg = msg;
    }

    public Vro(final ResultDic result, final Object extra) {
        this.result = result;
        this.extra = extra;
    }

    public Vro(final ResultDic result, final String msg, final String detail) {
        this.result = result;
        this.msg = msg;
        this.detail = detail;
    }

    public Vro(final ResultDic result, final String msg, final String detail, final String code) {
        this.result = result;
        this.msg = msg;
        this.detail = detail;
        this.code = code;
    }

    public Vro(final ResultDic result, final String msg, final Object extra) {
        this.result = result;
        this.msg = msg;
        this.extra = extra;
    }

    public Vro(final ResultDic result, final String msg, final String detail, final Object extra) {
        this.result = result;
        this.msg = msg;
        this.detail = detail;
        this.extra = extra;
    }

    public static Vro success(final String msg) {
        return new Vro(ResultDic.SUCCESS, msg);
    }

    public static Vro success(final Object extra) {
        return new Vro(ResultDic.SUCCESS, extra);
    }

    public static Vro success(final String msg, final Object extra) {
        return new Vro(ResultDic.SUCCESS, msg, extra);
    }

    public static Vro illegalArgument(final String msg) {
        return new Vro(ResultDic.ILLEGAL_ARGUMENT, msg);
    }

    public static Vro illegalArgument(final String msg, final String detail) {
        return new Vro(ResultDic.ILLEGAL_ARGUMENT, msg, detail);
    }

    public static Vro illegalArgument(final Object extra) {
        return new Vro(ResultDic.ILLEGAL_ARGUMENT, extra);
    }

    public static Vro illegalArgument(final String msg, final Object extra) {
        return new Vro(ResultDic.ILLEGAL_ARGUMENT, msg, extra);
    }

    public static Vro warn(final String msg) {
        return new Vro(ResultDic.WARN, msg);
    }

    public static Vro warn(final String msg, final String detail) {
        return new Vro(ResultDic.WARN, msg, detail);
    }

    public static Vro warn(final Object extra) {
        return new Vro(ResultDic.WARN, extra);
    }

    public static Vro warn(final String msg, final Object extra) {
        return new Vro(ResultDic.WARN, msg, extra);
    }

    public static Vro fail(final String msg) {
        return new Vro(ResultDic.FAIL, msg);
    }

    public static Vro fail(final String msg, final String detail) {
        return new Vro(ResultDic.FAIL, msg, detail);
    }

    public static Vro fail(final Object extra) {
        return new Vro(ResultDic.FAIL, extra);
    }

    public static Vro fail(final String msg, final Object extra) {
        return new Vro(ResultDic.FAIL, msg, extra);
    }

    public static Vro code(final HttpStatusCodeDic statusCode) {
        Integer   code = statusCode.getCode();
        ResultDic result;
        if (code == 400) {
            result = ResultDic.ILLEGAL_ARGUMENT;
        } else if (code >= 200 && code < 400) {
            result = ResultDic.SUCCESS;
        } else if (code < 500) {
            result = ResultDic.WARN;
        } else {
            result = ResultDic.FAIL;
        }

        return Vro.builder()
                .result(result)
                .msg(statusCode.getDesc())
                .code(code.toString())
                .build();
    }

    /**
     * 判断是否成功
     *
     * @return 是否成功
     */
    @JsonIgnore
    public boolean isSuccess() {
        return ResultDic.SUCCESS.equals(this.result);
    }

    /**
     * 判断是否出错
     *
     * @return 是否错误
     */
    @JsonIgnore
    public boolean isError() {
        return !ResultDic.SUCCESS.equals(this.result);
    }

    public JsonObject toJson() {
        return JsonObject.mapFrom(this);
    }

    public Vro(final JsonObject jsonObject) {
        log.debug("Vro constructor: {}", jsonObject);
        final Integer result = jsonObject.getInteger("result");
        if (result == null) {
            this.result = ResultDic.FAIL;
            this.msg = "返回结果为空";
            return;
        }
        this.result = ResultDic.getItem(result);
        this.msg = jsonObject.getString("msg");
        this.detail = jsonObject.getString("detail");
        this.code = jsonObject.getString("code");
        this.extra = jsonObject.getValue("extra");
    }

}