从零搭建开发脚手架 Spring Boot 输入参数校验多种方式整理

  • 简单使用
    • 引入依赖
    • requestBody参数校验
    • requestParam/PathVariable参数校验
    • 统一异常处理
  • 进阶使用
    • 分组校验
    • 嵌套校验
    • 集合校验
    • 自定义校验
    • 编程式校验
    • 快速失败（Fail Fast）
    • @Valid和@Validated区别
  • 实现原理
    • requestBody参数校验实现原理
    • 方法级别的参数校验实现原理

之前也写过一篇关于Spring Validation使用的文章，不过自我感觉还是浮于表面，本次打算彻底搞懂Spring Validation。本文会详细介绍Spring Validation各种场景下的最佳实践及其实现原理，死磕到底！
项目源码：https://github.com/chentianming11/spring-validation

简单使用

Java API规范(JSR303)定义了Bean校验的标准validation-api，但没有提供实现。hibernate validation是对这个规范的实现，并增加了校验注解如@Email、@Length等。
Spring Validation是对hibernate validation的二次封装，用于支持spring mvc参数自动校验。接下来，我们以spring-boot项目为例，介绍Spring Validation的使用。

引入依赖

如果spring-boot版本小于2.3.x，spring-boot-starter-web会自动传入hibernate-validator依赖。如果spring-boot版本大于2.3.x，则需要手动引入依赖：

  1. <dependency>
  2.     <groupId>org.hibernate</groupId>
  3.     <artifactId>hibernate-validator</artifactId>
  4.     <version>6.0.1.Final</version>
  5. </dependency>

对于web服务来说，为防止非法参数对业务造成影响，在Controller层一定要做参数校验的！大部分情况下，请求参数分为如下两种形式：

  • POST、PUT请求，使用requestBody传递参数；
  • GET请求，使用requestParam/PathVariable传递参数。

下面我们简单介绍下requestBody和requestParam/PathVariable的参数校验实战！

requestBody参数校验

POST、PUT请求一般会使用requestBody传递参数，这种情况下，后端使用DTO对象进行接收。只要给DTO对象加上@Validated注解就能实现自动参数校验。比如，有一个保存User的接口，要求userName长度是2-10，account和password字段长度是6-20。
如果校验失败，会抛出MethodArgumentNotValidException异常，Spring默认会将其转为400（Bad Request）请求。
DTO表示数据传输对象（Data Transfer Object），用于服务器和客户端之间交互传输使用的。在spring-web项目中可以表示用于接收请求参数的Bean对象。
在DTO字段上声明约束注解

  1. @Data
  2. public class UserDTO {
  4.     private Long userId;
  6.     @NotNull
  7.     @Length(min = 2, max = 10)
  8.     private String userName;
  10.     @NotNull
  11.     @Length(min = 6, max = 20)
  12.     private String account;
  14.     @NotNull
  15.     @Length(min = 6, max = 20)
  16.     private String password;
  17. }
  19. 在方法参数上声明校验注解
  20. @PostMapping("/save")
  21. public Result saveUser(@RequestBody @Validated UserDTO userDTO) {
  22.     // 校验通过，才会执行业务逻辑处理
  23.     return Result.ok();
  24. }

这种情况下，使用@Valid和@Validated都可以。

requestParam/PathVariable参数校验

GET请求一般会使用requestParam/PathVariable传参。如果参数比较多(比如超过6个)，还是推荐使用DTO对象接收。
否则，推荐将一个个参数平铺到方法入参中。在这种情况下，必须在Controller类上标注@Validated注解，并在入参上声明约束注解(如@Min等)。如果校验失败，会抛出ConstraintViolationException异常。
代码示例如下：

  1. @RequestMapping("/api/user")
  2. @RestController
  3. @Validated
  4. public class UserController {
  5.     // 路径变量
  6.     @GetMapping("{userId}")
  7.     public Result detail(@PathVariable("userId") @Min(10000000000000000L) Long userId) {
  8.         // 校验通过，才会执行业务逻辑处理
  9.         UserDTO userDTO = new UserDTO();
  10.         userDTO.setUserId(userId);
  11.         userDTO.setAccount("11111111111111111");
  12.         userDTO.setUserName("xixi");
  13.         userDTO.setAccount("11111111111111111");
  14.         return Result.ok(userDTO);
  15.     }
  17.     // 查询参数
  18.     @GetMapping("getByAccount")
  19.     public Result getByAccount(@Length(min = 6, max = 20) @NotNull String  account) {
  20.         // 校验通过，才会执行业务逻辑处理
  21.         UserDTO userDTO = new UserDTO();
  22.         userDTO.setUserId(10000000000000003L);
  23.         userDTO.setAccount(account);
  24.         userDTO.setUserName("xixi");
  25.         userDTO.setAccount("11111111111111111");
  26.         return Result.ok(userDTO);
  27.     }
  28. }

