一、介紹
Spring Validation 驗證框架對參數的驗證機制提供了@Validated （Spring's JSR-303 規范，是標準 JSR-303 的一個變種），javax 提供了@Valid（標準 JSR-303 規范），配合 BindingResult 可以直接提供參數驗證結果。其中對于字段的特定驗證注解，比如 @NotNull。
兩者在檢驗 Controller 的入參是否符合規范時，使用@Validated 或者 @Valid 在基本驗證功能上沒有太多區別。但是在分組、注解地方、嵌套驗證等功能上兩個有所不同：
1.@Validated
分組：提供分組功能，可在入參驗證時，根據不同的分組采用不同的驗證機制。
可注解位置：可以用在類型、方法和方法參數上。但是不能用在成員屬性上
嵌套驗證：用在方法入參上無法單獨提供嵌套驗證功能；不能用在成員屬性上；也無法提供框架進行嵌套驗證；能配合嵌套驗證注解 @Valid 進行嵌套驗證。
2.@Valid
分組：無分組功能
可注解位置：可以用在方法、構造函數、方法參數和成員屬性上（兩者是否能用于成員屬性上直接影響能否提供嵌套驗證的功能）
嵌套驗證：用在方法入參上無法單獨提供嵌套驗證功能；能夠用在成員屬性上，提示驗證框架進行嵌套驗證；能配合嵌套驗證注解@Valid進行嵌套驗證。
二、使用
1. SpringBoot 2.3.0后需要添加依賴
|
1
2
3
4
|
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-validation</artifactId></dependency> |
2. 配置 validation 使出現校驗失敗即返回
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
|
@Configurationpublic class WebConfig { @Bean public Validator validator() { ValidatorFactory validatorFactory = Validation.byProvider(HibernateValidator.class) .configure() //failFast的意思只要出現校驗失敗的情況，就立即結束校驗，不再進行后續的校驗。 .failFast(true) .buildValidatorFactory(); return validatorFactory.getValidator(); } @Bean public MethodValidationPostProcessor methodValidationPostProcessor() { MethodValidationPostProcessor methodValidationPostProcessor = new MethodValidationPostProcessor(); methodValidationPostProcessor.setValidator(validator()); return methodValidationPostProcessor; }} |
4. 編寫全局異常捕獲，捕獲驗證失敗，統一返回
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
|
@Slf4j@ControllerAdvicepublic class ValidatedExceptionHandler { @ResponseBody @ExceptionHandler(BindException.class) public String exceptionHandler2(BindException exception) { BindingResult result = exception.getBindingResult(); if (result.hasErrors()) { return result.getAllErrors().get(0).getDefaultMessage(); } return "參數不可為空！"; } @ResponseBody @ExceptionHandler(MethodArgumentNotValidException.class) public String exceptionHandler2(MethodArgumentNotValidException exception) { BindingResult result = exception.getBindingResult(); if (result.hasErrors()) { return result.getAllErrors().get(0).getDefaultMessage(); } return "參數不可為空！"; }} |
5. 定義Dto，在參數上添加注解校驗
|
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
|
@Datapublic class ValidDto { @NotEmpty(message = "name 不可為空！") private String name; @NotBlank(message = "userId 不可為空！") private String userId; @Min(value = 1, message = "年齡有誤！") @Max(value = 120, message = "年齡有誤！") private int age; @NotBlank(message = "郵箱不可為空！") @Email(message = "郵箱有誤！") private String email; @NotBlank(message = "mobile不可為空！") @Pattern(regexp = "^(13[0-9]|14[579]|15[0-3,5-9]|16[6]|17[0135678]|18[0-9]|19[89])\\d{8}$", message = "手機號碼有誤！") private String mobile; @NotNull(message = "validVo 不可為空！") @Valid private ValidVo validVo; @NotEmpty(message = "list1 不可為空！") @Size(min = 1, max = 2, message = "list1 數據過大") @Valid private List<ValidVo> list1;} |
|
1
2
3
4
5
6
7
|
@Datapublic class ValidVo { @NotBlank(message = "gender is null") private String gender; @NotBlank(message = "test is null") private String test;} |
6. Controller
|
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
|
@RestController@RequestMapping("/valid")@CrossOriginpublic class ValidController { @GetMapping("/GetTest") public String getTest(@Valid ValidDto dto, BindingResult result) { if (result.hasErrors()) { return result.getAllErrors().get(0).getDefaultMessage(); } return "success"; } @GetMapping("/GetTest2") public String getTest2(@Validated ValidDto dto) { return "success"; } @GetMapping("/GetTest3") public String getTest3(@Validated @RequestBody ValidDto dto) { return "success"; }} |
到此這篇關于Spring 使用Validation 驗證框架的問題詳解的文章就介紹到這了,更多相關Spring Validation 驗證框架內容請搜索服務器之家以前的文章或繼續瀏覽下面的相關文章希望大家以后多多支持服務器之家！
原文鏈接：https://blog.csdn.net/qq_43692950/article/details/119247774
