Java 代码之自定义异常

异常处理类

import java.io.PrintWriter;
import java.io.StringWriter;
import java.util.List;
import java.util.Objects;

/**
 * 异常信息.
 * 
 * @author gaop
 */
public class ExceptionUtil extends RuntimeException {
    private static final long serialVersionUID = 1L;

    private static final String SEPERTER = " - ";

    // 提示信息，专用于前台展示
    private Object tip;

    /******************** Constructor. ********************/
    private ExceptionUtil(String errorMessage, Object tip) {
        super(errorMessage);
        this.tip = tip;
    }

    private ExceptionUtil(String errorMessage, Throwable cause) {
        super(String.join(SEPERTER, getMessage(errorMessage), getMessage(cause)), cause);
    }

    /******************** Constructor builder. ********************/
    /**
     * 获取异常实例.
     *
     * @param message 异常信息
     * @param tip 异常简单提示，专用于前台展示
     * @return ExceptionUtil
     */
    public static ExceptionUtil asException(String message, Object tip) {
        return new ExceptionUtil(message, tip);
    }

    /**
     * 获取异常实例.
     *
     * @param message 异常信息
     * @return ExceptionUtil
     */
    public static ExceptionUtil asException(String message) {
        return new ExceptionUtil(message, null);
    }

    /**
     * 获取异常实例.
     *
     * @param message 异常信息
     * @param cause Throwable 异常
     * @return ExceptionUtil
     */
    public static ExceptionUtil asException(String message, Throwable cause) {
        if (cause instanceof ExceptionUtil) {
            return (ExceptionUtil)cause;
        }
        return new ExceptionUtil(message, cause);
    }

    /**
     * 获取异常实例. </br>
     * 使用 cause 作为异常信息</br>
     *
     * @param cause Throwable 异常
     * @return ExceptionUtil
     */
    public static ExceptionUtil asException(Throwable cause) {
        if (cause instanceof ExceptionUtil) {
            return (ExceptionUtil)cause;
        }
        return new ExceptionUtil(getMessage(cause), cause);
    }

    /******************** checkArgument. ********************/
    /**
     * 检验异常.</br>
     * </br>
     * 当表达式为 false 时，抛出异常.</br>
     *
     * @param expression 检验表达式
     * @param message 异常信息
     */
    public static void checkArgument(Boolean expression, String message) {
        if (!expression) {
            throw new ExceptionUtil(message, null);
        }
    }

    /**
     * 检验异常.</br>
     * </br>
     * 当表达式为 false 时，抛出异常.</br>
     *
     * @param expression 检验表达式
     * @param msgFmt 异常信息模板，使用 String.format 占位符
     * @param args 占位符信息
     */
    public static void checkArgument(Boolean expression, String msgFmt, Object... args) {
        checkArgument(expression, String.format(msgFmt, args));
    }

    /**
     * 检验异常.</br>
     * </br>
     * 当表达式为 false 时，抛出异常.</br>
     * 
     * @param expression 检验表达式
     * @param tip 异常简单提示，专用于前台展示
     * @param message 异常信息
     */
    public static void checkArgument(Boolean expression, Object tip, String message) {
        if (!expression) {
            throw new ExceptionUtil(message, tip);
        }
    }

    /******************** checkNonNull. ********************/
    /**
     * 非 null 检验.</br>
     * </br>
     * 当 null 空时，返回该参数</br>
     *
     * @param <T> 被检参数类型泛型
     * @param obj 被检参数
     * @param message 异常信息
     * @return 被检参数
     */
    public static <T> T checkNonNull(T obj, String message) {
        if (Objects.isNull(obj)) {
            throw new ExceptionUtil(message, null);
        }
        return obj;
    }

    /**
     * 非 null 检验.</br>
     * </br>
     * 当非 null 时，返回该参数</br>
     *
     * @param <T> 被检参数类型泛型
     * @param obj 被检参数
     * @param msgFmt 异常信息模板，使用 String.format 占位符
     * @param args 占位符信息
     * @return 被检参数
     */
    public static <T> T checkNonNull(T obj, String msgFmt, Object... args) {
        return checkNonNull(obj, String.format(msgFmt, args));
    }

    /**
     * 非 null 检验.</br>
     * </br>
     * 当非 null 时，返回该参数</br>
     *
     * @param <T> 被检参数类型泛型
     * @param obj 被检参数
     * @param tip 异常简单提示，专用于前台展示
     * @param message 异常信息
     * @return 被检参数
     */
    public static <T> T checkNonNull(T obj, Object tip, String message) {
        if (Objects.isNull(obj)) {
            throw new ExceptionUtil(message, tip);
        }
        return obj;
    }
    
    /******************** checkNonBlank. ********************/
    /**
     * 非空检验.</br>
     * </br>
     * 当非空时，返回该参数.</br>
     * 非空指非 null 且 trim 后长度大于0</br>
     *
     * @param <T> 被检参数类型泛型
     * @param obj 被检参数
     * @param message 异常信息
     * @return 被检参数
     */
    public static <T> T checkNonBlank(T obj, String message) {
        if (Objects.isNull(obj) || 0 == String.valueOf(obj).trim().length()) {
            throw new ExceptionUtil(message, null);
        }
        return obj;
    }

    /**
     * 非空检验.</br>
     * </br>
     * 当非空时，返回该参数.</br>
     * 非空指非 null 且 trim 后长度大于0</br>
     *
     * @param <T> 被检参数类型泛型
     * @param obj 被检参数
     * @param msgFmt 异常信息模板，使用 String.format 占位符
     * @param args 占位符信息
     * @return 被检参数
     */
    public static <T> T checkNonBlank(T obj, String msgFmt, Object... args) {
        return checkNonBlank(obj, String.format(msgFmt, args));
    }
    
    /**
     * 非空检验.</br>
     * </br>
     * 当非空时，返回该参数.</br>
     * 非空指非 null 且 trim 后长度大于0</br>
     *
     * @param <T> 被检参数类型泛型
     * @param obj 被检参数
     * @param tip 异常简单提示，专用于前台展示
     * @param message 异常信息
     * @return 被检参数
     */
    public static <T> T checkNonBlank(T obj, Object tip, String message) {
        if (Objects.isNull(obj) || 0 == String.valueOf(obj).trim().length()) {
            throw new ExceptionUtil(message, tip);
        }
        return obj;
    }

    /******************** checkNonEmptyList. ********************/
    /**
     * list 非空校验.</br>
     * </br>
     * 当非空时，返回该 list.</br>
     * 非空指 list 非 null 且包含元素</br>
     *
     * @param <T> 被检参数类型泛型
     * @param obj 被检参数
     * @param message 异常信息
     * @return 被检参数
     */
    public static <T> List<T> checkNonEmptyList(List<T> objs, String message) {
        if (Objects.isNull(objs) || objs.isEmpty()) {
            throw new ExceptionUtil(message, null);
        }
        return objs;
    }

    /******************** Object method. ********************/
    /**
     * 获取提示信息.
     *
     * @return
     */
    public Object getTip() {
        return this.tip;
    }

    /**
     * 获取字符串型提示信息.
     *
     * @return
     */
    public String getTipString() {
        return String.valueOf(getTip());
    }

    /**
     * 获取异常信息.
     *
     * @param obj
     * @return
     */
    private static String getMessage(Object obj) {
        if (Objects.isNull(obj)) {
            return "";
        }

        if (obj instanceof Throwable) {
            StringWriter str = new StringWriter();
            PrintWriter pw = new PrintWriter(str);
            ((Throwable)obj).printStackTrace(pw);
            return str.toString();
        } else {
            return obj.toString();
        }
    }
}