统一异常处理

前面说过，如果校验失败，会抛出MethodArgumentNotValidException或者ConstraintViolationException异常。在实际项目开发中，通常会用统一异常处理来返回一个更友好的提示。
比如我们系统要求无论发送什么异常，http的状态码必须返回200，由业务码去区分系统的异常情况。

  1. @RestControllerAdvice
  2. public class CommonExceptionHandler {
  4.     @ExceptionHandler({MethodArgumentNotValidException.class})
  5.     @ResponseStatus(HttpStatus.OK)
  6.     @ResponseBody
  7.     public Result handleMethodArgumentNotValidException(MethodArgumentNotValidException ex) {
  8.         BindingResult bindingResult = ex.getBindingResult();
  9.         StringBuilder sb = new StringBuilder("校验失败:");
  10.         for (FieldError fieldError : bindingResult.getFieldErrors()) {
  11.             sb.append(fieldError.getField()).append("：").append(fieldError.getDefaultMessage()).append(", ");
  12.         }
  13.         String msg = sb.toString();
  14.        return Result.fail(BusinessCode.参数校验失败, msg);
  15.     }
  17.     @ExceptionHandler({ConstraintViolationException.class})
  18.     @ResponseStatus(HttpStatus.OK)
  19.     @ResponseBody
  20.     public Result handleConstraintViolationException(ConstraintViolationException ex) {
  21.         return Result.fail(BusinessCode.参数校验失败, ex.getMessage());
  22.     }
  23. }

进阶使用

分组校验

在实际项目中，可能多个方法需要使用同一个DTO类来接收参数，而不同方法的校验规则很可能是不一样的。这个时候，简单地在DTO类的字段上加约束注解无法解决这个问题。因此，spring-validation支持了分组校验的功能，专门用来解决这类问题。
还是上面的例子，比如保存User的时候，UserId是可空的，但是更新User的时候，UserId的值必须>=10000000000000000L；其它字段的校验规则在两种情况下一样。这个时候使用分组校验的代码示例如下：
约束注解上声明适用的分组信息groups

  1. @Data
  2. public class UserDTO {
  4.     @Min(value = 10000000000000000L, groups = Update.class)
  5.     private Long userId;
  7.     @NotNull(groups = {Save.class, Update.class})
  8.     @Length(min = 2, max = 10, groups = {Save.class, Update.class})
  9.     private String userName;
  11.     @NotNull(groups = {Save.class, Update.class})
  12.     @Length(min = 6, max = 20, groups = {Save.class, Update.class})
  13.     private String account;
  15.     @NotNull(groups = {Save.class, Update.class})
  16.     @Length(min = 6, max = 20, groups = {Save.class, Update.class})
  17.     private String password;
  19.     /**
  20.      * 保存的时候校验分组
  21.      */
  22.     public interface Save {
  23.     }
  25.     /**
  26.      * 更新的时候校验分组
  27.      */
  28.     public interface Update {
  29.     }
  30. }

@Validated注解上指定校验分组

  1. @PostMapping("/save")
  2. public Result saveUser(@RequestBody @Validated(UserDTO.Save.class) UserDTO userDTO) {
  3.     // 校验通过，才会执行业务逻辑处理
  4.     return Result.ok();
  5. }
  7. @PostMapping("/update")
  8. public Result updateUser(@RequestBody @Validated(UserDTO.Update.class) UserDTO userDTO) {
  9.     // 校验通过，才会执行业务逻辑处理
  10.     return Result.ok();
  11. }

