如何理解SpringBoot異常處理

本篇文章給大家分享的是有關(guān)如何理解SpringBoot異常處理，小編覺得挺實(shí)用的，因此分享給大家學(xué)習(xí)，希望大家閱讀完這篇文章后可以有所收獲，話不多說，跟著小編一起來看看吧。

SpringBoot異常處理

簡介

重復(fù)功能我來寫。在 SpringBoot 項(xiàng)目里都有全局異常處理以及返回包裝等，返回前端是帶上succ、code、msg、data等字段。單個(gè)項(xiàng)目情況下很好解決，當(dāng)微服務(wù)模塊多的情況下，很多情況開發(fā)都是復(fù)制原有代碼進(jìn)行構(gòu)建另外一個(gè)項(xiàng)目的，導(dǎo)致這些功能升級(jí)需要修改多個(gè)服務(wù)，在這個(gè)基礎(chǔ)上，我們封裝了一個(gè)組件 unified-dispose-springboot-starter 里面包含了一些基礎(chǔ)的異常處理以及返回包裝功能。

依賴添加啟動(dòng)功能

添加依賴 ps: 實(shí)際version版本請(qǐng)使用最新版 

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

啟動(dòng)類添加 @EnableGlobalDispose 注解開啟以下功能。

@EnableGlobalDispose
@SpringBootApplication
public class GlobalDisposeSpringBootApplication {

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

}

One 異常處理??

在項(xiàng)目中經(jīng)常出現(xiàn)系統(tǒng)異常的情況，比如NullPointerException等等。如果默認(rèn)未處理的情況下，springboot會(huì)響應(yīng)默認(rèn)的錯(cuò)誤提示，這樣對(duì)用戶體驗(yàn)不是友好，系統(tǒng)層面的錯(cuò)誤，用戶不能感知到，即使為500的錯(cuò)誤，可以給用戶提示一個(gè)類似服務(wù)器開小差的友好提示等。

模塊里以及包含了一些基本的異常處理方式(及不需要做任何代碼編寫已經(jīng)具有基本異常處理)，以及一些常見的異常code，用戶只需要關(guān)心業(yè)務(wù)異常處理即可，直接通過 throw new 異常 的方式拋出即可。

異常處理包含類型

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

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

# 業(yè)務(wù)自定義
BusinessException 類捕獲 業(yè)務(wù)通用自定義異常

# 參數(shù)校驗(yàn)異常
HttpMessageNotReadableException 參數(shù)錯(cuò)誤異常
BindException 參數(shù)錯(cuò)誤異常

程序主動(dòng)拋出異常

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

通常不建議直接拋出通用的BusinessException異常，應(yīng)當(dāng)在對(duì)應(yīng)的模塊里添加對(duì)應(yīng)的領(lǐng)域的異常處理類以及對(duì)應(yīng)的枚舉錯(cuò)誤類型。

如會(huì)員模塊： 創(chuàng)建UserException異常類、UserErrorCode枚舉、以及UserExceptionHandler統(tǒng)一攔截類。

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 {
    /**
     * 權(quán)限異常
     */
    NOT_PERMISSIONS("CLOUD401","您沒有操作權(quán)限"),
    ;

    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());
  }

}

最后業(yè)務(wù)使用如下：

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

上述方式，拋出異常后會(huì)被模塊處理。前臺(tái)返回如下：

{
  "succ": false,        // 是否成功
  "ts": 1566467628851,  // 時(shí)間戳
  "data": null,         // 數(shù)據(jù)
  "code": "CLOUD800",   // 錯(cuò)誤類型
  "msg": "業(yè)務(wù)異常",    // 錯(cuò)誤描述
  "fail": true
}

Tow 統(tǒng)一返回封????

在REST風(fēng)格的開發(fā)中，避免通常會(huì)告知前臺(tái)返回是否成功以及狀態(tài)碼等信息。這里我們通常返回的時(shí)候做一次util的包裝處理工作，如：Result類似的類，里面包含succ、code、msg、data等字段。

接口調(diào)用處理類似如下:

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

結(jié)果:

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

功能使用

默認(rèn)情況所有的 web controller 都會(huì)被封裝為一下返回格式。

接口：

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

返回

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

忽略封裝注解:@IgnorReponseAdvice

@IgnorReponseAdvice允許范圍為：類 + 方法，標(biāo)識(shí)在類上這個(gè)類下的說有方法的返回都將忽略返回封裝。

接口：

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

返回 test

項(xiàng)目里很多重復(fù)的code，我們可以通過一定的方式去簡化，以達(dá)到一定目的減少開發(fā)量。PurgeTeam 具有一些優(yōu)秀的開源組件，減少日常的開發(fā)量。

以上就是如何理解SpringBoot異常處理，小編相信有部分知識(shí)點(diǎn)可能是我們?nèi)粘９ぷ鲿?huì)見到或用到的。希望你能通過這篇文章學(xué)到更多知識(shí)。更多詳情敬請(qǐng)關(guān)注億速云行業(yè)資訊頻道。