没有任何技术方案会是一种银弹,任何东西都是有利弊的java
关于Bean Validation
的基本原理篇完结以后,接下来就是小伙伴最为关心的干货:使用篇。
若是说要使用Bean Validation
数据校验,我十分相信小伙伴们都可以使用,但估计大都是有个前提的:Spring MVC
环境。我极其简单的调查了一下,近乎99%
的人都是只把数据校验使用在Spring MVC
的Controller
层面的,并且几乎90%
的人都是让它必须和@RequestBody
一块儿来使用去校验JavaBean
入参~git
若是这么去理解Bean Validation
的使用,那就有点太过于片面了,毕竟被Spring包裹起来,你其实很难去知道它真正作的事。
熟悉我文章风格的人知道,每篇文章我都会带你领略一些不同的风景,本章亦不例外,会让你知道数据校验在Spring
框架以外的一些事~github
在个人前置原理篇文章,分组校验实际上是没太大必要说的,由于使用起来确实很是的简单。此处仍是给个分组校验的使用案例吧:web
@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); }
运行打印:spring
age 最大不能超过10: 18 name {message} -> 名字不能为null -> 名字不能为null: null
能够直观的看到效果,此处的校验只执行Person.Simple.class
这个Group
组上的约束~编程
分组约束在Spring MVC中的使用场景仍是相对比较多的,可是须要注意的是:
javax.validation.Valid
没有提供指定分组的,可是org.springframework.validation.annotation.Validated
扩展提供了直接在注解层面指定分组的能力segmentfault
咱们知道JSR
提供了一个@Valid
注解供以使用,在本文以前,绝大多数小伙伴都是在Controller
中而且结合@RequestBody
一块儿来使用它,但在本文以后,你定会对它有个全新的认识~数组
该注解用于验证级联的属性、方法参数或方法返回类型。
当验证属性、方法参数或方法返回类型时,将验证对象及其属性上定义的约束,另外:此行为是递归应用的。
安全
:::为了理解@Valid
,那就得知道处理它的时机:::
元数据提供者:约束相关元数据(如约束、默认组序列等)的Provider
。它的做用和特色以下:
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; ... // 它本身并不处理什么逻辑,参数都是经过构造器传进来的 }
它的继承树:
三个实现类对应着上面所述的三种元数据类型。本文很显然只须要关注和注解相关的:AnnotationMetaDataProvider
这个元数据均来自于注解的标注,而后它是Hibernate Validation
的默认configuration source
。它这里会处理标注有@Valid
的元素~
public class AnnotationMetaDataProvider implements MetaDataProvider { private final ConstraintHelper constraintHelper; private final TypeResolutionHelper typeResolutionHelper; private final AnnotationProcessingOptions annotationProcessingOptions; private final ValueExtractorManager valueExtractorManager; // 这是一个很是重要的属性,它会记录着当前Bean 全部的待校验的Bean信息~~~ private final BeanConfiguration<Object> objectBeanConfiguration; // 惟一构造函数 public AnnotationMetaDataProvider(ConstraintHelper constraintHelper, TypeResolutionHelper typeResolutionHelper, ValueExtractorManager valueExtractorManager, AnnotationProcessingOptions annotationProcessingOptions) { this.constraintHelper = constraintHelper; this.typeResolutionHelper = typeResolutionHelper; this.valueExtractorManager = valueExtractorManager; this.annotationProcessingOptions = annotationProcessingOptions; // 默认状况下,它去把Object相关的全部的方法都retrieve:检索出来放着 我比较费解这件事~~~ // 后面才发现:一切为了效率 this.objectBeanConfiguration = retrieveBeanConfiguration( Object.class ); } // 实现接口方法 @Override public AnnotationProcessingOptions getAnnotationProcessingOptions() { return new AnnotationProcessingOptionsImpl(); } // 若是你的Bean是Object 就直接返回了~~~(大多数状况下 都是Object) @Override @SuppressWarnings("unchecked") public <T> BeanConfiguration<T> getBeanConfiguration(Class<T> beanClass) { if ( Object.class.equals( beanClass ) ) { return (BeanConfiguration<T>) objectBeanConfiguration; } return retrieveBeanConfiguration( beanClass ); } }
如上可知,核心解析逻辑在retrieveBeanConfiguration()
这个私有方法上。总结一下调用此方法的两个原始入口(一个构造器,一个接口方法):
ValidatorFactory.getValidator()
获取校验器的时候,初始化时会本身new
一个,调用栈以下图:Validator.validate()
方法的时候,beanMetaDataManager.getBeanMetaData( rootBeanClass )
它会遍历初始化时全部的metaDataProviders
(默认状况下两个,没有xml方式的),拿出全部的BeanConfiguration
交给BeanMetaDataBuilder
,最终构建出一个属于此Bean的BeanMetaData
。对此有一点注意事项描述以下:MetaDataProvider
时会调用ClassHierarchyHelper.getHierarchy( beanClass )
方法,不只仅处理本类。拿到本类本身和全部父类后,统一交给provider.getBeanConfiguration( clazz )
处理(也就是说任何一个类都会把Object类处理一遍)retrieveBeanConfiguration()
详情这个方法说白了,就是从Bean里面去检索属性、方法、构造器等须要校验的ConstrainedElement项
。
private <T> BeanConfiguration<T> retrieveBeanConfiguration(Class<T> beanClass) { // 它检索的范围是:clazz.getDeclaredFields() 什么意思:就是搜集到本类全部的字段 包括private等等 可是不包括父类的全部字段 Set<ConstrainedElement> constrainedElements = getFieldMetaData( beanClass ); constrainedElements.addAll( getMethodMetaData( beanClass ) ); constrainedElements.addAll( getConstructorMetaData( beanClass ) ); //TODO GM: currently class level constraints are represented by a PropertyMetaData. This //works but seems somewhat unnatural // 这个TODO颇有意思:当前,类级约束由PropertyMetadata表示。这是可行的,但彷佛有点不天然 // ReturnValueMetaData、ExecutableMetaData、ParameterMetaData、PropertyMetaData // 总之吧:此处就是把类级别的校验器放进来了(这个set大部分时候都是空的) Set<MetaConstraint<?>> classLevelConstraints = getClassLevelConstraints( beanClass ); if (!classLevelConstraints.isEmpty()) { ConstrainedType classLevelMetaData = new ConstrainedType(ConfigurationSource.ANNOTATION, beanClass, classLevelConstraints); constrainedElements.add(classLevelMetaData); } // 组装成一个BeanConfiguration返回 return new BeanConfiguration<>(ConfigurationSource.ANNOTATION, beanClass, constrainedElements, getDefaultGroupSequence( beanClass ), //此类上标注的全部@GroupSequence注解 getDefaultGroupSequenceProvider( beanClass ) // 此类上标注的全部@GroupSequenceProvider注解 ); }
这一步骤把该Bean上的字段、方法等等须要校验的项都提取出来。就拿上例中的Demo校验Person
类来讲,最终得出的BeanConfiguration
以下:(两个)
这是直观的结论,能够看到仅仅是一个简单的类其实所包含的项是挺多的。
此处说一句:项是有这么多,可是并非每个都须要走验证逻辑的。由于毕竟大多数项上面并无约束(注解),大多数
ConstrainedElement.getConstraints()
为空嘛~
总得来讲,我我的建议不能光只记忆结论,由于那很容易忘记,因此仍是得稍微深刻一点,让记忆更深入吧。那就从下面四个方面深刻:
Field
:clazz.getDeclaredFields()
Field
都包装成ConstrainedElement
存放起来~~~Field
上标注的注解进行了保存Method
:clazz.getDeclaredMethods()
ConstrainedExecutable
装着~~(ConstrainedExecutable
也是个ConstrainedElement
)。在此期间它完成了以下事(方法和构造器都复杂点,由于包含入参和返回值):彻底同处理Method,略
ConstraintDescriptor
ConstraintDescriptor
进行处理,最终都转换Set<MetaConstraint<?>>
这个类型Set<MetaConstraint<?>>
用一个ConstrainedType
包装起来(ConstrainedType
是个ConstrainedElement
)关于级联校验此处补充说明一点,处理Type,都会处理级联校验状况,而且仍是递归处理:
也就是这个方法(课件@Valid
在此处生效):
// type解释:分以下N中状况 // Field为:.getGenericType() // 字段的类型 // Method为:.getGenericReturnType() // 返回值类型 // Constructor:.getDeclaringClass() // 构造器所在类 // annotatedElement:可不必定说必定要有注解才能进来(每一个字段、方法、构造器等都能传进来) private CascadingMetaDataBuilder getCascadingMetaData(Type type, AnnotatedElement annotatedElement, Map<TypeVariable<?>, CascadingMetaDataBuilder> containerElementTypesCascadingMetaData) { return CascadingMetaDataBuilder.annotatedObject( type, annotatedElement.isAnnotationPresent( Valid.class ), containerElementTypesCascadingMetaData, getGroupConversions( annotatedElement ) ); }
这里对咱们理解级联校验最重要的一句是:annotatedElement.isAnnotationPresent(Valid.class)
。也就是说:若元素被此注解标注了,那就证实须要对它进行级联校验,这就是JSR定位@Valid
的做用~
Spring提高了它???请关注后文Spring对它的应用吧~
ConstraintValidator.isValid()
调用处咱们知道,每一个约束注解都是交给约束校验器ConstraintValidator.isValid()
这个方法来处理的,它被调用(生效)的地方在此(惟一处):
public abstract class ConstraintTree<A extends Annotation> { ... protected final <T, V> Set<ConstraintViolation<T>> validateSingleConstraint(ValidationContext<T> executionContext, ValueContext<?, ?> valueContext, ConstraintValidatorContextImpl constraintValidatorContext, ConstraintValidator<A, V> validator) { ... V validatedValue = (V) valueContext.getCurrentValidatedValue(); isValid = validator.isValid( validatedValue, constraintValidatorContext ); ... // 显然校验不经过就返回错误消息 不然返回空集合 if ( !isValid ) { return executionContext.createConstraintViolations(valueContext, constraintValidatorContext); } return Collections.emptySet(); } ... }
这个方法的调用,会在执行每一个Group
的时候
success = metaConstraint.validateConstraint( validationContext, valueContext );
MetaConstraint
在上面检索的时候就已经准备好了,最后经过ConstrainedElement.getConstraints
就拿到了每一个元素的校验器们,继续调用
// ConstraintTree<A> boolean validationResult = constraintTree.validateConstraints( executionContext, valueContext );
so,最终就调用到了isValid
这个真正作事的方法上了。
说了这么多,你可能还云里雾里,那么就show
一把吧:
上面用一个示例校验Person
这个JavaBean
了,可是你会发现示例中咱们全都是校验的Field
属性。从理论里咱们知道了Bean Validation
它是有校验方法、构造器、入参甚至递归校验级联属性的能力的:
略
这些是不能直接使用的,须要在运行时进行校验。具体使用可参考:【小家Spring】让Controller支持对平铺参数执行数据校验(默认Spring MVC使用@Valid只能对JavaBean进行校验)
什么叫级联校验,其实就是带校验的成员里存在级联对象时,也要对它完成校验。这个在实际应用场景中是比较常见的,好比入参Person
对象中,还持有Child
对象,咱们不只仅要完成Person
的校验,也依旧还要对Child内的属性校验:
@Getter @Setter @ToString public class Person { @NotNull private String name; @NotNull @Positive private Integer age; @Valid @NotNull private InnerChild child; @Getter @Setter @ToString public static class InnerChild { @NotNull private String name; @NotNull @Positive private Integer age; } }
校验逻辑以下:
public static void main(String[] args) { Person person = new Person(); person.setName("fsx"); Person.InnerChild child = new Person.InnerChild(); child.setName("fsx-son"); child.setAge(-1); person.setChild(child); // 放进去 Validator validator = Validation.byProvider(HibernateValidator.class).configure().failFast(false) .buildValidatorFactory().getValidator(); Set<ConstraintViolation<Person>> result = validator.validate(person); // 输出错误消息 result.stream().map(v -> v.getPropertyPath() + " " + v.getMessage() + ": " + v.getInvalidValue()) .forEach(System.out::println); }
运行:
child.age 必须是正数: -1 age 不能为null: null
对child.age
这个级联属性校验成功~
原本这个不用写的,可是为了保证系列文章的完整性,仍是总结以下
说明:个人总结比绝大多数文章都会详细点,所以看此一篇就够了
全部的约束注解都是能够重复标记的,由于它身上都有以下重复标记的标注:
@Repeatable(List.class)
约束注解 | 支持的类型 | 说明 |
---|---|---|
@AssertFalse | Boolean,boolean | 元素值必须是false |
@AssertTrue | Boolean,boolean | 元素值必须是true |
@DecimalMax | BigDecimal,BigInteger, byte,short, int, long,等任何Number或CharSequence(存储的是数字) | value:数值上限 inclusive:是否包含此上限,默认true是包含的 |
@DecimalMin | 同上 | 不解释 |
@Max | 同上 | 值=max,也是校验经过的 |
@Min | 同上 | 不解释 |
@Digits | 同上 | integer:整数位数上限 fraction:小数位数上限 |
@Positive | 同上 | 2.0。必须是严格的正数。0都不行~ |
@PositiveOrZero | 同上 | 2.0。 0是被容许的 |
@Negative | 同上 | 2.0。 必须是严格的负数。0都不行 |
@NegativeOrZero | 同上 | 2.0。 0是被容许的 |
CharSequence子类型(如String) | 2.0。值是不是Email,也能够经过regexp 和flag 指定自定义的email格式 |
|
@Future | Date、Calendar及全部JSR 310时间类 | 是不是未来时间(如果这种LocalTime.now() 取当前的,都会是false哦~) |
@FutureOrPresent | 同上 | 2.0。和上面的区别是now也行~ |
@Past | 同上 | 不解释 |
@PastOrPresent | 同上 | 2.0。不解释 |
@NotBlank | CharSequence子类型(如String) | 2.0。规则为.trim().length() > 0 (注意:null is not valid ) |
@NotEmpty | CharSequence子类型、Collection、Map、数组 | 2.0。长度/size大小>0(注意:null is not valid ) |
@Size | CharSequence子类型、Collection、Map、数组 | 2.0。min:最小值 max:最大值。(注意:边界值是包含的。null is valid哦~~) |
@NotNull | 全部类型 | 不解释 |
@Null | 全部类型 | 不解释 |
@Pattern | CharSequence子类型(如String) | 是否知足此正则表达式。regexp:正则。flags:模式 |
@Valid |
非原子类型 | 级联属性校验 |
说明:
@DecimalMax
和@Max
的区别:@DecimalMax
支持类型:Number、BidDecimal、Float、Double、BigInteger、Long@Max
支持的类型:同上null is valid
javax.validation.UnexpectedTypeException
:No validator could be found for constraint ‘javax.validation.constraints.Future’ validating type ‘java.lang.String’@FutureOrPresent
和@PastOrPresent
这块注意:对于Present
的匹配,要注意程序是有执行时间的。so若是是匹配时间戳Instant
,如果Instant.now()
的话,@FutureOrPresent
就是非法的,而@PastOrPresent
就成合法的了。可是如果日期的话好比LocalDate.now()
就不会有这问题,毕竟你的程序不可能执行一天嘛~~~~@NotNull
:有的人问用在基本类型(非包装类型报错吗?),很显然不会报错。由于基本类型都有默认值,不可能为null的JSR
的注解都申明都很是的简单,没有Hibernate提供的复杂,好比没有用到@ReportAsSingleViolation
等注解内容~为了方面,下面列出各个注解的默认提示消息(中文):
javax.validation.constraints.AssertFalse.message = 只能为false javax.validation.constraints.AssertTrue.message = 只能为true javax.validation.constraints.DecimalMax.message = 必须小于或等于{value} javax.validation.constraints.DecimalMin.message = 必须大于或等于{value} javax.validation.constraints.Digits.message = 数字的值超出了容许范围(只容许在{integer}位整数和{fraction}位小数范围内) javax.validation.constraints.Email.message = 不是一个合法的电子邮件地址 javax.validation.constraints.Future.message = 须要是一个未来的时间 javax.validation.constraints.FutureOrPresent.message = 须要是一个未来或如今的时间 javax.validation.constraints.Max.message = 最大不能超过{value} javax.validation.constraints.Min.message = 最小不能小于{value} javax.validation.constraints.Negative.message = 必须是负数 javax.validation.constraints.NegativeOrZero.message = 必须是负数或零 javax.validation.constraints.NotBlank.message = 不能为空 javax.validation.constraints.NotEmpty.message = 不能为空 javax.validation.constraints.NotNull.message = 不能为null javax.validation.constraints.Null.message = 必须为null javax.validation.constraints.Past.message = 须要是一个过去的时间 javax.validation.constraints.PastOrPresent.message = 须要是一个过去或如今的时间 javax.validation.constraints.Pattern.message = 须要匹配正则表达式"{regexp}" javax.validation.constraints.Positive.message = 必须是正数 javax.validation.constraints.PositiveOrZero.message = 必须是正数或零 javax.validation.constraints.Size.message = 个数必须在{min}和{max}之间
参考文件ValidationMessages_zh_CN.properties
,若消息不适合你,可自行定制~
约束注解 | 支持的类型 | 说明 |
---|---|---|
@URL | CharSequence | 校验URL。protocol="",host="", port="", regexp=".*", flags={} |
@UniqueElements | Collection | 集合内不容许有重复元素。 |
@SafeHtml | CharSequence | 传入的文本中不能含有script 等敏感标签。(注意:须要org.jsoup 包的支持) |
@Range | 同@Min |
是对@Min 和@Max 的结合补充 |
@Length | CharSequence | value.length() >= min && value.length() <= max (null is valid) |
@ISBN | CharSequence | 校验图书的ISBN。type:Type.ISBN_13 (还有个取值:ISBN_10) |
@EAN | CharSequence | 校验商用条形码EAN |
@Currency | MonetaryAmount | 校验货币。value:只容许的货币种类,如USD, EUR 等 |
@CodePointLength | CharSequence | 校验代码点codePoint 。关于String的length和代码点,可参考这里 通常不使用,使用@Length 便可~ |
@ConstraintComposition | all | 全部约束是AND/OR/ALL_FALSE关系。它只能标注在注解上,运用于组合注解上 |
@DurationMax |
Duration | maxDuration.compareTo( value ) 这么比较的,相等也是valid的 |
@DurationMin |
Duration | `minDuration.compareTo( value )这么比较的,相等也是valid的 |
@CNPJ | CharSequence | 法人国家登记号 |
说明:
@ReportAsSingleViolation
:若是@NotEmpty
、@Pattern
都校验失败,不添加此注解,则会生成两个校验失败的结果。若添加了此注解,那错误消息以它标注的本注解的message
为准null is valid
。各个注解的默认提示消息(中文):
org.hibernate.validator.constraints.CreditCardNumber.message = 不合法的信用卡号码 org.hibernate.validator.constraints.Currency.message = 不合法的货币 (必须是{value}其中之一) org.hibernate.validator.constraints.EAN.message = 不合法的{type}条形码 org.hibernate.validator.constraints.Email.message = 不是一个合法的电子邮件地址 org.hibernate.validator.constraints.Length.message = 长度须要在{min}和{max}之间 org.hibernate.validator.constraints.CodePointLength.message = 长度须要在{min}和{max}之间 org.hibernate.validator.constraints.LuhnCheck.message = ${validatedValue}的校验码不合法, Luhn模10校验和不匹配 org.hibernate.validator.constraints.Mod10Check.message = ${validatedValue}的校验码不合法, 模10校验和不匹配 org.hibernate.validator.constraints.Mod11Check.message = ${validatedValue}的校验码不合法, 模11校验和不匹配 org.hibernate.validator.constraints.ModCheck.message = ${validatedValue}的校验码不合法, ${modType}校验和不匹配 org.hibernate.validator.constraints.NotBlank.message = 不能为空 org.hibernate.validator.constraints.NotEmpty.message = 不能为空 org.hibernate.validator.constraints.ParametersScriptAssert.message = 执行脚本表达式"{script}"没有返回指望结果 org.hibernate.validator.constraints.Range.message = 须要在{min}和{max}之间 org.hibernate.validator.constraints.SafeHtml.message = 可能有不安全的HTML内容 org.hibernate.validator.constraints.ScriptAssert.message = 执行脚本表达式"{script}"没有返回指望结果 org.hibernate.validator.constraints.URL.message = 须要是一个合法的URL
此处用到了
${validatedValue}
、${modType}
是EL表达式的语法。
@DurationMax
和@DurationMin
的message消息此处未贴出,有大量的EL计算,太长了~~~
本文值得说是深刻了解数据校验(Bean Validation)了,对于数据校验的基本使用一直都不是难事,特别是在Spring
环境下使用就更简单了~
深刻了解数据校验:Java Bean Validation 2.0(JSR30三、JSR34九、JSR380)Hibernate-Validation 6.x使用案例【享学Java】
让Controller支持对平铺参数执行数据校验(默认Spring MVC使用@Valid只能对JavaBean进行校验)【享学Spring】
Spring方法级别数据校验:@Validated + MethodValidationPostProcessor优雅的完成数据校验动做【享学Spring】
Bean Validation完结篇:你必须关注的边边角角(约束级联、自定义约束、自定义校验器、国际化失败消息…)【享学Spring】
Author | A哥(YourBatman) |
---|---|
我的站点 | www.yourbatman.cn |
yourbatman@qq.com | |
微 信 | fsx641385712 |
活跃平台 |
|
公众号 | BAT的乌托邦(ID:BAT-utopia) |
知识星球 | BAT的乌托邦 |
每日文章推荐 | 每日文章推荐 |