嵌套校验

前面的示例中，DTO类里面的字段都是基本数据类型和String类型。但是实际场景中，有可能某个字段也是一个对象，这种情况先，可以使用嵌套校验。
比如，上面保存User信息的时候同时还带有Job信息。需要注意的是，此时DTO类的对应字段必须标记@Valid注解。

  1. @Data
  2. public class UserDTO {
  4.     @Min(value = 10000000000000000L, groups = Update.class)
  5.     private Long userId;
  7.     @NotNull(groups = {Save.class, Update.class})
  8.     @Length(min = 2, max = 10, groups = {Save.class, Update.class})
  9.     private String userName;
  11.     @NotNull(groups = {Save.class, Update.class})
  12.     @Length(min = 6, max = 20, groups = {Save.class, Update.class})
  13.     private String account;
  15.     @NotNull(groups = {Save.class, Update.class})
  16.     @Length(min = 6, max = 20, groups = {Save.class, Update.class})
  17.     private String password;
  19.     @NotNull(groups = {Save.class, Update.class})
  20.     @Valid
  21.     private Job job;
  23.     @Data
  24.     public static class Job {
  26.         @Min(value = 1, groups = Update.class)
  27.         private Long jobId;
  29.         @NotNull(groups = {Save.class, Update.class})
  30.         @Length(min = 2, max = 10, groups = {Save.class, Update.class})
  31.         private String jobName;
  33.         @NotNull(groups = {Save.class, Update.class})
  34.         @Length(min = 2, max = 10, groups = {Save.class, Update.class})
  35.         private String position;
  36.     }
  38.     /**
  39.      * 保存的时候校验分组
  40.      */
  41.     public interface Save {
  42.     }
  44.     /**
  45.      * 更新的时候校验分组
  46.      */
  47.     public interface Update {
  48.     }
  49. }

嵌套校验可以结合分组校验一起使用。还有就是嵌套集合校验会对集合里面的每一项都进行校验，例如List字段会对这个list里面的每一个Job对象都进行校验

集合校验

如果请求体直接传递了json数组给后台，并希望对数组中的每一项都进行参数校验。此时，如果我们直接使用java.util.Collection下的list或者set来接收数据，参数校验并不会生效！我们可以使用自定义list集合来接收参数：
包装List类型，并声明@Valid注解

  1. public class ValidationList<E> implements List<E> {
  3.     @Delegate // @Delegate是lombok注解
  4.     @Valid // 一定要加@Valid注解
  5.     public List<E> list = new ArrayList<>();
  7.     // 一定要记得重写toString方法
  8.     @Override
  9.     public String toString() {
  10.         return list.toString();
  11.     }
  12. }

@Delegate注解受lombok版本限制，1.18.6以上版本可支持。如果校验不通过，会抛出NotReadablePropertyException，同样可以使用统一异常进行处理。
比如，我们需要一次性保存多个User对象，Controller层的方法可以这么写：

  1. @PostMapping("/saveList")
  2. public Result saveList(@RequestBody @Validated(UserDTO.Save.class) ValidationList<UserDTO> userList) {
  3.     // 校验通过，才会执行业务逻辑处理
  4.     return Result.ok();
  5. }

自定义校验

业务需求总是比框架提供的这些简单校验要复杂的多，我们可以自定义校验来满足我们的需求。
自定义spring validation非常简单，假设我们自定义加密id（由数字或者a-f的字母组成，32-256长度）校验，主要分为两步：
自定义约束注解

  1. @Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER})
  2. @Retention(RUNTIME)
  3. @Documented
  4. @Constraint(validatedBy = {EncryptIdValidator.class})
  5. public @interface EncryptId {
  7.     // 默认错误消息
  8.     String message() default "加密id格式错误";
  10.     // 分组
  11.     Class<?>[] groups() default {};
  13.     // 负载
  14.     Class<? extends Payload>[] payload() default {};
  15. }

