媒介
本文会详细先容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，则须要手动引入依靠：
<dependency> <groupId>org.hibernate</groupId> <artifactId>hibernate-validator</artifactId> <version>6.0.1.Final</version> </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对象。
@Data public class UserDTO { private Long userId; @NotNull @Length(min = 2, max = 10) private String userName; @NotNull @Length(min = 6, max = 20) private String account; @NotNull @Length(min = 6, max = 20) private String password; }
@PostMapping("/save") public Result saveUser(@RequestBody @Validated UserDTO userDTO) { return Result.ok(); } 这种环境下，利用****@Valid****和****@Validated****都可以。
requestParam/PathVariable****参数校验
GET哀求一样平常会利用requestParam/PathVariable传参。假如参数比力多 (比如凌驾 6 个)，照旧保举利用DTO对象吸收。否则，保举将一个个参数平铺到方法入参中。在这种环境下，必须在Controller类上标注@Validated注解，并在入参上声明束缚注解 (如@Min等)。假如校验失败，会抛出ConstraintViolationException非常。代码示比方下：
@RequestMapping("/api/user") @RestController @Validated public class UserController { @GetMapping("{userId}") public Result detail(@PathVariable("userId") @Min(10000000000000000L) Long userId) { UserDTO userDTO = new UserDTO(); userDTO.setUserId(userId); userDTO.setAccount("11111111111111111"); userDTO.setUserName("xixi"); userDTO.setAccount("11111111111111111"); return Result.ok(userDTO); } @GetMapping("getByAccount") public Result getByAccount(@Length(min = 6, max = 20) @NotNull String account) { UserDTO userDTO = new UserDTO(); userDTO.setUserId(10000000000000003L); userDTO.setAccount(account); userDTO.setUserName("xixi"); userDTO.setAccount("11111111111111111"); return Result.ok(userDTO); } } 同一非常处理处罚
前面说过，假如校验失败，会抛出MethodArgumentNotValidException大概ConstraintViolationException非常。在实际项目开辟中，通常会用同一非常处理处罚来返回一个更友爱的提示。比如我们体系要求无论发送什么非常，http的状态码必须返回200，由业务码去区分体系的非常环境。
@RestControllerAdvice public class CommonExceptionHandler { @ExceptionHandler({MethodArgumentNotValidException.class}) @ResponseStatus(HttpStatus.OK) @ResponseBody public Result handleMethodArgumentNotValidException(MethodArgumentNotValidException ex) { BindingResult bindingResult = ex.getBindingResult(); StringBuilder sb = new StringBuilder("校验失败:"); for (FieldError fieldError : bindingResult.getFieldErrors()) { sb.append(fieldError.getField()).append("：").append(fieldError.getDefaultMessage()).append(", "); } String msg = sb.toString(); return Result.fail(BusinessCode.参数校验失败, msg); } @ExceptionHandler({ConstraintViolationException.class}) @ResponseStatus(HttpStatus.OK) @ResponseBody public Result handleConstraintViolationException(ConstraintViolationException ex) { return Result.fail(BusinessCode.参数校验失败, ex.getMessage()); } } 进阶利用
分组校验
在实际项目中，大概多个方法须要利用同一个DTO类来吸收参数，而差异方法的校验规则很大概是不一样的。这个时候，简单地在DTO类的字段上加束缚注解无法办理这个标题。因此，spring-validation支持了分组校验的功能，专门用来办理这类标题。照旧上面的例子，比如生存User的时候，UserId是可空的，但是更新User的时候，UserId的值必须>=10000000000000000L；别的字段的校验规则在两种环境下一样。这个时候利用分组校验的代码示比方下：
@Data public class UserDTO { @Min(value = 10000000000000000L, groups = Update.class) private Long userId; @NotNull(groups = {Save.class, Update.class}) @Length(min = 2, max = 10, groups = {Save.class, Update.class}) private String userName; @NotNull(groups = {Save.class, Update.class}) @Length(min = 6, max = 20, groups = {Save.class, Update.class}) private String account; @NotNull(groups = {Save.class, Update.class}) @Length(min = 6, max = 20, groups = {Save.class, Update.class}) private String password; public interface Save { } public interface Update { } }
@PostMapping("/save") public Result saveUser(@RequestBody @Validated(UserDTO.Save.class) UserDTO userDTO) { return Result.ok(); } @PostMapping("/update") public Result updateUser(@RequestBody @Validated(UserDTO.Update.class) UserDTO userDTO) { return Result.ok(); } 嵌套校验
前面的示例中，DTO类里面的字段都是基本数据范例和String范例。但是实际场景中，有大概某个字段也是一个对象，这种环境先，可以利用嵌套校验。
比如，上面生存User信息的时候同时还带有Job信息。须要注意的是，此时****DTO****类的对应字段必须标记****@Valid****注解。
@Data public class UserDTO { @Min(value = 10000000000000000L, groups = Update.class) private Long userId; @NotNull(groups = {Save.class, Update.class}) @Length(min = 2, max = 10, groups = {Save.class, Update.class}) private String userName; @NotNull(groups = {Save.class, Update.class}) @Length(min = 6, max = 20, groups = {Save.class, Update.class}) private String account; @NotNull(groups = {Save.class, Update.class}) @Length(min = 6, max = 20, groups = {Save.class, Update.class}) private String password; @NotNull(groups = {Save.class, Update.class}) @Valid private Job job; @Data public static class Job { @Min(value = 1, groups = Update.class) private Long jobId; @NotNull(groups = {Save.class, Update.class}) @Length(min = 2, max = 10, groups = {Save.class, Update.class}) private String jobName; @NotNull(groups = {Save.class, Update.class}) @Length(min = 2, max = 10, groups = {Save.class, Update.class}) private String position; } public interface Save { } public interface Update { } } 嵌套校验可以连合分组校验一起利用。另有就是嵌套聚集校验会对聚集里面的每一项都举行校验，比方List<Job>字段会对这个list里面的每一个Job对象都举行校验。
聚集校验
假如哀求体直接传递了json数组给背景，并盼望对数组中的每一项都举行参数校验。此时，假如我们直接利用java.util.Collection下的list大概set来吸收数据，参数校验并不会收效！我们可以利用自界说list聚集来吸收参数：
- 包装****List****范例，并声明****@Valid****注解
public class ValidationList<E> implements List<E> { @Delegate @Valid public List<E> list = new ArrayList<>(); @Override public String toString() { return list.toString(); } } @Delegate注解受lombok版本限定，1.18.6以上版本可支持。假如校验不通过，会抛出NotReadablePropertyException，同样可以利用同一非常举行处理处罚。
比如，我们须要一次性生存多个User对象，Controller层的方法可以这么写：
@PostMapping("/saveList") public Result saveList(@RequestBody @Validated(UserDTO.Save.class) ValidationList<UserDTO> userList) { return Result.ok(); } 自界说校验
业务需求总是比框架提供的这些简单校验要复杂的多，我们可以自界说校验来满足我们的需求。自界说spring validation非常简单，假设我们自界说加密id（由数字大概a-f的字母构成，32-256长度）校验，主要分为两步：
@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER}) @Retention(RUNTIME) @Documented @Constraint(validatedBy = {EncryptIdValidator.class}) public @interface EncryptId { String message() default "加密id格式错误"; Class<?>[] groups() default {}; Class<? extends Payload>[] payload() default {}; }
- 实现ConstraintValidator接口编写束缚校验器
public class EncryptIdValidator implements ConstraintValidator<EncryptId, String> { private static final Pattern PATTERN = Pattern.compile("^[a-f\\d]{32,256}$"); @Override public boolean isValid(String value, ConstraintValidatorContext context) { if (value != null) { Matcher matcher = PATTERN.matcher(value); return matcher.find(); } return true; } } 这样我们就可以利用@EncryptId举行参数校验了！
编程式校验
上面的示例都是基于注解来实现自动校验的，在某些环境下，我们大概盼望以编程方式调用验证。这个时候可以注入javax.validation.Validator对象，然后再调用其api。
@Autowired private javax.validation.Validator globalValidator; @PostMapping("/saveWithCodingValidate") public Result saveWithCodingValidate(@RequestBody UserDTO userDTO) { Set<ConstraintViolation<UserDTO>> validate = globalValidator.validate(userDTO, UserDTO.Save.class); if (validate.isEmpty()) { } else { for (ConstraintViolation<UserDTO> userDTOConstraintViolation : validate) { System.out.println(userDTOConstraintViolation); } } return Result.ok(); } 快速失败 (Fail Fast)
Spring Validation默认会校验完全部字段，然后才抛出非常。可以通过一些简单的设置，开启Fali Fast模式，一旦校验失败就立即返回。
@Bean public Validator validator() { ValidatorFactory validatorFactory = Validation.byProvider(HibernateValidator.class) .configure() .failFast(true) .buildValidatorFactory(); return validatorFactory.getValidator(); } @Valid****和****@Validated****区别
[图片上传失败...(image-ed8145-1652078773542)]
实现原理
requestBody****参数校验实现原理
在spring-mvc中，RequestResponseBodyMethodProcessor是用于剖析@RequestBody标注的参数以及处理处罚@ResponseBody标注方法的返回值的。显然，实行参数校验的逻辑肯定就在剖析参数的方法resolveArgument()中：
public class RequestResponseBodyMethodProcessor extends AbstractMessageConverterMethodProcessor { @Override public Object resolveArgument(MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer, NativeWebRequest webRequest, @Nullable WebDataBinderFactory binderFactory) throws Exception { parameter = parameter.nestedIfOptional(); Object arg = readWithMessageConverters(webRequest, parameter, parameter.getNestedGenericParameterType()); String name = Conventions.getVariableNameForParameter(parameter); if (binderFactory != null) { WebDataBinder binder = binderFactory.createBinder(webRequest, arg, name); if (arg != null) { validateIfApplicable(binder, parameter); if (binder.getBindingResult().hasErrors() && isBindExceptionRequired(binder, parameter)) { throw new MethodArgumentNotValidException(parameter, binder.getBindingResult()); } } if (mavContainer != null) { mavContainer.addAttribute(BindingResult.MODEL_KEY_PREFIX + name, binder.getBindingResult()); } } return adaptArgumentIfNecessary(arg, parameter); } } 可以看到，resolveArgument()调用了validateIfApplicable()举行参数校验。
protected void validateIfApplicable(WebDataBinder binder, MethodParameter parameter) { Annotation[] annotations = parameter.getParameterAnnotations(); for (Annotation ann : annotations) { Validated validatedAnn = AnnotationUtils.getAnnotation(ann, Validated.class); if (validatedAnn != null || ann.annotationType().getSimpleName().startsWith("Valid")) { Object hints = (validatedAnn != null ? validatedAnn.value() : AnnotationUtils.getValue(ann)); Object[] validationHints = (hints instanceof Object[] ? (Object[]) hints : new Object[] {hints}); binder.validate(validationHints); break; } } } 看到这里，各人应该能明白为什么这种场景下@Validated、@Valid两个注解可以混用。我们接下来继承看WebDataBinder.validate()实现。
@Override public void validate(Object target, Errors errors, Object... validationHints) { if (this.targetValidator != null) { processConstraintViolations( this.targetValidator.validate(target, asValidationGroups(validationHints)), errors); } } 终极发现底层终极照旧调用了Hibernate Validator举行真正的校验处理处罚。
方法级别的参数校验实现原理
上面提到的将参数一个个平铺到方法参数中，然后在每个参数前面声明束缚注解的校验方式，就是方法级别的参数校验。实际上，这种方式可用于任何Spring Bean的方法上，比如Controller/Service等。其底层实现原理就是****AOP****，详细来说是通过****MethodValidationPostProcessor****动态注册****AOP****切面，然后利用****MethodValidationInterceptor****对切点方法织入增强。
public class MethodValidationPostProcessor extends AbstractBeanFactoryAwareAdvisingPostProcessorimplements InitializingBean { @Override public void afterPropertiesSet() { Pointcut pointcut = new AnnotationMatchingPointcut(this.validatedAnnotationType, true); this.advisor = new DefaultPointcutAdvisor(pointcut, createMethodValidationAdvice(this.validator)); } protected Advice createMethodValidationAdvice(@Nullable Validator validator) { return (validator != null ? new MethodValidationInterceptor(validator) : new MethodValidationInterceptor()); } } 接着看一下MethodValidationInterceptor：
public class MethodValidationInterceptor implements MethodInterceptor { @Override public Object invoke(MethodInvocation invocation) throws Throwable { if (isFactoryBeanMetadataMethod(invocation.getMethod())) { return invocation.proceed(); } Class<?>[] groups = determineValidationGroups(invocation); ExecutableValidator execVal = this.validator.forExecutables(); Method methodToValidate = invocation.getMethod(); Set<ConstraintViolation<Object>> result; try { result = execVal.validateParameters( invocation.getThis(), methodToValidate, invocation.getArguments(), groups); } catch (IllegalArgumentException ex) { ... } if (!result.isEmpty()) { throw new ConstraintViolationException(result); } Object returnValue = invocation.proceed(); result = execVal.validateReturnValue(invocation.getThis(), methodToValidate, returnValue, groups); if (!result.isEmpty()) { throw new ConstraintViolationException(result); } return returnValue; } } 实际上，不管是****requestBody参数校验****照旧****方法级别的校验****，终极都是调用****Hibernate Validator****实行校验，****Spring Validation****只是做了一层封装。 |
