Spring Validation 验证框架全面总结

一、介绍

Spring Validation 验证框架对参数的验证机制提供了@Validated （Spring’s JSR-303 规范，是标准 JSR-303 的一个变种），javax 提供了@Valid（标准 JSR-303 规范），配合 BindingResult 可以直接提供参数验证结果。其中对于字段的特定验证注解，比如 @NotNull。
两者在检验 Controller 的入参是否符合规范时，使用@Validated 或者 @Valid 在基本验证功能上没有太多区别。但是在分组、注解地方、嵌套验证等功能上两个有所不同：

@Validated
分组：提供分组功能，可在入参验证时，根据不同的分组采用不同的验证机制。
可注解位置：可以用在类型、方法和方法参数上。但是不能用在成员属性上
嵌套验证：用在方法入参上无法单独提供嵌套验证功能；不能用在成员属性上；也无法提供框架进行嵌套验证；能配合嵌套验证注解 @Valid 进行嵌套验证。
@Valid
分组：无分组功能
可注解位置：可以用在方法、构造函数、方法参数和成员属性上（两者是否能用于成员属性上直接影响能否提供嵌套验证的功能）
嵌套验证：用在方法入参上无法单独提供嵌套验证功能；能够用在成员属性上，提示验证框架进行嵌套验证；能配合嵌套验证注解@Valid进行嵌套验证。

二、使用

1. SpringBoot 2.3.0后需要添加依赖

<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-validation</artifactId>
</dependency>

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

@Configuration
public class WebConfig {@Beanpublic Validator validator() {ValidatorFactory validatorFactory = Validation.byProvider(HibernateValidator.class).configure()//failFast的意思只要出现校验失败的情况，就立即结束校验，不再进行后续的校验。.failFast(true).buildValidatorFactory();return validatorFactory.getValidator();}@Beanpublic 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 不可为空！")@Validprivate ValidVo validVo;@NotEmpty(message = "list1 不可为空！")@Size(min = 1, max = 2, message = "list1 数据过大")@Validprivate List<ValidVo> 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";}
}

三、分组校验

对一个DTO类需要有多中验证方式，在不同的情况下使用不同验证方式，比如在某些情况下我们希望param1,param2比传，其他可为空，在另一个接口我们又希望param3，param4比穿，其他的可为空，这种情况下，就可以使用分组校验。
Sping Vaild如果不指定Group，默认为 Default.class

定义Group

//分组1
public interface GroupValid1 {
}
//分组2
public interface GroupValid2 {
}

@Data
public class GroupParamDto {@NotNull(message = "param1 is null !", groups = {GroupValid1.class})private String param1;@NotNull(message = "param2 is null !", groups = {GroupValid1.class})private String param2;@NotNull(message = "param3 is null !", groups = {GroupValid2.class})private String param3;@NotNull(message = "param4 is null !", groups = {GroupValid2.class})private String param4;@NotNull(message = "param5 is null !", groups = {GroupValid1.class, GroupValid2.class})private String param5;@NotNull(message = "param6 is null !", groups = {GroupValid1.class, GroupValid2.class})private String param6;//不指定默认 Default.class @NotNull(message = "param7 is null !")private String param7;
}

Controller

@Slf4j
@RestController
@RequestMapping("group")
public class GroupTestController {//分组校验@GetMapping("/test1")public String test1(@Validated({GroupValid1.class, GroupValid2.class}) GroupParamDto dto) {log.info(dto.toString());return "success";}
}

运行上面的逻辑，在DTO中所有指定groups 为 GroupValid1.class, GroupValid2.class的字段必传。

四、分组序列

默认情况下，不同组别的约束验证是无序的，然而在某些情况下，约束验证的顺序却很重要，如果第二个组中的约束验证依赖于第一个组的参数来进行验证，这个时候就需要组之间有一定的顺序。

一个组可以定义为其他组的序列，使用它进行验证的时候必须符合该序列规定的顺序。在使用组序列验证的时候，如果序列前边的组验证失败，则后面的组将不再给予验证。

Group

@javax.validation.GroupSequence({GroupValid2.class, GroupValid1.class})
public interface GroupSequence {
}

Controller

//分组序列
@GetMapping("/test2")
public String testSequence(@Validated({GroupSequence.class}) GroupParamDto dto) {log.info(dto.toString());return "success";
}

五、校验多个对象

在Controller中很多情况下不只是单个对象，需要对多个对象进行校验，加入校验只需在每个对象前加入@Validated注解即可。

再新建一个DTO

@Data
public class GroupNameDto {@NotNull(message = "name1 is null !", groups = {GroupValid1.class})private String name1;@NotNull(message = "name2 is null !", groups = {GroupValid2.class})private String name2;
}

Controller

//校验多个对象
@GetMapping("/test4")
public String test4(@Validated({Default.class}) GroupParamDto dto, @Validated({GroupValid2.class}) GroupNameDto nameDto) {log.info(dto.toString());log.info(nameDto.toString());return "success";
}

六、自定义验证

上面讲到的参数校验，全都是在Controller 控制层做的参数校验，但是有些情况我们还需要在其他地方校验，比如在我自定义的方法，需要对参数校验，总不能还要按个if判断吧。

自定义 ValidationUtil类，实现快速校验和全部校验

import org.hibernate.validator.HibernateValidator;import javax.validation.ConstraintViolation;
import javax.validation.Validation;
import javax.validation.Validator;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.Set;public class ValidationUtil {//开启快速结束模式 failFast (true)private static Validator failFastValidator = Validation.byProvider(HibernateValidator.class).configure().failFast(true).buildValidatorFactory().getValidator();//全部校验private static Validator validator = Validation.buildDefaultValidatorFactory().getValidator();//注解验证参数(快速失败模式)public static <T> ValidResult fastFailValidate(T obj, Class<?>... group) {Set<ConstraintViolation<T>> constraintViolations = failFastValidator.validate(obj, group);//返回异常resultif (constraintViolations.size() > 0) {return ValidResult.error(constraintViolations.iterator().next().getMessage());}return ValidResult.success();}//注解验证参数(全部校验)public static <T> ValidResult allCheckValidate(T obj, Class<?>... group) {Set<ConstraintViolation<T>> constraintViolations = validator.validate(obj, group);if (constraintViolations.size() > 0) {List<String> errorMessages = new LinkedList<String>();Iterator<ConstraintViolation<T>> iterator = constraintViolations.iterator();while (iterator.hasNext()) {ConstraintViolation<T> violation = iterator.next();errorMessages.add(violation.getMessage());}return ValidResult.error(String.join(",", errorMessages));}return ValidResult.success();}
}

编写ValidResult返回封装

@Data
public class ValidResult {private boolean hasError;private String errMessage;public static ValidResult error(String errMessage) {ValidResult result = new ValidResult();result.hasError = true;result.errMessage = errMessage;return result;}public static ValidResult success() {ValidResult result = new ValidResult();result.hasError = false;return result;}}

@Data
public class MyDto {@NotNull(message = "name is null!",groups = {GroupValid1.class})private String name;@NotNull(message = "message is null!",groups = {GroupValid2.class})private String message;
}

校验

public String test2(MyDto dto) {ValidResult result = ValidationUtil.fastFailValidate(dto, GroupValid1.class);
//  ValidResult result = ValidationUtil.allCheckValidate(dto);if (result.isHasError()) {return result.getErrMessage();}return "success";
}