SpringCloud例外處理統一封裝我來做-使用篇

簡介

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

依賴添加啟動功能

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

點擊查看最新新版本

<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 發布！

標籤：Java

上一篇：《java并發編程藝術》學習筆記

下一篇：Java之Stream如何運用？案例詳解