摘要：全局異常處理類(lèi)用于全局返回，如需返回請(qǐng)使用繼承了，對(duì)于一些類(lèi)似于請(qǐng)求方式異常的異常進(jìn)行捕獲重寫(xiě)，自定義處理過(guò)程這里將異常直接傳給方法進(jìn)行處理，返回值為保證友好的返回，而不是出現(xiàn)錯(cuò)誤碼。

異常的處理在我們的日常開(kāi)發(fā)中是一個(gè)繞不過(guò)去的坎，在Spring Boot 項(xiàng)目中如何優(yōu)雅的去處理異常，正是我們這一節(jié)課需要研究的方向。

在一個(gè)Spring Boot項(xiàng)目中，我們可以把異常分為兩種，第一種是請(qǐng)求到達(dá)Controller層之前，第二種是到達(dá)Controller層之后項(xiàng)目代碼中發(fā)生的錯(cuò)誤。而第一種又可以分為兩種錯(cuò)誤類(lèi)型：1. 路徑錯(cuò)誤 2. 類(lèi)似于請(qǐng)求方式錯(cuò)誤，參數(shù)類(lèi)型不對(duì)等類(lèi)似錯(cuò)誤。

為了保持返回值的統(tǒng)一，我們這里定義了統(tǒng)一返回的類(lèi)ReturnVO，以及一個(gè)記錄錯(cuò)誤返回碼和錯(cuò)誤信息的枚舉類(lèi)ReturnCode，而具體的錯(cuò)誤信息和錯(cuò)誤代碼保存到了response.properties中，使用流進(jìn)行讀取。

public class ReturnVO {

    private static Properties properties = ReadPropertiesUtil.getProperties(System.getProperty("user.dir") + CommonUrl.RESPONSE_PROP_URL);

    /**
     * 返回代碼
     */
    private String code;

    /**
     * 返回信息
     */
    private String message;

    /**
     * 返回?cái)?shù)據(jù)
     */
    private Object data;


    public Object getData() {
        return data;
    }

    public void setData(Object data) {
        this.data = data;
    }

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }

    public String getCode() {
        return code;
    }

    public void setCode(String code) {
        this.code = code;
    }

    /**
     * 默認(rèn)構(gòu)造，返回操作正確的返回代碼和信息
     */
    public ReturnVO() {
        this.setCode(properties.getProperty(ReturnCode.SUCCESS.val()));
        this.setMessage(properties.getProperty(ReturnCode.SUCCESS.msg()));
    }

    /**
     * 返回代碼，這里需要在枚舉中去定義
     * @param code
     */
    public ReturnVO(ReturnCode code) {
        this.setCode(properties.getProperty(code.val()));
        this.setMessage(properties.getProperty(code.msg()));
    }

    /**
     * 返回?cái)?shù)據(jù)，默認(rèn)返回正確的code和message
     * @param data
     */
    public ReturnVO(Object data) {
        this.setCode(properties.getProperty(ReturnCode.SUCCESS.val()));
        this.setMessage(properties.getProperty(ReturnCode.SUCCESS.msg()));
        this.setData(data);
    }

    /**
     * 返回錯(cuò)誤的代碼，以及自定義的錯(cuò)誤信息
     * @param code
     * @param message
     */
    public ReturnVO(ReturnCode code, String message) {
        this.setCode(properties.getProperty(code.val()));
        this.setMessage(message);
    }

    /**
     * 返回自定義的code，message，以及data
     * @param code
     * @param message
     * @param data
     */
    public ReturnVO(ReturnCode code, String message, Object data) {
        this.setCode(code.val());
        this.setMessage(message);
        this.setData(data);
    }

    @Override
    public String toString() {
        return "ReturnVO{" +
                "code="" + code + """ +
                ", message="" + message + """ +
                ", data=" + data +
                "}";
    }
}

其他的錯(cuò)誤處理只需要在枚舉類(lèi)中添加對(duì)應(yīng)的異常即可，枚舉的名稱(chēng)要定義為異常的名稱(chēng)，這樣可以直接不用對(duì)其他的代碼進(jìn)行修改，添加一個(gè)新的異常時(shí)，僅僅添加枚舉類(lèi)中的字段和properties文件中的屬性。

