介紹
JSR-380 是 J2EE 的一個(gè)規(guī)范，用于校驗(yàn)實(shí)體屬性，它是 JSR-303 的升級(jí)版，在 Spring Boot 中可以基于它優(yōu)雅實(shí)現(xiàn)參數(shù)校驗(yàn)。
<!--more-->
示例
在沒有使用 JSR-380 之前，我們一般都會(huì)將參數(shù)校驗(yàn)硬編碼在 controller 類中，示例：
|
1
2
3
4
5
6
|
public Result add(@RequestBody User user){ if(StringUtils.isBlank(user.getName())){ return Result.error("用戶名不能為空"); } // ...} |
而使用 JSR-380 只需要通過添加對(duì)應(yīng)的注解即可實(shí)現(xiàn)校驗(yàn)，示例：
|
1
2
3
4
5
6
|
@Datapublic class User{ @NotBlank private String name; private Integer age;} |
|
1
2
3
|
public Result register(@Validated @RequestBody User user){ // ...} |
這樣看起來代碼是不是清爽了很多，只需要在需要校驗(yàn)的字段上加上對(duì)應(yīng)的校驗(yàn)注解，然后對(duì)需要校驗(yàn)的地方加上 @Validated 注解，然后框架就會(huì)幫我們完成校驗(yàn)。
通過全局異常自定義錯(cuò)誤響應(yīng)
框架校驗(yàn)失敗之后會(huì)拋出異常，需要捕獲這個(gè)異常然后來自定義校驗(yàn)不通過的錯(cuò)誤響應(yīng)，這里直接貼代碼，兼容 @RequestBody 、 @ModelAttribute 、 @RequestParam 三種入?yún)⒌男ｒ?yàn)：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
|
@ControllerAdvicepublic class GlobalExceptionHandler { @ExceptionHandler(value = {MethodArgumentNotValidException.class, BindException.class}) public ResponseEntity<Result> methodArgumentNotValidHandler(HttpServletRequest request, Exception e) { BindingResult bindingResult; if (e instanceof MethodArgumentNotValidException) { //@RequestBody參數(shù)校驗(yàn) bindingResult = ((MethodArgumentNotValidException) e).getBindingResult(); } else { //@ModelAttribute參數(shù)校驗(yàn) bindingResult = ((BindException) e).getBindingResult(); } FieldError fieldError = bindingResult.getFieldError(); return ResponseEntity.ok(Result.fail(Result.CODE_PARAMS_INVALID, "[" + fieldError.getField() + "]" + fieldError.getDefaultMessage())); } //@RequestParam參數(shù)校驗(yàn) @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 { // 這個(gè)不是JSR標(biāo)準(zhǔn)返回的異常，要自定義提示文本 field = ((MissingServletRequestParameterException) e).getParameterName(); msg = "不能為空"; } return ResponseEntity.ok(Result.fail(Result.CODE_PARAMS_INVALID, "[" + field + "]" + msg)); }} |
然后再訪問一下接口，可以看到錯(cuò)誤提示已經(jīng)按自定義的規(guī)范顯示了：
可以看到都不需要寫任何提示文本就可以完成校驗(yàn)和提示，上圖的 不能為空 是框架內(nèi)置的 I18N 國際化支持，每個(gè)注解都內(nèi)置相應(yīng)的提示模板。
常用校驗(yàn)注解
| 注解 | 描述 |
|---|---|
| @NotNull | 驗(yàn)證值不為 null |
| @AssertTrue | 驗(yàn)證值為 true |
| @Size | 驗(yàn)證值的長度介于 min 和 max 之間，可應(yīng)用于 String、Collection、Map 和數(shù)組類型 |
| @Min | 驗(yàn)證值不小于該值 |
| @Max | 驗(yàn)證值不大于該值 |
| 驗(yàn)證字符串是有效的電子郵件地址 | |
| @NotEmpty | 驗(yàn)證值不為 null 或空，可應(yīng)用于 String、Collection、Map 和數(shù)組類型 |
| @NotBlank | 驗(yàn)證字符串不為 null 并且不是空白字符 |
| @Positive | 驗(yàn)證數(shù)字為正數(shù) |
| @PositiveOrZero | 驗(yàn)證數(shù)字為正數(shù)(包括 0) |
| @Negative | 驗(yàn)證數(shù)字為負(fù)數(shù) |
| @NegativeOrZero | 驗(yàn)證數(shù)字為負(fù)數(shù)(包括 0) |
| @Past | 驗(yàn)證日期值是過去 |
| @PastOrPresent | 驗(yàn)證日期值是過去(包括現(xiàn)在) |
| @Future | 驗(yàn)證日期值是未來 |
| @FutureOrPresent | 驗(yàn)證日期值是未來(包括現(xiàn)在) |
本文完整代碼放在 github 。
到此這篇關(guān)于Spring Boot使用JSR-380進(jìn)行校驗(yàn)的文章就介紹到這了,更多相關(guān)Spring Boot使用JSR-380校驗(yàn)內(nèi)容請(qǐng)搜索服務(wù)器之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持服務(wù)器之家！
原文鏈接：https://segmentfault.com/a/1190000039305630
