Spring Validation方法實(shí)現(xiàn)原理分析
最近要做動(dòng)態(tài)數(shù)據(jù)的提交處理,即需要分析提交數(shù)據(jù)字段定義信息后才能明確對(duì)應(yīng)的具體字段類型,進(jìn)而做數(shù)據(jù)類型轉(zhuǎn)換和字段有效性校驗(yàn),然后做業(yè)務(wù)處理后提交數(shù)據(jù)庫(kù),自己開發(fā)一套校驗(yàn)邏輯的話周期太長(zhǎng),因此分析了Spring Validation的實(shí)現(xiàn)原理,復(fù)用了其底層花樣繁多的Validator,在此將分析Spring Validation原理的過(guò)程記錄下,不深入細(xì)節(jié)
如何使用Spring Validation
Spring Bean初始化時(shí)校驗(yàn)Bean是否符合JSR-303規(guī)范
1、手動(dòng)添加BeanValidationPostProcessor Bean
2、在model類中定義校驗(yàn)規(guī)則,如@Max、@Min、@NotEmpty
3、聲明Bean,綜合代碼如下:
@Bean
public BeanPostProcessor beanValidationPostProcessor() {
return new BeanValidationPostProcessor();
}
@Bean
public UserModel getUserModel() {
UserModel userModel = new UserModel();
userModel.setUsername(null);
userModel.setPassword("123");
return userModel;
}
@Data
class UserModel {
@NotNull(message = "username can not be null")
@Pattern(regexp = "[a-zA-Z0-9_]{5,10}", message = "username is illegal")
private String username;
@Size(min = 5, max = 10, message = "password's length is illegal")
private String password;
}
4、BeanValidationPostProcessor Bean內(nèi)部有個(gè)boolean類型的屬性afterInitialization,默認(rèn)是false,如果是false,在postProcessBeforeInitialization過(guò)程中對(duì)bean進(jìn)行驗(yàn)證,否則在postProcessAfterInitialization過(guò)程對(duì)bean進(jìn)行驗(yàn)證
5、此種校驗(yàn)使用了spring的BeanPostProcessor邏輯
6、校驗(yàn)底層調(diào)用了doValidate方法,進(jìn)一步調(diào)用validator.validate,默認(rèn)validator為HibernateValidator,validation-api包為JAVA規(guī)范,Spring默認(rèn)的規(guī)范實(shí)現(xiàn)為hibernate-validator包,此hibernate非ORM框架Hibernate
protected void doValidate(Object bean) {
Assert.state(this.validator != null, "No Validator set");
Set<ConstraintViolation<Object>> result = this.validator.validate(bean);
7、HibernateValidator默認(rèn)調(diào)用ValidatorFactoryImpl來(lái)生成validator,后面展開將ValidatorFactoryImpl
支持方法級(jí)別的JSR-303規(guī)范
1、手動(dòng)添加MethodValidationPostProcessor Bean
2、類上加上@Validated注解(也支持自定義注解,創(chuàng)建MethodValidationPostProcessor Bean時(shí)傳入)
3、在方法的參數(shù)中加上驗(yàn)證注解,比如@Max、@Min、@NotEmpty、@NotNull等,如
@Component
@Validated
public class BeanForMethodValidation {
public void validate(@NotEmpty String name, @Min(10) int age) {
System.out.println("validate, name: " + name + ", age: " + age);
}
}
4、MethodValidationPostProcessor內(nèi)部使用aop完成對(duì)方法的調(diào)用
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());
}
5、底層同樣默認(rèn)調(diào)用ValidatorFactoryImpl來(lái)生成validator,由validator完成校驗(yàn)
直接編碼調(diào)用校驗(yàn)邏輯,如
public class Person {
@NotNull(message = "性別不能為空")
private Gender gender;
@Min(10)
private Integer age;
...
}
ValidatorFactory validatorFactory = Validation.buildDefaultValidatorFactory();
Validator validator = validatorFactory.getValidator();
Person person = new Person();
person.setGender(Gender.Man);
validator.validate(person);
同上,默認(rèn)調(diào)用ValidatorFactoryImpl來(lái)生成validator,由validator完成具體校驗(yàn)
在Spring controller方法參數(shù)中使用valid或validated注解標(biāo)注待校驗(yàn)參數(shù)
1、先熟悉下Spring的請(qǐng)求調(diào)用流程