public enum ReturnCode {

    /** 操作成功 */
    SUCCESS("SUCCESS_CODE", "SUCCESS_MSG"),

    /** 操作失敗 */
    FAIL("FAIL_CODE", "FAIL_MSG"),

    /** 空指針異常 */
    NullPointerException("NPE_CODE", "NPE_MSG"),

    /** 自定義異常之返回值為空 */
    NullResponseException("NRE_CODE", "NRE_MSG"),

    /** 運(yùn)行時(shí)異常 */
    RuntimeException("RTE_CODE","RTE_MSG"),

    /** 請(qǐng)求方式錯(cuò)誤異常 */
    HttpRequestMethodNotSupportedException("REQUEST_METHOD_UNSUPPORTED_CODE","REQUEST_METHOD_UNSUPPORTED_MSG"),

    /** INTERNAL_ERROR */
    BindException("BIND_EXCEPTION_CODE","BIND_EXCEPTION_MSG"),

    /** 頁(yè)面路徑不對(duì) */
    UrlError("UE_CODE","UE_MSG");

    private ReturnCode(String value, String msg){
        this.val = value;
        this.msg = msg;
    }

    public String val() {
        return val;
    }

    public String msg() {
        return msg;
    }

    private String val;
    private String msg;
}

這里我自定義了一些異常用于后面的測(cè)試，在我們實(shí)際的項(xiàng)目中需要定義很多的異常去完善。

SUCCESS_CODE=2000
SUCCESS_MSG=操作成功

FAIL_CODE=5000
FAIL_MSG=操作失敗

NPE_CODE=5001
NPE_MSG=空指針異常

NRE_CODE=5002
NRE_MSG=返回值為空

RTE_CODE=5001
RTE_MSG=運(yùn)行時(shí)異常

UE_CODE=404
UE_MSG=頁(yè)面路徑有誤

REQUEST_METHOD_UNSUPPORTED_CODE=4000
REQUEST_METHOD_UNSUPPORTED_MSG=請(qǐng)求方式異常

BIND_EXCEPTION_CODE=4001
BIND_EXCEPTION_MSG=請(qǐng)求參數(shù)綁定失敗

這里的路徑錯(cuò)誤處理方式是采用了實(shí)現(xiàn)ErrorController接口，然后實(shí)現(xiàn)了getErrorPath()方法：

/**
 * 請(qǐng)求路徑有誤
 * @author yangwei
 * @since 2019-01-02 18:13
 */
@RestController
public class RequestExceptionHandler implements ErrorController {

    @Override
    public String getErrorPath() {
        return "/error";
    }

    @RequestMapping("/error")
    public ReturnVO errorPage(){
        return new ReturnVO(ReturnCode.UrlError);
    }
}

這里可以進(jìn)行測(cè)試一下：

類(lèi)似于到達(dá)Controller之前的請(qǐng)求參數(shù)錯(cuò)誤，請(qǐng)求方式錯(cuò)誤，數(shù)據(jù)格式不對(duì)等等錯(cuò)誤都?xì)w類(lèi)為一種，這里僅僅展示請(qǐng)求方式錯(cuò)誤的處理方式。

/**
 * 全局異常處理類(lèi)
 * @author yangwei
 *
 * 用于全局返回json，如需返回ModelAndView請(qǐng)使用ControllerAdvice
 * 繼承了ResponseEntityExceptionHandler，對(duì)于一些類(lèi)似于請(qǐng)求方式異常的異常進(jìn)行捕獲
 */
@RestControllerAdvice
public class GlobalExceptionHandler extends ResponseEntityExceptionHandler {

    private static Properties properties = ReadPropertiesUtil.getProperties(System.getProperty("user.dir") + CommonUrl.RESPONSE_PROP_URL);

    /**
     * 重寫(xiě)handleExceptionInternal，自定義處理過(guò)程
     **/
    @Override
    protected ResponseEntity