快捷導(dǎo)航

SpringBoot中的異常處理與參數(shù)校驗的方法實現(xiàn)

更新時間：2020年04月21日 16:16:32 作者：一個程序員的成長

這篇文章主要介紹了SpringBoot中的異常處理與參數(shù)校驗的方法實現(xiàn)，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧

兄弟們好，這次來跟老鐵交流兩個問題，異常和參數(shù)校驗，在說參數(shù)校驗之前我們先來說異常處理吧，因為后面參數(shù)的校驗會牽扯到異常處理這塊的內(nèi)容。

異常處理

說到異常處理，我不知道大家有沒有寫過或者遇到過如下的寫法。

public void saveUser() {
    
  try {
    // 所有的業(yè)務(wù)內(nèi)容，目測幾百行
  }catch (Exception e) {
    e.printStackTrace();
  }
}

如果出現(xiàn)上述的代碼，里面包含了大量的業(yè)務(wù)代碼，如果是你寫的，趕緊改掉，不是你寫的找寫的，吐槽趕緊改掉。

存在的問題：

1、會遇到性能瓶頸；
2、很難定位問題；
3、try嵌套過多可讀性很差；

不管什么原因出現(xiàn)了上述代碼，那么最好還是改一下，如果非要在業(yè)務(wù)代碼中try，那么也應(yīng)該只在可能出現(xiàn)異常的地方使用try，而不是try整個業(yè)務(wù)代碼。

SpringBoot中的異常捕獲

直接上代碼

@RestControllerAdvice
public class GlobalException {

  @ExceptionHandler(value = Exception.class) // 捕獲的異常類型
  public Object globalException(Exception ex) {

    // 異常處理
    ex.printStackTrace();

    return "出現(xiàn)異常";
  }
}

那么在SpringBoot中我們就可以通過這樣的一個配置可以獲取到項目中出現(xiàn)異常的地方,我們可以在這個方法中可以獲取出現(xiàn)異常的類的詳細(xì)信息,那么是不是所有的異常我們?nèi)渴褂肊xception來處理呢？那么肯定是不合適的。
我們模擬一個by zero的異常，然后再配置一個處理ArithmeticException異常的處理器，代碼如下：

@RestControllerAdvice
public class GlobalException {


  @ExceptionHandler(value = Exception.class) // 捕獲的異常類型
  public Object globalException(Exception ex) {

    ex.printStackTrace();

    return "出現(xiàn)異常";
  }

  @ExceptionHandler(value = ArithmeticException.class)
  public Object arithmeticException(ArithmeticException ex) {

    ex.printStackTrace();
    return "by zero異常";
  }
}

如果這個時候出現(xiàn)by zero異常，走ArithmeticException異常處理，原因就是因為如果有更小范圍的異常處理類，那么會走小范圍的異常處理器。不會走globalException更大的異常處理類。

這樣處理之后，我們就不需要在項目中去寫那么多的try了，是不是方便了很多。

除了使用這些已經(jīng)存在的異常外，其實我們還可以自定義我們的異常，比如我們常用的用戶未登錄異常、參數(shù)錯誤異常等等。但是考慮到這篇文章的篇幅問題，這次就先不寫了，有興趣的朋友可以直接下面留言，人多了我盡快更新。

注意坑：

這里跟大家分享一個踩過的坑，不能再Filter過濾器中拋出異常，如果通過在過濾器中拋出異常，然后通過異常處理類來處理，那么是不可能的，因為處理器是捕獲不到Filter拋出的異常的。

參數(shù)校驗

老規(guī)矩，先來看一段代碼

@RequestMapping(value = "/save/user")
public Object saveUser(UserPO userPO) {

  if (userPO.getAge() == null) {
    return "請求參數(shù)錯誤";
  }

  if (userPO.getSex() == null) {
    return "請求參數(shù)錯誤";
  }
  if (userPO.getUsername() == null) {
    return "請求參數(shù)錯誤";
  }

  // ...

  return "SUCCESS";
}

應(yīng)該見過這種校驗參數(shù)的吧，說實話我寫過。越寫感覺越low，所以狠心一下，還是趁早改吧。

@Validated注解

這個注解其實是Spring提供的，如果你的項目不是SpringBoot項目,需要引一下需要的pom文件,如果是,那么就不用管了,SpringBoot已經(jīng)幫我們引入了。

網(wǎng)上看了好多的博客，許多都說的不是很全，大部分都是說JavaBean參數(shù)的校驗，但是我們項目中有些接口可能就涉及一個參數(shù)，根本不需要寫一個JavaBean,對于單一參數(shù)的校驗好多博客還是沒說的,那么我們這次就一次性講清楚。

單一參數(shù)的校驗

直接看代碼吧

@Validated
@RestController
public class BookController {
  
  @RequestMapping(value = "/book/info", method = RequestMethod.GET)
  public Object getBookInfo(@NotBlank(message = "書籍ID不能為空") String bookId) {

    return "SUCCESS";
  }
}

