Java自定义Exception设计

前言

1.Throwable、Exception、RuntimeException
　　　　　　　　　　　　
　　　　　　　　　(java.lang.Throwable、java.lang.Exception、java.lang.Error、java.lang.RuntimeException)
1）Throwable：所有Error和Exception的父类。只有Throwable与其子类才能被JVM或throw关键字抛出、被catch语句捕捉。 Throwable主要包含了该类被创建时当前线程的执行信息。
2）Error：程序运行时出现的系统错误或资源错误，代码无法捕获、处理，如栈溢出(StackOverFlowError)、内存溢出(OutOfMemoryError)等。
3）Exception：代码编写引起的异常，代码可以捕获并处理。Exception分为受检异常和非受检异常。
　a.Checked：除RuntimeException(及其子类)外的所有Exception，此类异常编译器会强制要求处理。如IOException、SQLException。
　b.Unchecked：RuntimeException及其子类，此类异常是程序员代码问题造成的的，编译器不强制要求处理，JVM会处理。如NullPointerException。
综上，自定义异常是哪种类型可自由决定，若不强制要求调用者处理抛出的异常则继承RuntimeException，反之继承Exception。本文选择继承RuntimeException
2.应在方法签名处抛出异常还是在方法中捕获处理异常？
　原则是：捕捉并处理知道如何处理的异常，抛出不知如何处理的异常。

设计

1.异常类只需提供异常码和异常信息两类数据即可，异常码可以用来定位发生异常代码所在的位置(反向搜索)，异常信息用来提示用户。
2.异常码数量会逐渐增多，因此定义StatusCode接口，所有异常码类实现此接口即可。

class Exception extends RuntimeException{           //伪代码
    StatusCode code;         //异常码
    String message;          //异常信息
}

Exception与上篇中的Response设计基本相同，二者的响应码(异常码)部分可以共用

一、StatusCode

1.StatusCode接口定义了异常码相关的规范，包含两个方法，分别用于返回异常码和异常信息。
2.后续所有的异常码类实现StatusCode即可。
（StatusCode与统一Response中的相同，同一项目中可重用）

public interface StatusCode extends Serializable {
    @JsonValue       //序列化时只显示code，message以DefaultException中的为准
    int code();

    String message();
}

二、ErrorStatus

1.ErrorStatus是一个简单的异常码枚举类，仅仅定义了四种简单的异常码。
2.后续其他的业务异常码可写在此类中，或者仿照此类定义一个新的异常码枚举类。

public enum ErrorStatus implements StatusCode{

    PARAMETER_MISSING(10001,"Missing required parameter"),
    PARAMETER_INVALID(10002,"Invalid parameter"),
    RESOURCE_NOT_FOUND(10003,"Resource not found"),
    REQUEST_THIRD_PARTY_FAILED(10004,"Request third-party system failed");

    private final int code;
    private final String message;

    ErrorStatus(int code, String message) {
        this.code = code;
        this.message = message;
    }

    @Override
    public int code() {
        return code;
    }

    @Override
    public String message() {
        return message;
    }

    @Override
    public String toString() {
        return String.valueOf(this.code);
    }
}

三、DefaultException

1.DefaultException是用于表示代码异常的类，不可被继承，在所有需要抛出自定义异常的代码处使用此类即可。
2.DefaultException有两个属性：code(异常码)、message(异常信息)。
3.DefaultException中设置了五个重载构造器，可以灵活使用。由于重写了getMessage()方法，所以构造器中不用调用super(message)。

public final class DefaultException extends RuntimeException {

    private static final long serialVersionUID = -8618092465858207782L;

    private StatusCode code;
    private String message;

    public DefaultException(StatusCode code) {
        this.code = code;
        this.message = code.message();
    }

    public DefaultException(String message) {
        this.code = ErrorStatus.INTERNAL_ERROR;
        this.message = message;
    }

    public DefaultException(StatusCode code, String message) {
        this.code = code;
        this.message = message;
    }

    public DefaultException(StatusCode code, Throwable cause) {
        super(cause);
        this.code = code;
        this.message = code.message();
    }

    public DefaultException(StatusCode code, String message, Throwable cause) {
        super(cause);
        this.code = code;
        this.message = message;
    }

    public StatusCode getCode() {
        return code;
    }

    @Override
    public String getMessage() {
        return message;
    }
}

四、使用

public void verify(String param, int type) {
    if (param.isEmpty()) 
        throw new DefaultException(ErrorStatus.PARAMETER_MISSING);
    if (type != 0 && type != 1 && type != 2)
        throw new DefaultException(ErrorStatus.PARAMETER_INVALID, "Type can only be 1 or 2");
}

五、问题

1.DefaultException与BaseResponse有什么区别？
　本质上的区别是DefaultException是一个Exception类，而BaseResponse只是一个普通类。
　其实二者功能有点相似，都是一种返回值的体现。BaseResponse是成功的返回，而DefaultException可以看作是失败的返回。

小知识

问：Java类中的Fields和Properties有什么区别？
答：Fields —— 成员变量，可直接访问(意味着访问控制符必须为public)。例，下图中pi是成员变量。
　　Properties —— 属性，需通过get/set访问。例，下图中name、AGE、gender是属性。
注：属性的名字是由get/set后的字符串决定的。例：属性名为AGE而不是age。