摘要:如果說要使用數據校驗,我十分相信小伙伴們都能夠使用,但估計大都是有個前提的環境。具體使用可參考小家讓支持對平鋪參數執行數據校驗默認使用只能對進行校驗級聯校驗什么叫級聯校驗,其實就是帶校驗的成員里存在級聯對象時,也要對它完成校驗。
每篇一句
NBA里有兩大笑話:一是科比沒天賦,二是詹姆斯沒技術相關閱讀
【小家Java】深入了解數據校驗:Java Bean Validation 2.0(JSR303、JSR349、JSR380)Hibernate-Validation 6.x使用案例
【小家Spring】讓Controller支持對平鋪參數執行數據校驗(默認Spring MVC使用@Valid只能對JavaBean進行校驗)
【小家Spring】Spring方法級別數據校驗:@Validated + MethodValidationPostProcessor優雅的完成數據校驗動作
關于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> result = validator.validate(person, Person.Simple.class); //Set > 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的引用~BeanConfiguration super T> getBeanConfiguration(Class beanClass); } // 表示源于一個ConfigurationSource的一個Java類型的完整約束相關配置。 包含字段、方法、類級別上的元數據 // 當然還包含有默認組序列上的元數據(使用較少) public class BeanConfiguration { // 三種來源的枚舉 private final ConfigurationSource source; private final Class beanClass; // ConstrainedElement表示待校驗的元素,可以知道它會如下四個子類: // ConstrainedField/ConstrainedType/ConstrainedParameter/ConstrainedExecutable // 注意:ConstrainedExecutable持有的是java.lang.reflect.Executable對象 //它的兩個子類是java.lang.reflect.Method和Constructor private final Set constrainedElements; private final List > 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
如上可知,核心解析邏輯在retrieveBeanConfiguration()這個私有方法上。總結一下調用此方法的兩個原始入口(一個構造器,一個接口方法):
ValidatorFactory.getValidator()獲取校驗器的時候,初始化時會自己new一個,調用棧如下圖:
調用Validator.validate()方法的時候,beanMetaDataManager.getBeanMetaData( rootBeanClass )它會遍歷初始化時所有的metaDataProviders(默認情況下兩個,沒有xml方式的),拿出所有的BeanConfiguration交給BeanMetaDataBuilder,最終構建出一個屬于此Bean的BeanMetaData。對此有一點注意事項描述如下:
1. 處理`MetaDataProvider`時會調用`ClassHierarchyHelper.getHierarchy( beanClass ) `方法,不僅僅處理本類。拿到本類自己和所有父類后,統一交給`provider.getBeanConfiguration( clazz )`處理(**也就是說任何一個類都會把Object類處理一遍**)
這個方法說白了,就是從Bean里面去檢索屬性、方法、構造器等需要校驗的ConstrainedElement項。
privateBeanConfiguration retrieveBeanConfiguration(Class beanClass) { // 它檢索的范圍是:clazz.getDeclaredFields() 什么意思:就是搜集到本類所有的字段 包括private等等 但是不包括父類的所有字段 Set 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 > 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存放起來~~~
1. 注意:此步驟完成了對每個`Field`上標注的注解進行了保存
拿到本類所有的方法Method:clazz.getDeclaredMethods()
排除掉靜態方法和合成(isSynthetic)方法
把每個Method都轉換成一個ConstrainedExecutable裝著~~(ConstrainedExecutable也是個ConstrainedElement)。在此期間它完成了如下事(方法和構造器都復雜點,因為包含入參和返回值):
1. 找到方法上所有的注解保存起來 2. 處理入參、返回值(包括自動判斷是作用在入參還是返回值上)
完全同處理Method,略
找打標注在此類上的所有的注解,轉換成ConstraintDescriptor
對已經找到每個ConstraintDescriptor進行處理,最終都轉換Set
1.
把Set
==關于級聯校驗此處補充說明一點,處理Type,都會處理級聯校驗情況,并且還是遞歸處理:==
也就是這個方法(課件@Valid在此處生效):
// type解釋:分如下N中情況 // Field為:.getGenericType() // 字段的類型 // Method為:.getGenericReturnType() // 返回值類型 // Constructor:.getDeclaringClass() // 構造器所在類 // annotatedElement:可不一定說一定要有注解才能進來(每個字段、方法、構造器等都能傳進來) private CascadingMetaDataBuilder getCascadingMetaData(Type type, AnnotatedElement annotatedElement, Map, 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 { ... protected finalSet > validateSingleConstraint(ValidationContext executionContext, ValueContext, ?> valueContext, ConstraintValidatorContextImpl constraintValidatorContext, ConstraintValidator 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 boolean validationResult = constraintTree.validateConstraints( executionContext, valueContext );
so,最終就調用到了isValid這個真正做事的方法上了。
==說了這么多,你可能還云里霧里,那么就show一把吧:==
Demo Show上面用一個示例校驗Person這個JavaBean了,但是你會發現示例中我們全都是校驗的Field屬性。從理論里我們知道了Bean Validation它是有校驗方法、構造器、入參甚至遞歸校驗級聯屬性的能力的:
校驗屬性Field略
校驗Method入參、返回值 校驗Constructor入參、返回值 既校驗入參,同時也校驗返回值這些是不能直接使用的,需要在運行時進行校驗。具體使用可參考:【小家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> 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這個級聯屬性校驗成功~
總結本文值得說是深入了解數據校驗(Bean Validation)了,對于數據校驗的基本使用一直都不是難事,特別是在Spring環境下使用就更簡單了~
知識交流若文章格式混亂,可點擊:原文鏈接-原文鏈接-原文鏈接-原文鏈接-原文鏈接
==The last:如果覺得本文對你有幫助,不妨點個贊唄。當然分享到你的朋友圈讓更多小伙伴看到也是被作者本人許可的~==
**若對技術內容感興趣可以加入wx群交流:Java高工、架構師3群。
若群二維碼失效,請加wx號:fsx641385712(或者掃描下方wx二維碼)。并且備注:"java入群" 字樣,會手動邀請入群**
文章版權歸作者所有,未經允許請勿轉載,若此文章存在違規行為,您可以聯系管理員刪除。
轉載請注明本文地址:http://specialneedsforspecialkids.com/yun/75698.html
摘要:和上標注的約束都會被執行注意如果子類覆蓋了父類的方法,那么子類和父類的約束都會被校驗。 每篇一句 沒有任何技術方案會是一種銀彈,任何東西都是有利弊的 相關閱讀 【小家Java】深入了解數據校驗:Java Bean Validation 2.0(JSR303、JSR349、JSR380)Hibernate-Validation 6.x使用案例【小家Spring】Spring方法級別數據校...
摘要:畢竟永遠相信本文能給你帶來意想不到的收獲使用示例關于數據校驗這一塊在中的使用案例,我相信但凡有點經驗的程序員應該沒有不會使用的,并且還不乏熟練的選手。 每篇一句 NBA里有兩大笑話:一是科比沒天賦,二是詹姆斯沒技術 相關閱讀 【小家Java】深入了解數據校驗:Java Bean Validation 2.0(JSR303、JSR349、JSR380)Hibernate-Validati...
摘要:添加依賴,如果使用了,則不需要引用任何依賴,因為包中已經包含了依賴在類的屬性上加上對應的注解核查結果中文不能為空檢查結果中文級聯校驗不能超過個嫌疑人集合被注釋的元素必須為被注釋的元素必須不為被注釋的元素必須為被注釋的元素必須為被 1.添加 Hibernate-Validator 依賴,如果使用了springboot,則不需要引用任何依賴,因為spring-boot-starter-we...
摘要:就這樣借助相關約束注解,就非常簡單明了,語義清晰的優雅的完成了方法級別入參校驗返回值校驗的校驗。但倘若是返回值校驗執行了即使是失敗了,方法體也肯定被執行了只能哪些類型上提出這個細節的目的是約束注解并不是能用在所有類型上的。 每篇一句 在《深度工作》中作者提出這么一個公式:高質量產出=時間*專注度。所以高質量的產出不是靠時間熬出來的,而是效率為王 相關閱讀 【小家Java】深入了解數據校...
摘要:和一起使用參照博文從原理層面掌握的使用一起學。至于具體原因,可以移步這里輔助理解從原理層面掌握的使用核心原理篇一起學再看下面的變種例子重要訪問。 每篇一句 每個人都應該想清楚這個問題:你是祖師爺賞飯吃的,還是靠老天爺賞飯吃的 前言 上篇文章 描繪了@ModelAttribute的核心原理,這篇聚焦在場景使用上,演示@ModelAttribute在不同場景下的使用,以及注意事項(當然有些...
閱讀 3694·2021-10-13 09:40
閱讀 3155·2021-10-09 09:53
閱讀 3557·2021-09-26 09:46
閱讀 1852·2021-09-08 09:36
閱讀 4252·2021-09-02 09:46
閱讀 1319·2019-08-30 15:54
閱讀 3181·2019-08-30 15:44
閱讀 1028·2019-08-30 11:06