Spring boot 優雅實現全局自定義異常

 

 

一、前言：

　　SpringBoot的項目已經對有一定的異常處理了，但是對於我們開發者而言可能就不太合適了，因此我們需要對這些異常進行統一的捕獲並處理。SpringBoot中有一個ControllerAdvice的注解，使用該注解表示開啟了全局異常的捕獲，我們只需在自定義一個方法使用ExceptionHandler注解然后定義捕獲異常的類型即可對這些捕獲的異常進行統一的處理。

二、目的

　　解決錯誤異常清晰、異常擴展性強、統一管理異常枚舉類。

　　看了網上一些自定義異常，覺得不是太適用項目，異常展示不是太清晰，自己寫了一套全局異常，只是為了解決開發者易於觀察，方便擴展，如有不足之處還望大佬賜教。

三、目錄截圖

 

 

 四、開始編碼

　　1.配置application.yml，方便開發者自定義開發模式，用於項目獲取模式，展示異常。

server:
  port: 80
#spring相關配置
spring:
  profiles:
    active: @spring.active@

　　2.異常枚舉基類，多個實現，用於統一管理異常枚舉類。

/**
 * 異常基類
 */
public interface BaseExceptionEnum {

  public  String getMessage();

}

　　3.鑒權模塊異常枚舉類、只定義了一個異常類，如果有其他模塊、可以定義多個實現BaseExceptionEnum ，用於異常管理，好找。

/**
 * 鑒權模塊異常----按照模塊划分
 */
public enum AuthExceptionEnum implements BaseExceptionEnum {
    /**
     * 賬號或密碼為空
     */
    USERNAME_PASS_NULL("賬號或密碼為空"),
    /**
     * 登錄驗證碼為空或過期
     */
    USER_VERIFICATION_CODE_NULL("登錄驗證碼為空或已過期"),
    /**
     * 登錄驗證碼錯誤
     */
    USER_VERIFICATION_CODE("登錄驗證碼錯誤"),
    /**
     * 登錄密碼錯誤
     */
    USERNAME_PASS_ERROR("登錄密碼錯誤"),
    /**
     * 登錄失敗
     */
    USER_LOGIN__ERROR("登錄失敗"),
    /**
     * 登錄用戶不存在
     */
    USER_NON_EXISTENT("登錄用戶不存在"),
    /**
     * 登錄用戶不存在
     */
    USER_HAS_BEEN_DELETE("登錄用戶不存在！"),
    /**
     * 登錄用戶已凍結
     */
    USER_FROZEN( "登錄用戶已凍結！");



    private final String message;

    AuthExceptionEnum(String message) {
        this.message = message;
    }
    AuthExceptionEnum(BaseExceptionEnum baseExceptionEnum) {
        this.message =baseExceptionEnum.getMessage();
    }

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

　　4.定義統一異常類

/**
 * 異常統一
 */
public class BaseException extends RuntimeException  {

    private static final long serialVersionUID = 1L;

    private final int code;
    private final String value;

    protected BaseException(int code, String message) {
        super(message);
        this.code = code;
        this.value = message;
    }
    public int getCode() {
        return this.code;
    }
}

　　5.自定義響應用戶異常類

/**
 * 用戶請求錯誤
 * 向用戶展示的異常錯誤對象 400 {"code":"1","message":"exception.message"}
 */
public class UserAlertException extends BaseException {

  public UserAlertException(String message) {
    super(1, message);
  }
  public UserAlertException(int code, String message) {
    super(code, message);
  }
  public UserAlertException(BaseExceptionEnum exceptionEnum) {
    super(1, exceptionEnum.getMessage());
  }
}

　　4.編寫開發模式工廠類獲取，方便擴展、易於維護。

/**
 * @ClassName: ExceptionPattern
 * @Description: 異常模式
 * @Author: fuzongle
 * @create: 2020-11-24 13:43
 **/
public class ExceptionPatternFactory {

    public Map<String, Function<Exception, ResponseResult>> map = new HashMap<>();

    {
        map.put("dev", this::dev);
        map.put("prod", this::prod);
    }

    //編寫生產環境的業務錯誤異常邏輯
    public ResponseResult prod(Exception e) {
        return ResponseResult.builder().build();
    }

    //編寫開發環境的業務錯誤異常邏輯
    public ResponseResult dev(Exception e) {
       return new ExceptionFactory().map.get(e.getClass().getName()).apply(e);
    }


}

　　5.編寫異常統一返回格式、打印日志工廠類、本身想把這個用在開發模式、線上模式在建一個類維護線上的異常、現在項目上線大部分異常看日志的話、阿里雲不是太方便、定位問題太慢，想集成存儲異常日志，提供ui展示、也是再次基礎上擴展生成模式即可。

/**
 * @ClassName: ExceptionPattern
 * @Description: 異常模式
 * @Author: fuzongle
 * @create: 2020-11-24 13:43
 **/
@Log4j2
public class ExceptionFactory {

