从深处去掌握数据校验@Valid的作用(级联校验)

【小家Java】深入了解数据校验:Java Bean Validation 2.0(JSR303、JSR349、JSR380)Hibernate-Validation 6.x使用案例
【小家Spring】让Controller支持对平铺参数执行数据校验(默认Spring MVC使用@Valid只能对JavaBean进行校验)
【小家Spring】Spring方法级别数据校验:@Validated + MethodValidationPostProcessor优雅的完成数据校验动作

对Spring感兴趣可扫码加入wx群:`Java高工、架构师3群`(文末有二维码) 前言

关于Bean Validation的基本原理篇完结之后,接下来就是小伙伴最为关心的干货:使用篇
如果说要使用Bean Validation数据校验,我十分相信小伙伴们都能够使用,但估计大都是有个前提的:Spring MVC环境。我极其简单的调查了一下,近乎99%的人都是只把数据校验使用在Spring MVC的Controller层面的,而且几乎90%的人都是让它必须和@RequestBody一起来使用去校验JavaBean入参~

如果这么去理解Bean Validation的使用,那就有点太过于片面了,毕竟被Spring包裹起来,你其实很难去知道它真正做的事。
熟悉我文章风格的人知道,每篇文章我都会带你领略一些不一样的风景,本章亦不例外,会让你知道数据校验在Spring框架之外的一些事~

分组校验

在我的前置原理篇文章,分组校验其实是没太大必要说的,因为使用起来确实非常的简单。此处还是给个分组校验的使用案例吧:

@Getter @Setter @ToString public class Person { // 错误消息message是可以自定义的 @NotNull(message = "{message} -> 名字不能为null", groups = Simple.class) public String name; @Max(value = 10, groups = Simple.class) @Positive(groups = Default.class) // 内置的分组:default public Integer age; @NotNull(groups = Complex.class) @NotEmpty(groups = Complex.class) private List<@Email String> emails; @Future(groups = Complex.class) private Date start; // 定义两个组 Simple组和Complex组 interface Simple { } interface Complex { } }

执行分组校验:

public static void main(String[] args) { Person person = new Person(); //person.setName("fsx"); person.setAge(18); // email校验:虽然是List都可以校验哦 person.setEmails(Arrays.asList("fsx@gmail.com", "baidu@baidu.com", "aaa.com")); //person.setStart(new Date()); //start 需要是一个将来的时间: Sun Jul 21 10:45:03 CST 2019 //person.setStart(new Date(System.currentTimeMillis() + 10000)); //校验通过 HibernateValidatorConfiguration configure = Validation.byProvider(HibernateValidator.class).configure(); ValidatorFactory validatorFactory = configure.failFast(false).buildValidatorFactory(); // 根据validatorFactory拿到一个Validator Validator validator = validatorFactory.getValidator(); // 分组校验(可以区分对待Default组、Simple组、Complex组) Set<ConstraintViolation<Person>> result = validator.validate(person, Person.Simple.class); //Set<ConstraintViolation<Person>> result = validator.validate(person, Person.Complex.class); // 对结果进行遍历输出 result.stream().map(v -> v.getPropertyPath() + " " + v.getMessage() + ": " + v.getInvalidValue()) .forEach(System.out::println); }

运行打印:

age 最大不能超过10: 18 name {message} -> 名字不能为null -> 名字不能为null: null

可以直观的看到效果,此处的校验只执行Person.Simple.class这个Group组上的约束~

分组约束在Spring MVC中的使用场景还是相对比较多的,但是需要注意的是:javax.validation.Valid没有提供指定分组的,但是org.springframework.validation.annotation.Validated扩展提供了直接在注解层面指定分组的能力

@Valid注解

我们知道JSR提供了一个@Valid注解供以使用,在本文之前,绝大多数小伙伴都是在Controller中并且结合@RequestBody一起来使用它,但在本文之后,你定会对它有个全新的认识~

==该注解用于验证级联的属性方法参数方法返回类型。==
当验证属性、方法参数或方法返回类型时,将验证对象及其属性上定义的约束,另外:此行为是递归应用的。

:::为了理解@Valid,那就得知道处理它的时机:::

MetaDataProvider

元数据提供者:约束相关元数据(如约束、默认组序列等)的Provider。它的作用和特点如下:

基于不同的元数据:如xml、注解。(还有个编程映射) 这三种类型。对应的枚举类为:

public enum ConfigurationSource { ANNOTATION( 0 ), XML( 1 ), API( 2 ); //programmatic API }

MetaDataProvider只返回直接为一个类配置的元数据

它不处理从超类、接口合并的元数据(简单的说你@Valid放在接口处是无效的)

public interface MetaDataProvider { // 将**注解处理选项**归还给此Provider配置。 它的唯一实现类为:AnnotationProcessingOptionsImpl // 它可以配置比如:areMemberConstraintsIgnoredFor areReturnValueConstraintsIgnoredFor // 也就说可以配置:让免于被校验~~~~~~(开绿灯用的) AnnotationProcessingOptions getAnnotationProcessingOptions(); // 返回作用在此Bean上面的`BeanConfiguration` 若没有就返回null了 // BeanConfiguration持有ConfigurationSource的引用~ <T> BeanConfiguration<? super T> getBeanConfiguration(Class<T> beanClass); } // 表示源于一个ConfigurationSource的一个Java类型的完整约束相关配置。 包含字段、方法、类级别上的元数据 // 当然还包含有默认组序列上的元数据(使用较少) public class BeanConfiguration<T> { // 三种来源的枚举 private final ConfigurationSource source; private final Class<T> beanClass; // ConstrainedElement表示待校验的元素,可以知道它会如下四个子类: // ConstrainedField/ConstrainedType/ConstrainedParameter/ConstrainedExecutable // 注意:ConstrainedExecutable持有的是java.lang.reflect.Executable对象 //它的两个子类是java.lang.reflect.Method和Constructor private final Set<ConstrainedElement> constrainedElements; private final List<Class<?>> defaultGroupSequence; private final DefaultGroupSequenceProvider<? super T> defaultGroupSequenceProvider; ... // 它自己并不处理什么逻辑,参数都是通过构造器传进来的 }

内容版权声明:除非注明,否则皆为本站原创文章。

转载注明出处:https://www.heiqu.com/zywyjz.html