2、可以看到在各種resolver處理請(qǐng)求參數(shù)的過(guò)程中做了參數(shù)校驗(yàn)
3、底層統(tǒng)一調(diào)用了DataBinder的validate方法
4、DataBinder的作用:Binder that allows for setting property values onto a target object, including support for validation and binding result analysis,也就是binder處理了request提交的字符串形式的參數(shù),將其轉(zhuǎn)換成服務(wù)端真正需要的類型,binder提供了對(duì)validation的支持,可以存放校驗(yàn)結(jié)果
5、DataBinder的validator默認(rèn)在ConfigurableWebBindingInitializer中初始化,默認(rèn)使用OptionalValidatorFactoryBean,該Bean繼承了LocalValidatorFactoryBean,LocalValidatorFactoryBean組合了ValidatorFactory、自定義校驗(yàn)屬性等各種校驗(yàn)會(huì)用到的信息,默認(rèn)使用ValidatorFactoryImpl來(lái)獲取validator
至此,所有的線索都指向了ValidatorFactoryImpl,下面分析下該類
public Validator `getValidator`() {
return `createValidator`(
constraintValidatorManager.getDefaultConstraintValidatorFactory(),
valueExtractorManager,
validatorFactoryScopedContext,
methodValidationConfiguration
);
}
Validator `createValidator`(ConstraintValidatorFactory constraintValidatorFactory,
ValueExtractorManager valueExtractorManager,
ValidatorFactoryScopedContext validatorFactoryScopedContext,
MethodValidationConfiguration methodValidationConfiguration) {
BeanMetaDataManager beanMetaDataManager = beanMetaDataManagers.computeIfAbsent(
new BeanMetaDataManagerKey( validatorFactoryScopedContext.getParameterNameProvider(), valueExtractorManager, methodValidationConfiguration ),
key -> new BeanMetaDataManager(
`constraintHelper`,
executableHelper,
typeResolutionHelper,
validatorFactoryScopedContext.getParameterNameProvider(),
valueExtractorManager,
validationOrderGenerator,
buildDataProviders(),
methodValidationConfiguration
)
);
return `new ValidatorImpl`(
constraintValidatorFactory,
beanMetaDataManager,
valueExtractorManager,
constraintValidatorManager,
validationOrderGenerator,
validatorFactoryScopedContext
);
}
public final <T> Set<ConstraintViolation<T>> validate(T object, Class<?>... groups) {
Contracts.assertNotNull( object, MESSAGES.validatedObjectMustNotBeNull() );
sanityCheckGroups( groups );
ValidationContext<T> validationContext = `getValidationContextBuilder().forValidate( object )`;
if ( !validationContext.getRootBeanMetaData().hasConstraints() ) {
return Collections.emptySet();
}
ValidationOrder validationOrder = determineGroupValidationOrder( groups );
ValueContext<?, Object> valueContext = `ValueContext.getLocalExecutionContext`(
validatorScopedContext.getParameterNameProvider(),
object,
validationContext.getRootBeanMetaData(),
PathImpl.createRootPath()
);
return validateInContext( validationContext, valueContext, validationOrder );
}
1、getValidator->createValidator->ValidatorImpl->validate
在執(zhí)行過(guò)程中封裝了beanMetaDataManager、validationContext、valueContext等內(nèi)容,都是校驗(yàn)時(shí)會(huì)用到的上下文信息,如待校驗(yàn)bean的所有校驗(yàn)項(xiàng)(含父類和接口)、property、method parameter的校驗(yàn)信息,從ValidatorFactoryScopedContext繼承過(guò)來(lái)的validator通用的各種工具類(如message、script等的處理)等,內(nèi)容比較復(fù)雜
2、分組(group)校驗(yàn)忽略,來(lái)到默認(rèn)分組處理validateConstraintsForDefaultGroup->validateConstraintsForSingleDefaultGroupElement->validateMetaConstraint(注:metaConstraints維護(hù)了該bean類型及其父類、接口的所有校驗(yàn),需要遍歷調(diào)用validateMetaConstraint)
3、繼續(xù)調(diào)用MetaConstraint的doValidateConstraint方法,根據(jù)不同的annotation type走不同的ConstraintTree
public static <U extends Annotation> ConstraintTree<U> of(ConstraintDescriptorImpl<U> composingDescriptor, Type validatedValueType) {
if ( composingDescriptor.getComposingConstraintImpls().isEmpty() ) {
return new SimpleConstraintTree<>( composingDescriptor, validatedValueType );
}
else {
return new ComposingConstraintTree<>( composingDescriptor, validatedValueType );
}
}
4、具體哪些走simple,哪些走composing暫且不管,因?yàn)槎叨颊{(diào)用了ConstraintTree的'getInitializedConstraintValidator'方法,該步用來(lái)獲取校驗(yàn)annotation(如DecimalMax、NotEmpty等)對(duì)應(yīng)的validator并初始化validator
5、 ConstraintHelper 類維護(hù)了所有builtin的validator,并根據(jù)校驗(yàn)annotation(如DecimalMax)分類,validator的描述類中維護(hù)了該validator的泛型模板(如BigDecimal),如下:
putConstraints( tmpConstraints, DecimalMax.class, Arrays.asList( DecimalMaxValidatorForBigDecimal.class, DecimalMaxValidatorForBigInteger.class, DecimalMaxValidatorForDouble.class, DecimalMaxValidatorForFloat.class, DecimalMaxValidatorForLong.class, DecimalMaxValidatorForNumber.class, DecimalMaxValidatorForCharSequence.class, DecimalMaxValidatorForMonetaryAmount.class ) );
在獲取具體bean類的validator時(shí),先根據(jù)annotation獲取所有的validator,對(duì)應(yīng)方法是ConstraintManager.findMatchingValidatorDescriptor,然后根據(jù)被校驗(yàn)對(duì)象的類型獲取唯一的validator
6、然后根據(jù)上下文信息initializeValidator,進(jìn)而調(diào)用validator的isValid方法校驗(yàn)
以上就是本文的全部?jī)?nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。
- SpringMVC實(shí)現(xiàn)Validation校驗(yàn)過(guò)程詳解
- spring boot validation參數(shù)校驗(yàn)實(shí)例分析
- springboot+dubbo+validation 進(jìn)行rpc參數(shù)校驗(yàn)的實(shí)現(xiàn)方法
- Spring自帶的校驗(yàn)框架Validation的使用實(shí)例
- 詳解使用spring validation完成數(shù)據(jù)后端校驗(yàn)
- springMVC引入Validation的具體步驟詳解
- springboot使用校驗(yàn)框架validation校驗(yàn)的示例
- Springboot項(xiàng)目javax.validation使用方法詳解
相關(guān)文章
java讀取resources文件詳解及實(shí)現(xiàn)代碼
這篇文章主要介紹了java讀取resources文件詳解及實(shí)現(xiàn)代碼的相關(guān)資料,在開發(fā)項(xiàng)目的時(shí)候經(jīng)常會(huì)遇到讀取文件夾里面的內(nèi)容,需要的朋友可以參考下2017-07-07
SpringBoot AOP AspectJ切面技術(shù)介紹與實(shí)現(xiàn)方式
這篇文章主要介紹了Springboot如何使用Aspectj實(shí)現(xiàn)AOP面向切面編程,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2022-10-10
Java中的遞歸詳解(用遞歸實(shí)現(xiàn)99乘法表來(lái)講解)
這篇文章主要介紹了Java中的遞歸詳解(用遞歸實(shí)現(xiàn)99乘法表來(lái)講解),本文給出了普通的99乘法實(shí)現(xiàn)方法和用遞歸實(shí)現(xiàn)的方法,并對(duì)比它們的不同,體現(xiàn)出遞歸的運(yùn)用及理解,需要的朋友可以參考下2015-03-03
Struts2實(shí)現(xiàn)對(duì)action請(qǐng)求對(duì)象的攔截操作方法
這篇文章主要介紹了Struts2實(shí)現(xiàn)對(duì)action請(qǐng)求對(duì)象的攔截操作方法,非常不錯(cuò),具有參考借鑒價(jià)值,需要的朋友可以參考下2017-11-11
Mybatis-Plus可能導(dǎo)致死鎖的問(wèn)題分析及解決辦法
這篇文章給大家主要介紹了Mybatis-Plus可能導(dǎo)致死鎖的問(wèn)題分析及解決辦法,文中通過(guò)代碼示例給大家介紹的非常詳細(xì),具有一定的參考價(jià)值,需要的朋友可以參考下2023-12-12
java實(shí)現(xiàn)ssh登錄linux并執(zhí)行命令的三種實(shí)現(xiàn)方式
文章介紹了三種在Java中實(shí)現(xiàn)SSH登錄Linux并執(zhí)行命令的方法,包括使用ganymed-ssh2、jsch和sshd-core,由于ganymed-ssh2和jsch的最新版本較舊,可能無(wú)法與較新的Linux系統(tǒng)兼容,而sshd-core一直在更新,推薦使用2024-11-11
java設(shè)計(jì)模式之工廠模式實(shí)例詳解
這篇文章主要介紹了java設(shè)計(jì)模式之工廠模式,結(jié)合具有實(shí)例形式分析了java工廠模式的概念、原理、實(shí)現(xiàn)與使用方法,需要的朋友可以參考下2017-09-09
使用@Value為靜態(tài)變量導(dǎo)入并使用導(dǎo)入的靜態(tài)變量進(jìn)行初始化方式
這篇文章主要介紹了使用@Value為靜態(tài)變量導(dǎo)入并使用導(dǎo)入的靜態(tài)變量進(jìn)行初始化方式,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2023-02-02

