top.lshaci.framework.common.exception.BaseException Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of framework-common Show documentation

framework common

The newest version!

package top.lshaci.framework.common.exception;

import cn.hutool.core.util.StrUtil;
import lombok.Getter;
import top.lshaci.framework.common.constants.ErrorInfo;

/**
 * Framework common base exception
 *
 * 1.0.4:
 *  *     1. 添加异常码（code）字段
 * 
 *
 * 1.1.0:
 *  *     1. 添加异常信息（errorInfo）字段
 *     2. 重写 toString 方法
 * 
 *
 * @author lshaci
 * @version 1.1.0
 * @since 0.0.1
 */
public class BaseException extends RuntimeException {

    private static final long serialVersionUID = -8170023045088441807L;

    /**
     * 异常码
     */
    @Getter
    private final int code;

    /**
     * 异常信息
     */
    @Getter
    private ErrorInfo errorInfo;

    /**
     * 根据 异常信息 创建一个基础异常
     *
     * @param code     异常码
     * @param template 异常消息
     * @param args     消息参数
     */
    public BaseException(int code, String template, Object... args) {
        super(StrUtil.format(template, args));
        this.code = code;
    }

    /**
     * 根据 异常信息 创建一个基础异常
     *
     * @param errorInfo 异常信息
     * @param args      消息参数
     */
    public BaseException(ErrorInfo errorInfo, Object... args) {
        this(errorInfo.getCode(), StrUtil.format(errorInfo.getMsg(), args));
        this.errorInfo = errorInfo;
    }

    @Override
    public String toString() {
        return StrUtil.format("{} (code={}, message={})", this.getClass().getSimpleName(), this.getCode(), super.getMessage());
    }

}