实现ConstraintValidator接口编写约束校验器

  1. public class EncryptIdValidator implements ConstraintValidator<EncryptId, String> {
  3.     private static final Pattern PATTERN = Pattern.compile("^[a-f\\d]{32,256}$");
  5.     @Override
  6.     public boolean isValid(String value, ConstraintValidatorContext context) {
  7.         // 不为null才进行校验
  8.         if (value != null) {
  9.             Matcher matcher = PATTERN.matcher(value);
  10.             return matcher.find();
  11.         }
  12.         return true;
  13.     }
  14. }

这样我们就可以使用@EncryptId进行参数校验了！

编程式校验

上面的示例都是基于注解来实现自动校验的，在某些情况下，我们可能希望以编程方式调用验证。这个时候可以注入javax.validation.Validator对象，然后再调用其api。

  1. @Autowired
  2. private javax.validation.Validator globalValidator;
  4. // 编程式校验
  5. @PostMapping("/saveWithCodingValidate")
  6. public Result saveWithCodingValidate(@RequestBody UserDTO userDTO) {
  7.     Set<ConstraintViolation<UserDTO>> validate = globalValidator.validate(userDTO, UserDTO.Save.class);
  8.     // 如果校验通过，validate为空；否则，validate包含未校验通过项
  9.     if (validate.isEmpty()) {
  10.         // 校验通过，才会执行业务逻辑处理
  12.     } else {
  13.         for (ConstraintViolation<UserDTO> userDTOConstraintViolation : validate) {
  14.             // 校验失败，做其它逻辑
  15.             System.out.println(userDTOConstraintViolation);
  16.         }
  17.     }
  18.     return Result.ok();
  19. }

快速失败(Fail Fast)

Spring Validation默认会校验完所有字段，然后才抛出异常。可以通过一些简单的配置，开启Fali Fast模式，一旦校验失败就立即返回。

  1. @Bean
  2. public Validator validator() {
  3.     ValidatorFactory validatorFactory = Validation.byProvider(HibernateValidator.class)
  4.             .configure()
  5.             // 快速失败模式
  6.             .failFast(true)
  7.             .buildValidatorFactory();
  8.     return validatorFactory.getValidator();
  9. }

@Valid和@Validated区别

实现原理

requestBody参数校验实现原理

在spring-mvc中，RequestResponseBodyMethodProcessor是用于解析@RequestBody标注的参数以及处理@ResponseBody标注方法的返回值的。显然，执行参数校验的逻辑肯定就在解析参数的方法resolveArgument()中：

  1. public class RequestResponseBodyMethodProcessor extends AbstractMessageConverterMethodProcessor {
  2.     @Override
  3.     public Object resolveArgument(MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer,
  4.                                   NativeWebRequest webRequest, @Nullable WebDataBinderFactory binderFactory) throws Exception {
  6.         parameter = parameter.nestedIfOptional();
  7.         //将请求数据封装到DTO对象中
  8.         Object arg = readWithMessageConverters(webRequest, parameter, parameter.getNestedGenericParameterType());
  9.         String name = Conventions.getVariableNameForParameter(parameter);
  11.         if (binderFactory != null) {
  12.             WebDataBinder binder = binderFactory.createBinder(webRequest, arg, name);
  13.             if (arg != null) {
  14.                 // 执行数据校验
  15.                 validateIfApplicable(binder, parameter);
  16.                 if (binder.getBindingResult().hasErrors() && isBindExceptionRequired(binder, parameter)) {
  17.                     throw new MethodArgumentNotValidException(parameter, binder.getBindingResult());
  18.                 }
  19.             }
  20.             if (mavContainer != null) {
  21.                 mavContainer.addAttribute(BindingResult.MODEL_KEY_PREFIX + name, binder.getBindingResult());
  22.             }
  23.         }
  24.         return adaptArgumentIfNecessary(arg, parameter);
  25.     }
  26. }

可以看到，resolveArgument()调用了validateIfApplicable()进行参数校验。

  1. protected void validateIfApplicable(WebDataBinder binder, MethodParameter parameter) {
  2.     // 获取参数注解，比如@RequestBody、@Valid、@Validated
  3.     Annotation[] annotations = parameter.getParameterAnnotations();
  4.     for (Annotation ann : annotations) {
  5.         // 先尝试获取@Validated注解
  6.         Validated validatedAnn = AnnotationUtils.getAnnotation(ann, Validated.class);
  7.         //如果直接标注了@Validated，那么直接开启校验。
  8.         //如果没有，那么判断参数前是否有Valid起头的注解。
  9.         if (validatedAnn != null || ann.annotationType().getSimpleName().startsWith("Valid")) {
  10.             Object hints = (validatedAnn != null ? validatedAnn.value() : AnnotationUtils.getValue(ann));
  11.             Object[] validationHints = (hints instanceof Object[] ? (Object[]) hints : new Object[] {hints});
  12.             //执行校验
  13.             binder.validate(validationHints);
  14.             break;
  15.         }
  16.     }
  17. }

