springboot下新增全域性異常處理和自定義異常處理

Scotyzh發表於2023-12-11
Spring Boot

前言

在spring專案中，優雅處理異常，好處是可以將系統產生的全部異常統一捕獲處理，自定義的異常也由全域性異常來捕獲，如果涉及到validator引數校驗器使用全域性異常捕獲也是較為方便。

相關程式碼：

GlobalExceptionHandler類：

@Slf4j
@RestControllerAdvice
public class GlobalExceptionHandler {

    /********************************
     *  @function  : 自定義從捕捉
     *  @parameter : [e:CustomException | 自定義異常]
     *  @date      : 2023/12/5 11:47
     ********************************/
    @ExceptionHandler(value = CustomException.class)
    public AjaxResult customExceptionHandler(HttpServletRequest request, CustomException e) {
        log.error("業務異常，url：{}, 異常內容：{}" ,request.getRequestURI(), e);
        return new AjaxResult(e.getCode() , e.getMessage(), null);
    }

    /********************************
     *  @function  : 空指標異常捕捉
     *  @parameter : [e：Exception | 異常]
     *  @date      : 2023/12/5 11:47
     ********************************/
    @ExceptionHandler(value = Exception.class)
    public AjaxResult exceptionHandler(HttpServletRequest request, Exception e) {
        log.error("伺服器內部異常異常，url：{}, 異常內容：{}" ,request.getRequestURI(), e);
        return new AjaxResult(500 , e.getMessage(), null);
    }

}

自定義異常CustomException類：

@Slf4j
@Data
public class CustomException extends RuntimeException{

    //錯誤碼
    private int code;

    //錯誤資訊
    private String message;


    public CustomException() {
        super();
    }

    public CustomException(ResultCodeEnum resultCodeEnum) {
        super(String.valueOf(resultCodeEnum.getCode()));
        this.code = resultCodeEnum.getCode();
        this.message = resultCodeEnum.getMessage();
    }

}

通用返回類：AjaxResult

@Data
public class AjaxResult extends HashMap<String, Object> {

    // 狀態碼
    private static final String CODE_TAG = "code";

    // 返回訊息
    private static final String MSG_TAG = "message";

    // 資料物件
    private static final String DATA_TAG = "data";

    public AjaxResult(int code, String message, Object data)
    {
        super.put(CODE_TAG, code);
        super.put(MSG_TAG, message);
        if (data != null)
        {
            super.put(DATA_TAG, data);
        }
    }

    /********************************
     *  @method    : success
     *  @function  : 返回成功訊息（過載）
     *  @parameter :
     *  @return    : AjaxResult
     ********************************/
    public static AjaxResult success(){
        return new AjaxResult(ResultCodeEnum.SUCCESS.getCode(), ResultCodeEnum.SUCCESS.getMessage(), null);
    }

    /********************************
     *  @method    : success
     *  @function  : 返回成功訊息（過載）
     *  @parameter : message : String | 返回訊息
     *  @return    : AjaxResult
     ********************************/
    public static AjaxResult success(String message){
        return new AjaxResult(ResultCodeEnum.SUCCESS.getCode(), message, null);
    }

    /********************************
     *  @method    : success
     *  @function  : 返回成功訊息（過載）
     *  @parameter : data : Object | 資料物件
     *  @return    : AjaxResult
     ********************************/
    public static AjaxResult success(Object data){
        return new AjaxResult(ResultCodeEnum.SUCCESS.getCode(), ResultCodeEnum.SUCCESS.getMessage(), data);
    }

    /********************************
     *  @method    : success
     *  @function  : 返回成功訊息（過載）
     *  @parameter : message : String | 返回訊息
     *  @parameter : data : Object | 資料物件
     *  @return    : AjaxResult
     ********************************/
    public static AjaxResult success(String message, Object data){
        return new AjaxResult(ResultCodeEnum.SUCCESS.getCode(), message, data);
    }

    /********************************
     *  @method    : failed
     *  @function  : 返回失敗訊息（過載）
     *  @parameter :
     *  @return    : AjaxResult
     ********************************/
    public static AjaxResult failed(){
        return new AjaxResult(ResultCodeEnum.FAILED.getCode(), ResultCodeEnum.FAILED.getMessage(), null);
    }

    /********************************
     *  @method    : failed
     *  @function  : 返回失敗訊息（過載）
     *  @parameter : message : String | 返回訊息
     *  @return    : AjaxResult
     ********************************/
    public static AjaxResult failed(String message){
        return new AjaxResult(ResultCodeEnum.FAILED.getCode(), message, null);
    }

    /********************************
     *  @method    : failed
     *  @function  : 返回失敗訊息（過載）
     *  @parameter : resultCodeEnum : ResultCodeEnum | 失敗列舉型別
     *  @return    : AjaxResult
     ********************************/
    public static AjaxResult failed(ResultCodeEnum resultCodeEnum){
        return new AjaxResult(resultCodeEnum.getCode(), resultCodeEnum.getMessage(), null);
    }

    /********************************
     *  @method    : failed
     *  @function  : 返回失敗訊息（過載）
     *  @parameter : message : String | 返回訊息
     *  @parameter : data : Object | 資料物件
     *  @return    : AjaxResult
     ********************************/
    public static AjaxResult failed(String message, Object data){
        return new AjaxResult(ResultCodeEnum.FAILED.getCode(), message, data);
    }

    /********************************
     *  @method    : failed
     *  @function  : 返回失敗訊息（過載）
     *  @parameter : resultCodeEnum : ResultCodeEnum | 失敗列舉型別
     *  @parameter : data : Object | 資料物件
     *  @return    : AjaxResult
     ********************************/
    public static AjaxResult failed(ResultCodeEnum resultCodeEnum, Object data){
        return new AjaxResult(resultCodeEnum.getCode(), resultCodeEnum.getMessage(), data);
    }
}

列舉類ResultCodeEnum：

public enum ResultCodeEnum {

    // 10??? 通用
    SUCCESS(10000,"請求成功"),
    FAILED(10008, "請求失敗"),
    FAILED_PARAM_ERROR(10009, "引數錯誤"),
...
    private Integer code;

    private String message;

    ResultCodeEnum(Integer code, String message) {
        this.code = code;
        this.message = message;
    }

    public int getCode(){
        return code;
    }

    public String getMessage(){
        return message;
    }

}

使用：

在controller裡面判斷值是否異常，如果異常則直接丟擲異常不進行執行，終止當前的流程，在service層也可以這樣處理。


    public AjaxResult getUserInfo(@RequestParam(value = "userId") Integer userId) {
        if （userId == 0) {
            throw new CustomException(ResultCodeEnum.NOT_EXIST_USER_ERROR);
        }
        ...
    }

再者是一些數值上的錯誤，比如除0，這種情況會被全域性異常捕獲，並返回相應的錯誤給到前端


    @GetMapping("/test")
    public AjaxResult test(){
        int i = 60/0;
        return AjaxResult.success();
    }

相關文章