Spring 使用Validation 验证框架的问题详解

Spring Boot在内部通过集成hibernate-validation已经实现了JSR-349验证规范接口，在Spring Boot项目中只要直接使用就行了。 一般用在Controller中用于验证前端传来的参数。这篇文章给大家介绍Spring Validation 验证框架的相关知识，感兴趣的朋友一起看看吧

一、介绍

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后需要添加依赖

org.springframework.bootspring-boot-starter-validation

2. 配置 validation 使出现校验失败即返回

@Configuration public 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. 编写全局异常捕获，捕获验证失败，统一返回

@Slf4j @ControllerAdvice public 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，在参数上添加注解校验

@Data public 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 list1; }

@Data public class ValidVo { @NotBlank(message = "gender is null") private String gender; @NotBlank(message = "test is null") private String test; }

6. Controller

@RestController @RequestMapping("/valid") @CrossOrigin public 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"; } }