看到这里，大家应该能明白为什么这种场景下@Validated、@Valid两个注解可以混用。我们接下来继续看WebDataBinder.validate()实现。

  1. @Override
  2. public void validate(Object target, Errors errors, Object... validationHints) {
  3.     if (this.targetValidator != null) {
  4.         processConstraintViolations(
  5.             //此处调用Hibernate Validator执行真正的校验
  6.             this.targetValidator.validate(target, asValidationGroups(validationHints)), errors);
  7.     }
  8. }

最终发现底层最终还是调用了Hibernate Validator进行真正的校验处理。

方法级别的参数校验实现原理

上面提到的将参数一个个平铺到方法参数中，然后在每个参数前面声明约束注解的校验方式，就是方法级别的参数校验。
实际上，这种方式可用于任何Spring Bean的方法上，比如Controller/Service等。其底层实现原理就是AOP，具体来说是通过MethodValidationPostProcessor动态注册AOP切面，然后使用MethodValidationInterceptor对切点方法织入增强。

  1. public class MethodValidationPostProcessor extends AbstractBeanFactoryAwareAdvisingPostProcessorimplements InitializingBean {
  2.     @Override
  3.     public void afterPropertiesSet() {
  4.         //为所有`@Validated`标注的Bean创建切面
  5.         Pointcut pointcut = new AnnotationMatchingPointcut(this.validatedAnnotationType, true);
  6.         //创建Advisor进行增强
  7.         this.advisor = new DefaultPointcutAdvisor(pointcut, createMethodValidationAdvice(this.validator));
  8.     }
  10.     //创建Advice，本质就是一个方法拦截器
  11.     protected Advice createMethodValidationAdvice(@Nullable Validator validator) {
  12.         return (validator != null ? new MethodValidationInterceptor(validator) : new MethodValidationInterceptor());
  13.     }
  14. }

接着看一下MethodValidationInterceptor：

  1. public class MethodValidationInterceptor implements MethodInterceptor {
  2.     @Override
  3.     public Object invoke(MethodInvocation invocation) throws Throwable {
  4.         //无需增强的方法，直接跳过
  5.         if (isFactoryBeanMetadataMethod(invocation.getMethod())) {
  6.             return invocation.proceed();
  7.         }
  8.         //获取分组信息
  9.         Class<?>[] groups = determineValidationGroups(invocation);
  10.         ExecutableValidator execVal = this.validator.forExecutables();
  11.         Method methodToValidate = invocation.getMethod();
  12.         Set<ConstraintViolation<Object>> result;
  13.         try {
  14.             //方法入参校验，最终还是委托给Hibernate Validator来校验
  15.             result = execVal.validateParameters(
  16.                 invocation.getThis(), methodToValidate, invocation.getArguments(), groups);
  17.         }
  18.         catch (IllegalArgumentException ex) {
  19.             ...
  20.         }
  21.         //有异常直接抛出
  22.         if (!result.isEmpty()) {
  23.             throw new ConstraintViolationException(result);
  24.         }
  25.         //真正的方法调用
  26.         Object returnValue = invocation.proceed();
  27.         //对返回值做校验，最终还是委托给Hibernate Validator来校验
  28.         result = execVal.validateReturnValue(invocation.getThis(), methodToValidate, returnValue, groups);
  29.         //有异常直接抛出
  30.         if (!result.isEmpty()) {
  31.             throw new ConstraintViolationException(result);
  32.         }
  33.         return returnValue;
  34.     }
  35. }

实际上，不管是requestBody参数校验还是方法级别的校验，最终都是调用Hibernate Validator执行校验，Spring Validation只是做了一层封装。