SpringBoot異常處理統一封裝我來作-使用篇

SpringBoot異常處理統一封裝我來作-使用篇

簡介

重複功能我來寫。在 SpringBoot 項目裏都有全局異常處理以及返回包裝等，返回前端是帶上succ、code、msg、data等字段。單個項目狀況下很好解決，當微服務模塊多的狀況下，不少狀況開發都是複製原有代碼進行構建另一個項目的，致使這些功能升級須要修改多個服務，在這個基礎上，咱們封裝了一個組件 unified-dispose-springboot-starter 裏面包含了一些基礎的異常處理以及返回包裝功能。

依賴添加啓動功能

添加依賴
ps: 實際version版本請使用最新版
最新版本:

點擊查看最新新版本

<dependency>
  <groupId>com.purgeteam</groupId>
  <artifactId>unified-dispose-springboot-starter</artifactId>
  <version>0.1.1.RELEASE</version>
</dependency>

啓動類添加 @EnableGlobalDispose 註解開啓如下功能。

@EnableGlobalDispose
@SpringBootApplication
public class GlobalDisposeSpringBootApplication {

  public static void main(String[] args) {
    SpringApplication.run(GlobalDisposeSpringBootApplication.class, args);
  }

}

One 異常處理⚠️

在項目中常常出現系統異常的狀況，好比NullPointerException等等。若是默認未處理的狀況下，springboot會響應默認的錯誤提示，這樣對用戶體驗不是友好，系統層面的錯誤，用戶不能感知到，即便爲500的錯誤，能夠給用戶提示一個相似服務器開小差的友好提示等。

模塊裏以及包含了一些基本的異常處理方式(及不須要作任何代碼編寫已經具備基本異常處理)，以及一些常見的異常code，用戶只須要關心業務異常處理便可，直接經過 throw new 異常 的方式拋出便可。

異常處理包含類型

# 通用500異常
Exception 類捕獲 500 異常處理

# Feign 異常
FeignException 類捕獲
ClientException 類捕獲

# 業務自定義
BusinessException 類捕獲 業務通用自定義異常

# 參數校驗異常
HttpMessageNotReadableException 參數錯誤異常
BindException 參數錯誤異常

程序主動拋出異常

throw new BusinessException(BusinessErrorCode.BUSINESS_ERROR);
// 或者
throw new BusinessException("CLOUD800","沒有多餘的庫存");

一般不建議直接拋出通用的BusinessException異常，應當在對應的模塊裏添加對應的領域的異常處理類以及對應的枚舉錯誤類型。

如會員模塊：
建立UserException異常類、UserErrorCode枚舉、以及UserExceptionHandler統一攔截類。

UserException:

@Data
public class UserException extends RuntimeException {

  private String code;
  private boolean isShowMsg = true;

  /**
   * 使用枚舉傳參
   *
   * @param errorCode 異常枚舉
   */
  public UserException(UserErrorCode errorCode) {
    super(errorCode.getMessage());
    this.setCode(errorCode.getCode());
  }

}

UserErrorCode:

@Getter
public enum UserErrorCode {
    /**
     * 權限異常
     */
    NOT_PERMISSIONS("CLOUD401","您沒有操做權限"),
    ;

    private String code;

    private String message;

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

UserExceptionHandler:

@Slf4j
@RestControllerAdvice
public class UserExceptionHandler {

  /**
   * UserException 類捕獲
   */
  @ExceptionHandler(value = UserException.class)
  public Result handler(UserException e) {
    log.error(e.getMessage(), e);
    return Result.ofFail(e.getCode(), e.getMessage());
  }

}

最後業務使用以下：

// 判斷是否有權限拋出異常
throw new UserException(UserErrorCode.NOT_PERMISSIONS);

上述方式，拋出異常後會被模塊處理。前臺返回以下：

{
  "succ": false,        // 是否成功
  "ts": 1566467628851,  // 時間戳
  "data": null,         // 數據
  "code": "CLOUD800",   // 錯誤類型
  "msg": "業務異常",    // 錯誤描述
  "fail": true
}

Tow 統一返回封🗳

在REST風格的開發中，避免一般會告知前臺返回是否成功以及狀態碼等信息。這裏咱們一般返回的時候作一次util的包裝處理工做，如：Result相似的類，裏面包含succ、code、msg、data等字段。

接口調用處理相似以下:

@GetMapping("hello")
  public Result list(){
    return Result.ofSuccess("hello");
  }

結果:

{
  "succ": ture,         // 是否成功
  "ts": 1566467628851,  // 時間戳
  "data": "hello",      // 數據
  "code": null,         // 錯誤類型
  "msg": null,          // 錯誤描述
  "fail": true
}

功能使用

默認狀況全部的 web controller 都會被封裝爲一下返回格式。

接口：

@GetMapping("test")
public String test(){
  return "test";
}

返回

{
  "succ": true,             // 是否成功
  "ts": 1566386951005,      // 時間戳
  "data": "test",           // 數據
  "code": null,             // 錯誤類型
  "msg": null,              // 錯誤描述
  "fail": false             
}

忽略封裝註解:@IgnorReponseAdvice

@IgnorReponseAdvice容許範圍爲：類 + 方法，標識在類上這個類下的說有方法的返回都將忽略返回封裝。

接口：

@IgnorReponseAdvice // 忽略數據包裝 可添加到類、方法上
@GetMapping("test")
public String test(){
  return "test";
}

返回 test

總結

項目裏不少重複的code，咱們能夠經過必定的方式去簡化，以達到必定目的減小開發量。PurgeTeam 具備一些優秀的開源組件，減小平常的開發量。

示例代碼地址: unified-dispose-springboot

做者GitHub:
Purgeyao 歡迎關注

qq交流羣: 812321371 微信交流羣: MercyYao

微信公衆號: