SpringCloud異常處理統一封裝我來做-使用篇

  • 2020 年 5 月 23 日
  • 筆記

SpringCloud異常處理統一封裝我來做-使用篇

簡介

重複功能我來寫。在 SpringBoot 項目里都有全局異常處理以及返回包裝等，返回前端是帶上succ、code、msg、data等欄位。單個項目情況下很好解決，當微服務模組多的情況下，很多情況開發都是複製原有程式碼進行構建另外一個項目的，導致這些功能升級需要修改多個服務，在這個基礎上，我們封裝了一個組件 unified-dispose-spring-cloud-starter 裡面包含了一些基礎的異常處理以及返回包裝功能。

依賴添加啟動功能

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

點擊查看最新新版本

<dependency>
  <groupId>com.purgeteam.cloud</groupId>
  <artifactId>unified-dispose-spring-cloud-starter</artifactId>
  <version>0.3.0.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枚舉。

UserException:

繼承 BusinessException

/**
 * {@link RuntimeException} user 業務異常
 *
 * @author purgeyao
 * @since 1.0
 */
@Getter
public class UserException extends BusinessException {

  private String code;
  private boolean isShowMsg = true;

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

}

UserErrorCode:

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

    private String code;

    private String message;

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

最後業務使用如下：

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

上述方式，拋出異常後會被模組處理。前台返回如下：

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

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,              // 錯誤描述
}

忽略封裝註解 @IgnoreResponseAdvice

public @interface IgnoreResponseAdvice {

    /**
     * 是否進行全局異常處理封裝
     * @return true:進行處理;  false:不進行異常處理
     */
    boolean errorDispose() default true;

}

@IgnoreResponseAdvice允許範圍為：類 + 方法，標識在類上這個類下的所有方法的返回都將忽略返回封裝。

介面：

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

返回 test

FeignClient 調用異常返回處理

默認 FeignClient 調用異常會返回 FeignException 500 異常，由於開啟了統一異常處理，被調用方feign異常會被處理為包裝過後結果返回。

服務端：

@Override
public Boolean testBoolean() throws Exception {
    throw new Exception("模擬異常");
}

調用端：

@GetMapping("testBoolean")
public Boolean testBoolean() throws Exception {
    // 調用服務端異常
    // 如果服務端不添加 @IgnoreResponseAdvice(errorDispose = false) 會出現下面異常
    // There was an unexpected error (type=Internal Server Error, status=500).
    // Error while extracting response for type [class java.lang.Boolean] and content type [application/json;charset=UTF-8]; nested exception is org.springframework.http.converter.HttpMessageNotReadableException: JSON parse error: Cannot deserialize instance of `java.lang.Boolean` out of START_OBJECT token; nested exception is com.fasterxml.jackson.databind.exc.MismatchedInputException: Cannot deserialize instance of `java.lang.Boolean` out of START_OBJECT token at [Source: (PushbackInputStream); line: 1, column: 1]
    return exampleFeignClient.testBoolean();
}

因此 exampleFeignClient#testBoolean 調用出現了 feign 轉換異常了。

這裡需要關閉提供者的 feign 介面異常處理。或者在此介面類上添加 @IgnoreResponseAdvice(errorDispose = false) errorDispose 設置為 false

/**
 * 添加 IgnoreResponseAdvice#errorDispose 設置為異常不需要處理包裝
 */
@Override
@IgnoreResponseAdvice(errorDispose = false)
public Boolean testBoolean() throws Exception {
    throw new Exception("模擬異常");
}

總結

項目里很多重複的code，我們可以通過一定的方式去簡化，以達到一定目的減少開發量。PurgeTeam 具有一些優秀的開源組件，減少日常的開發量。

示例程式碼地址:unified-dispose-spring-cloud-starter

作者GitHub:
Purgeyao 歡迎關注

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

微信公眾號:

微信公眾號二維碼

本文由部落格一文多發平台 OpenWrite 發布！

VirMach 便宜 VPS

QNews

QNews