  public Map<Object, Function<Object, ResponseResult>> map = new HashMap<>();

    {
        map.put(UserAlertException.class.getName(), this::UserAlertException);
        map.put(ArithmeticException.class.getName(), this::ArithmeticException);
    }


    /**
     * 用戶請求錯誤 像用戶展示
     */
    public  ResponseResult UserAlertException(Object e) {
        UserAlertException userAlertException = (UserAlertException) e;

        PrintlnErrorLog.printlnErrorLog("->>>自定義異常-給用戶展示錯誤對象",
                ErrorUtils.getStackTrace(userAlertException),
                userAlertException.getStackTrace()[0]);

        return  ResponseResult.builder().code(userAlertException.getCode()).message(userAlertException.getMessage()).build();
    }

    /**
     * 算術運算異常
     */
    public  ResponseResult ArithmeticException(Object e) {
        ArithmeticException userAlertException = (ArithmeticException) e;

        PrintlnErrorLog.printlnErrorLog("->>>算術運算異常",
                ErrorUtils.getStackTrace(userAlertException),
                userAlertException.getStackTrace()[0]);

        return  ResponseResult.builder().code(HttpStatus.BAD_REQUEST.value()).message(userAlertException.getMessage()).build();
    }



}

　　5.打印異常日志、方法、可以提供開發者快速定位問題。

    /**
     * 異常日志
     */
    public static void printlnErrorLog(String title,String errInfo,StackTraceElement stackTraceElement) {

        log.info("\n-----------------------異常分析 start-----------------------------------\n\t" +
                        "異常標題:{}\n\t" +
                        "文件名:{}\n\t" +
                        "類名:{}\n\t" +
                        "方法名:{}\n\t" +
                        "拋出異常行號:{}\n\t" +
                        "異常棧信息:{}\n\t" +
                        "解決方案: {}\n" +
                        "------------------異常分析 end ---------------------------------------",
                title,
                stackTraceElement.getFileName(),
                stackTraceElement.getClassName(),
                stackTraceElement.getMethodName(),
                stackTraceElement.getLineNumber(),
                errInfo,
                "暫無");
    }

　　6.實現全局控制器通知、全局捕獲異常、統一返回方式。@ExceptionHandler 攔截了異常，我們可以通過該注解實現自定義異常處理。其中，@ExceptionHandler 配置的 value 指定需要攔截的異常類型，上面攔截了 Exception.class 這種異常。

/**
 * @ClassName: ExceptionPattern
 * @Description: 全局異常配置
 * @Author: fuzongle
 * @create: 2020-11-25 12:43
 **/
@Slf4j
@RestControllerAdvice
public class GlobalExceptionHandler {


    /**
     * 獲取開發模式、生產模式、默認dev
     */
    @Value("${spring.profiles.active}")
    private String var;

    /**
     * 全局異常.
     */
    @ExceptionHandler(Exception.class)
    public ResponseEntity<ResponseResult> handleGlobalException(Exception e) {
        ResponseResult apply = new ExceptionPatternFactory().map.get(var).apply(e);
        int httpStatus = Objects.equals(HttpStatus.INTERNAL_SERVER_ERROR.value(), apply.getCode()) ? HttpStatus.INTERNAL_SERVER_ERROR.value() : HttpStatus.BAD_REQUEST.value();
        return new ResponseEntity<>(apply, HttpStatus.valueOf(httpStatus));
    }


}

五、測試異常

　　1.直接編寫API瀏覽器請求看結果。

/**
 * @Description: 測試
 **/
@RestController
public class ErrorController {

    /**
     * 自定義異常測試
     * @return
     */
    @RequestMapping("/test")
    public String test() {
        throw new UserAlertException(AuthExceptionEnum.USER_FROZEN);
    }

    /**
     * 系統捕獲的異常
     */
    @RequestMapping("/ArithmeticException")
    public void ArithmeticException() {
        System.out.println(1/0);
    }
}

　　2.響應結果,結果非常清晰，可以在開發的地方遇見異常記錄異常維護、ExceptionFactory維護異常，百度找到的解決方案可以再次記錄，方便下次不在忘記錯誤，提高了開發效率。

 

 

 

六、溫馨提示

1.如果有任何不懂的地方可以咨詢我，隨時歡迎互相幫助，如果寫的不好的地方請大佬指教。

2.技術交流群QQ：422167709。

3.如果希望學習更多，希望微信掃碼，長按掃碼，幫忙關注一下，舉手之勞，當您無助的時候真的能幫你。

4.獲取源代碼:掃碼關注。回復任意字符、加作者微信秒發源碼。