Spring Boot入門（四）全局異常處理

時間 2019-11-24

原文原文鏈接

1、先後端調用關係

一般狀況下，先後端調用關係以下:java

後端服務的入口爲Controller，而後調用Service，如涉及到數據庫訪問則調用DAO。在每一層都有可能拋出異常，有的是系統異常，有的是封裝後的業務異常，例如用戶密碼錯誤，用戶號碼不存在都屬於業務異常，須要封裝後返回。爲了方便異常處理，能夠從底層一直向上拋，在返回客戶端前再統一處理。

2、統一異常處理

當全部的客戶端調用的入口都必須通過Controller時，能夠攔截Controller進行處理，類結構以下:web

代碼參考以下：
1.GlobalExceptionHandler.java
攔截返回給客戶端的異常進行處理。spring

import com.javashizhan.domain.Response;
import com.javashizhan.exception.ThrowableHandler;
import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.ResponseStatus;

/** * @ClassName GlobalExceptionHandler * @Description 全局異常處理，捕捉全部Controller拋出的異常， @ResponseBody註解必須加上，不然會跳到默認的錯誤頁 * @Author 鏗燃一葉 * @Date 2019/9/28 23:24 * @Version 1.0 * javashizhan.com **/
@ControllerAdvice
@ResponseBody
public class GlobalExceptionHandler {

    /** * 默認返回HttpStatus.OK, 這裏不是必須的，若是返回其餘狀態碼纔有必要加上 * @param e * @return 封裝後的應答對象 */
    @ResponseStatus(HttpStatus.OK)
    @ExceptionHandler({Throwable.class})
    public Response handle(Throwable e) {
        return ThrowableHandler.handle(e);
    }
}
複製代碼

2.ThrowableHandler.java
對異常進行處理，和GlobalExceptionHandler類解耦，這樣當非Controller做爲調用入口類時也能夠複用。數據庫

import java.io.PrintWriter;
import java.io.StringWriter;
import com.javashizhan.domain.Response;

/** * @ClassName ThrowableHandler * @Description 異常處理類，將異常轉換爲統一應答對象 * @Author 鏗然一葉 * @Date 2019/9/28 23:30 * @Version 1.0 * javashizhan.com **/
public class ThrowableHandler {

    private ThrowableHandler() {}

    public static Response handle(Throwable t) {
        Response response = new Response();
        response.setStatus(Response.STAUTS_FAILED);
        response.setErrorMsg(t.getMessage());
        response.setErrorStack(getErrorStack(t));
        return response;
    }

    private static String getErrorStack(Throwable t) {
        if (null != t) {
            PrintWriter pw = null;
                StringWriter sw = new StringWriter();
                pw = new PrintWriter(sw);
                t.printStackTrace(pw);
                return sw.toString();
        }
        return "";
    }
}
複製代碼

3.Response.java
異常轉換結果，無論是否有異常，此類均可以使用。後端

/** * @ClassName A * @Description TODO * @Author 鏗然一葉 * @Date 2019/9/28 23:24 * @Version 1.0 * javashizhan.com **/
public final class Response<T> {

    /** 應答狀態-成功 */
    public static final int STAUTS_OK = 0;

    /** 應答狀態-失敗 */
    public static final int STAUTS_FAILED = 1;

    /** 默認錯誤碼 */
    public static final String DEFAULT_ERROR_CODE = "UNKNOWN-000";

    /** 應答狀態 */
    private int status = STAUTS_OK;

    /** 應答錯誤碼，有錯誤時返回 */
    private String errorCode = DEFAULT_ERROR_CODE;

    /** 應答錯誤消息，有錯誤時返回 */
    private String errorMsg;

    /** 應答錯誤碼，有錯誤時返回 */
    private String errorStack;

    /** 應答結果，存放業務應答內容 */
    private T result;

    public int getStatus() {
        return status;
    }

    public void setStatus(int status) {
        this.status = status;
    }

    public String getErrorCode() {
        return errorCode;
    }

    public void setErrorCode(String errorCode) {
        this.errorCode = errorCode;
    }

    public String getErrorMsg() {
        return errorMsg;
    }

    public void setErrorMsg(String errorMsg) {
        this.errorMsg = errorMsg;
    }

    public String getErrorStack() {
        return errorStack;
    }

    public void setErrorStack(String errorStack) {
        this.errorStack = errorStack;
    }

    public T getResult() {
        return result;
    }

    public void setResult(T result) {
        this.result = result;
    }
}
複製代碼

4.TestGlobalExceptionController.java
驗證類。微信

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

/** * @ClassName TestGlobalExceptionController * @Description TODO * @Author 鏗然一葉 * @Date 2019/9/29 1:15 * @Version 1.0 * javashizhan.com **/
@RestController
public class TestGlobalExceptionController {

    @GetMapping("testGlobalException")
    public void exec() throws Exception {
        throw new Exception("Error occurred");
    }
}
複製代碼