Spring Boot使用JSR-380進行校驗的示例

Posted on by

介紹

JSR-380 是 J2EE 的一個規范，用於校驗實體屬性，它是 JSR-303 的升級版，在 Spring Boot 中可以基於它優雅實現參數校驗。

<!–more–>

示例

在沒有使用 JSR-380 之前，我們一般都會將參數校驗硬編碼在 controller 類中，示例：

public Result add(@RequestBody User user){
  if(StringUtils.isBlank(user.getName())){
    return Result.error("用戶名不能為空");
  }
  // ...
}

而使用 JSR-380 隻需要通過添加對應的註解即可實現校驗，示例：

@Data
public class User{
  @NotBlank
  private String name;
  private Integer age;
}
public Result register(@Validated @RequestBody User user){
  // ...
}

這樣看起來代碼是不是清爽瞭很多，隻需要在需要校驗的字段上加上對應的校驗註解，然後對需要校驗的地方加上 @Validated 註解，然後框架就會幫我們完成校驗。

通過全局異常自定義錯誤響應

框架校驗失敗之後會拋出異常，需要捕獲這個異常然後來自定義校驗不通過的錯誤響應，這裡直接貼代碼，兼容 @RequestBody 、 @ModelAttribute 、 @RequestParam 三種入參的校驗：

@ControllerAdvice
public class GlobalExceptionHandler {

  @ExceptionHandler(value = {MethodArgumentNotValidException.class, BindException.class})
  public ResponseEntity<Result> methodArgumentNotValidHandler(HttpServletRequest request, Exception e) {
    BindingResult bindingResult;
    if (e instanceof MethodArgumentNotValidException) {
      //@RequestBody參數校驗
      bindingResult = ((MethodArgumentNotValidException) e).getBindingResult();
    } else {
      //@ModelAttribute參數校驗
      bindingResult = ((BindException) e).getBindingResult();
    }
    FieldError fieldError = bindingResult.getFieldError();
    return ResponseEntity.ok(Result.fail(Result.CODE_PARAMS_INVALID, "[" + fieldError.getField() + "]" + fieldError.getDefaultMessage()));
  }

  //@RequestParam參數校驗
  @ExceptionHandler(value = {ConstraintViolationException.class, MissingServletRequestParameterException.class})
  public ResponseEntity<Result> constraintViolationHandler(Exception e) {
    String field;
    String msg;
    if (e instanceof ConstraintViolationException) {
      ConstraintViolation<?> constraintViolation = ((ConstraintViolationException) e).getConstraintViolations().stream().findFirst().get();
      List<Path.Node> pathList = StreamSupport.stream(constraintViolation.getPropertyPath().spliterator(), false)
          .collect(Collectors.toList());
      field = pathList.get(pathList.size() - 1).getName();
      msg = constraintViolation.getMessage();
    } else {
      // 這個不是JSR標準返回的異常，要自定義提示文本
      field = ((MissingServletRequestParameterException) e).getParameterName();
      msg = "不能為空";
    }
    return ResponseEntity.ok(Result.fail(Result.CODE_PARAMS_INVALID, "[" + field + "]" + msg));
  }
}

然後再訪問一下接口，可以看到錯誤提示已經按自定義的規范顯示瞭：

可以看到都不需要寫任何提示文本就可以完成校驗和提示，上圖的 不能為空 是框架內置的 I18N 國際化支持，每個註解都內置相應的提示模板。

常用校驗註解

註解 描述
@NotNull 驗證值不為 null
@AssertTrue 驗證值為 true
@Size 驗證值的長度介於 min 和 max 之間，可應用於 String、Collection、Map 和數組類型
@Min 驗證值不小於該值
@Max 驗證值不大於該值
@Email 驗證字符串是有效的電子郵件地址
@NotEmpty 驗證值不為 null 或空，可應用於 String、Collection、Map 和數組類型
@NotBlank 驗證字符串不為 null 並且不是空白字符
@Positive 驗證數字為正數
@PositiveOrZero 驗證數字為正數(包括 0)
@Negative 驗證數字為負數
@NegativeOrZero 驗證數字為負數(包括 0)
@Past 驗證日期值是過去
@PastOrPresent 驗證日期值是過去(包括現在)
@Future 驗證日期值是未來
@FutureOrPresent 驗證日期值是未來(包括現在)

本文完整代碼放在 github 。

Java Bean Validation Basics

JSR-380 規范

到此這篇關於Spring Boot使用JSR-380進行校驗的文章就介紹到這瞭,更多相關Spring Boot使用JSR-380校驗內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：