這里要跟大家特別說明下，如果是單一參數(shù)的校驗，那么我們必須要在類上面添加@Validated注解，不然我們整個單個參數(shù)校驗是不會生效的，可以看到我們在校驗參數(shù)bookId的時候，使用了@NotBlank那么顧名思義，就是這個參數(shù)不能為null，在調(diào)用了trim()方法之后也不能是空字符。

如果參數(shù)不滿足要求，那么會拋出ConstraintViolationException異常，這個異常只有在單一參數(shù)校驗的時候拋出，如果你的參數(shù)是JavaBean，那么就不是這個異常了。

既然我們知道了它會拋出異常，并且我們也知道是什么異常類型，那么久超級簡單了，我們可以直接使用上面剛學(xué)的異常處理類來處理我們的異常。

我找個里面寫的比較簡單，如果你想寫的復(fù)雜一點，其實也是可以的，但是作為后端來說，我覺得沒必要，因為我們不能給前端提示太過明顯的錯誤提示，防止別人惡意攻擊我們，就像用戶名密碼錯誤，不能明確的告訴用戶到底是用戶名錯誤還是密碼錯誤，只能提示用戶名或密碼錯誤。

如果大家非要把詳細(xì)的錯誤信息打出來，要看到到底是哪個參數(shù)校驗不通過，也可以通過下面的方式將具體的參數(shù)錯誤信息打印出來。輸出的錯誤結(jié)果其實就是上面message里面的內(nèi)容。

@RestControllerAdvice
public class ExceptionCatch {
  /**
   * 單個參數(shù)異常處理
   *
   * @param ex
   * @return
   */
  @ExceptionHandler(value = ConstraintViolationException.class)
  public Object constraintViolationException(ConstraintViolationException ex) {

    // 獲取具體的錯誤信息
    Set<ConstraintViolation<?>> violations = ex.getConstraintViolations();
    // 打印數(shù)據(jù)
    violations.forEach(e -> System.out.println(e.getMessage()));
    
    return "單個-請求參數(shù)錯誤";
  }
}

JavaBean參數(shù)校驗（form-data）

JavaBean的寫法

@Data
@NoArgsConstructor
@AllArgsConstructor
public class UserPO {

  @NotBlank(message = "用戶名不能為空")
  private String username;

  @NotNull(message = "年齡不能為空")
  @Min(value = 1, message = "年齡最小為1")
  @Max(value = 200, message = "年齡最大為200")
  private Integer age;

  @NotBlank(message = "性別不能為空")
  private String sex;
}

Controller寫法

@RequestMapping(value = "/save/user")
public Object saveUser(@Validated UserPO userPO) {

  // ...

  return "SUCCESS";
}

跟單一參數(shù)校驗不一樣的是JavaBean的校驗方式需要將@Validated寫在方法參數(shù)，而不是類上。如果出現(xiàn)了參數(shù)校驗不通過，同樣的也會拋出一個異常，BindException。

/**
 * 一般參數(shù)校驗綁定異常處理
 *
 * @param ex
 * @return
 */
@ExceptionHandler(value = BindException.class)
public Object bindException(BindException ex) {

  BindingResult bindingResult = ex.getBindingResult();

  // 獲取所有的錯誤信息
  List<ObjectError> allErrors = bindingResult.getAllErrors();

  // 輸出
  allErrors.forEach(e -> System.out.println(e.getDefaultMessage()));

  return "請求參數(shù)錯誤";
}

注意：大家要注意post請求有兩種方式，一種是基于form-data格式的數(shù)據(jù)傳遞，另外一種就是基于json格式的數(shù)據(jù)傳遞，兩種傳遞方式引發(fā)的異常也是不一樣的，所以我們還要單獨處理基于json的參數(shù)校驗異常處理。

JavaBean參數(shù)校驗（json）

我們先來看下Controller接收方式

@RequestMapping(value = "/save/user")
public Object saveUser(@Validated @RequestBody UserPO userPO) {

  // ...

  return "SUCCESS";
}

對應(yīng)的參數(shù)異常處理

/**
 * JSON參數(shù)校驗綁定異常處理
 *
 * @param ex
 * @return
 */
@ExceptionHandler(value = MethodArgumentNotValidException.class)
public Object methodArgumentNotValidException(MethodArgumentNotValidException ex) {

  BindingResult bindingResult = ex.getBindingResult();

  // 獲取所有的錯誤信息
  List<ObjectError> allErrors = bindingResult.getAllErrors();

  // 輸出
  allErrors.forEach(e -> System.out.println(e.getDefaultMessage()));

  return "請求參數(shù)錯誤-json";
}

最后的話

那么到這里，我們本篇文章就結(jié)束了，主要介紹了兩部分內(nèi)容，異常的處理和參數(shù)的校驗。雖然很簡單，但是我個人感覺還是挺常用的技能。所以與大家進行分享，如果對你有點幫助，就來點個贊吧。如果有什么不明白的也歡迎下方留言，一起來交流。

到此這篇關(guān)于SpringBoot中的異常處理與參數(shù)校驗的方法實現(xiàn)的文章就介紹到這了,更多相關(guān)SpringBoot 異常處理與參數(shù)校驗內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: