标签分类
技术文章
当前位置:主页 > 计算机编程 > java > Spring Validation方法实现原理分析

Spring Validation方法实现原理知识点总结

  • 发布时间:
  • 作者:码农之家原创
  • 点击:144

Spring Validation方法实现原理分析

这篇文章主要知识点是关于Spring,Validation实现,Spring,Validation,Spring Validation方法实现原理分析,springboot使用校验框架validation校验的示例 的内容,如果大家想对相关知识点有系统深入的学习,可以参阅以下电子书

Spring源码深度解析
  • 类型:java大小:53 MB格式:PDF出版:人民邮电出版社作者:郝佳
立即下载

最近要做动态数据的提交处理,即需要分析提交数据字段定义信息后才能明确对应的具体字段类型,进而做数据类型转换和字段有效性校验,然后做业务处理后提交数据库,自己开发一套校验逻辑的话周期太长,因此分析了Spring Validation的实现原理,复用了其底层花样繁多的Validator,在此将分析Spring Validation原理的过程记录下,不深入细节

如何使用Spring Validation

Spring Bean初始化时校验Bean是否符合JSR-303规范

1、手动添加BeanValidationPostProcessor Bean

2、在model类中定义校验规则,如@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内部有个boolean类型的属性afterInitialization,默认是false,如果是false,在postProcessBeforeInitialization过程中对bean进行验证,否则在postProcessAfterInitialization过程对bean进行验证

5、此种校验使用了spring的BeanPostProcessor逻辑

6、校验底层调用了doValidate方法,进一步调用validator.validate,默认validator为HibernateValidator,validation-api包为JAVA规范,Spring默认的规范实现为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默认调用ValidatorFactoryImpl来生成validator,后面展开将ValidatorFactoryImpl

支持方法级别的JSR-303规范

1、手动添加MethodValidationPostProcessor Bean

2、类上加上@Validated注解(也支持自定义注解,创建MethodValidationPostProcessor Bean时传入)

3、在方法的参数中加上验证注解,比如@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内部使用aop完成对方法的调用

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、底层同样默认调用ValidatorFactoryImpl来生成validator,由validator完成校验

直接编码调用校验逻辑,如

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);

同上,默认调用ValidatorFactoryImpl来生成validator,由validator完成具体校验

在Spring controller方法参数中使用valid或validated注解标注待校验参数

1、先熟悉下Spring的请求调用流程

Spring Validation方法实现原理分析

2、可以看到在各种resolver处理请求参数的过程中做了参数校验

3、底层统一调用了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提交的字符串形式的参数,将其转换成服务端真正需要的类型,binder提供了对validation的支持,可以存放校验结果

5、DataBinder的validator默认在ConfigurableWebBindingInitializer中初始化,默认使用OptionalValidatorFactoryBean,该Bean继承了LocalValidatorFactoryBean,LocalValidatorFactoryBean组合了ValidatorFactory、自定义校验属性等各种校验会用到的信息,默认使用ValidatorFactoryImpl来获取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

在执行过程中封装了beanMetaDataManager、validationContext、valueContext等内容,都是校验时会用到的上下文信息,如待校验bean的所有校验项(含父类和接口)、property、method parameter的校验信息,从ValidatorFactoryScopedContext继承过来的validator通用的各种工具类(如message、script等的处理)等,内容比较复杂

2、分组(group)校验忽略,来到默认分组处理validateConstraintsForDefaultGroup->validateConstraintsForSingleDefaultGroupElement->validateMetaConstraint(注:metaConstraints维护了该bean类型及其父类、接口的所有校验,需要遍历调用validateMetaConstraint)

3、继续调用MetaConstraint的doValidateConstraint方法,根据不同的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暂且不管,因为二者都调用了ConstraintTree的'getInitializedConstraintValidator'方法,该步用来获取校验annotation(如DecimalMax、NotEmpty等)对应的validator并初始化validator

5、 ConstraintHelper 类维护了所有builtin的validator,并根据校验annotation(如DecimalMax)分类,validator的描述类中维护了该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时,先根据annotation获取所有的validator,对应方法是ConstraintManager.findMatchingValidatorDescriptor,然后根据被校验对象的类型获取唯一的validator

6、然后根据上下文信息initializeValidator,进而调用validator的isValid方法校验

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持码农之家。

springboot使用校验框架validation校验的示例

b/s系统中对http请求数据的校验多数在客户端进行,这也是出于简单及用户体验性上考虑,但是在一些安全性要求高的系统中服务端校验是不可缺少的。

Spring3支持JSR-303验证框架,JSR-303 是Java EE 6 中的一项子规范,叫做BeanValidation,官方参考实现是hibernate Validator(与Hibernate ORM 没有关系),JSR 303 用于对Java Bean 中的字段的值进行验证。

Validator主要是校验用户提交的数据的合理性的,比如是否为空了,密码长度是否大于6位,是否是纯数字的,等等。那么在spring boot怎么使用这么强大的校验框架呢。

validation与 springboot 结合

1. bean 中添加标签

部分代码:

标签需要加在属性上,@NotBlank 标签含义文章末尾有解释

public class User {
  private Integer id;
  @NotBlank(message = "{user.name.notBlank}")
  private String name;
  private String username;

2. Controller中开启验证

在Controller 中 请求参数上添加@Validated 标签开启验证

  @RequestMapping(method = RequestMethod.POST)
  public User create(@RequestBody @Validated User user) {
    return userService.create(user);
  }

3. resource 下新建错误信息配置文件

在resource 目录下新建提示信息配置文件“ValidationMessages.properties“

注意:名字必须为“ValidationMessages.properties“ 因为SpringBoot自动读取classpath中的ValidationMessages.properties里的错误信息

ValidationMessages.properties 文件的编码为ASCII。数据类型为 key value 。key“user.name.notBlank“为第一步 bean的标签 大括号里面对应message的值

value 为提示信息 ,但是是ASCII 。(内容为“名字不能为空“)

springboot使用校验框架validation校验的示例

4. 自定义异常处理器,捕获错误信息

当验证不通过时会抛异常出来,异常的message 就是 ValidationMessages.properties 中配置的提示信息。此处定义异常处理器。捕获异常信息(因为验证不通过的项可能是多个所以统一捕获处理),并抛给前端。(此处是前后端分离开发)

  public void MethodArgumentNotValidException(Exception ex, HttpServletRequest request, HttpServletResponse response) {
    logger.error( ":" + CommonUtil.getHttpClientInfo(request), ex);
    MethodArgumentNotValidException c = (MethodArgumentNotValidException) ex;
    List<ObjectError> errors =c.getBindingResult().getAllErrors();
    StringBuffer errorMsg=new StringBuffer();
    errors.stream().forEach(x -> errorMsg.append(x.getDefaultMessage()).append(";"));
    pouplateExceptionResponse(response, HttpStatus.INTERNAL_SERVER_ERROR, errorMsg.toString());
  }


 private void pouplateExceptionResponse(HttpServletResponse response, HttpStatus errorCode, String errorMessage) {
    try {
      response.sendError(errorCode.value(), errorMessage);
    } catch (IOException e) {
      logger.error("failed to populate response error", e);
    }
  }

5. 附上部分标签含义

限制 说明
@Null 限制只能为null
@NotNull 限制必须不为null
@AssertFalse 限制必须为false
@AssertTrue 限制必须为true
@DecimalMax(value) 限制必须为一个不大于指定值的数字
@DecimalMin(value) 限制必须为一个不小于指定值的数字
@Digits(integer,fraction) 限制必须为一个小数,且整数部分的位数不能超过integer,小数部分的位数不能超过fraction
@Future 限制必须是一个将来的日期
@Max(value) 限制必须为一个不大于指定值的数字
@Min(value) 限制必须为一个不小于指定值的数字
@Past 限制必须是一个过去的日期
@Pattern(value) 限制必须符合指定的正则表达式
@Size(max,min) 限制字符长度必须在min到max之间
@Past 验证注解的元素值(日期类型)比当前时间早
@NotEmpty 验证注解的元素值不为null且不为空(字符串长度不为0、集合大小不为0)
@NotBlank 验证注解的元素值不为空(不为null、去除首位空格后长度为0),不同于@NotEmpty,@NotBlank只应用于字符串且在比较时会去除字符串的空格
@Email 验证注解的元素值是Email,也可以通过正则表达式和flag指定自定义的email格式

示例

 @Pattern(regexp="^[a-zA-Z0-9]+$",message="{account.username.space}")
 @Size(min=3,max=20,message="{account.username.size}")

示例2

在这里我们主要是使用注解进行学习。我们先说说我们的需求:

我们有一个demo.html,在页面上有两个元素 姓名输入框,密码输入库,提交按钮。

提交到后台之后,使用Validator进行校验,然后如果存在错误,转发到demo.html,

我们先编写一个实体类接收用户的输入,以及使用Validator注解校验:

package com.kfit.demo;
 
import org.hibernate.validator.constraints.Length;
import org.hibernate.validator.constraints.NotEmpty; 
public class Demo {  
  private long id; 
  @NotEmpty(message="姓名不能为空")
  private String name;  
  @NotEmpty(message="密码不能为空")
  @Length(min=6,message="密码长度不能小于6位")
  private String password;
 
  publiclong getId() {
    return id;
  }
 
  publicvoid setId(longid) {
    this.id = id;
  }
 
  public String getName() {
    return name;
  }
 
  public void setName(String name) {
    this.name = name;
  }
 
  public String getPassword() {
    return password;
  }
 
  public void setPassword(String password) {
    this.password = password;
  }
 
  @Override
  public String toString() {
    return "Demo [id=" + id + ", name=" + name + ", password=" + password + "]";
  }
}

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持码农之家。

以上就是本次给大家分享的全部知识点内容总结,大家还可以在下方相关文章里找到解决axios.interceptors.respon、 儿童python编程入门书籍推、 vue项目中使用md5加密以及、 等java文章进一步学习,感谢大家的阅读和支持。

上一篇:spring security安全防护知识点详解

下一篇:DispatcherServlet配置的实例方法详解

展开 +

收起 -

学习笔记
网友NO.300006

springboot使用校验框架validation校验的示例

b/s系统中对http请求数据的校验多数在客户端进行,这也是出于简单及用户体验性上考虑,但是在一些安全性要求高的系统中服务端校验是不可缺少的。 Spring3支持JSR-303验证框架,JSR-303 是Java EE 6 中的一项子规范,叫做BeanValidation,官方参考实现是hibernate Validator(与Hibernate ORM 没有关系),JSR 303 用于对Java Bean 中的字段的值进行验证。 Validator主要是校验用户提交的数据的合理性的,比如是否为空了,密码长度是否大于6位,是否是纯数字的,等等。那么在spring boot怎么使用这么强大的校验框架呢。 validation与 springboot 结合 1. bean 中添加标签 部分代码: 标签需要加在属性上,@NotBlank 标签含义文章末尾有解释 public class User { private Integer id; @NotBlank(message = "{user.name.notBlank}") private String name; private String username; 2. Controller中开启验证 在Controller 中 请求参数上添加@Validated 标签开启验证 @RequestMapping(method = RequestMethod.POST) public User create(@RequestBody @Validated User user) { return userService.create(user); } 3. resource 下新建错误信息配置文件 在resource 目录下新建提示信息配置文件“ValidationMessages.properties“ 注意:名字必须为“ValidationMessages.properties“ 因为SpringBoot自动读取classpath中的ValidationMessages.properties里的错误信息 ValidationMessages.properties 文件的编码为……

网友NO.735641

详解使用spring validation完成数据后端校验

前言 数据的校验是交互式网站一个不可或缺的功能,前端的js校验可以涵盖大部分的校验职责,如用户名唯一性,生日格式,邮箱格式校验等等常用的校验。但是为了避免用户绕过浏览器,使用http工具直接向后端请求一些违法数据,服务端的数据校验也是必要的,可以防止脏数据落到数据库中,如果数据库中出现一个非法的邮箱格式,也会让运维人员头疼不已。我在之前保险产品研发过程中,系统对数据校验要求比较严格且追求可变性及效率,曾使用drools作为规则引擎,兼任了校验的功能。而在一般的应用,可以使用本文将要介绍的validation来对数据进行校验。 简述JSR303/JSR-349,hibernate validation,spring validation之间的关系。JSR303是一项标准,JSR-349是其的升级版本,添加了一些新特性,他们规定一些校验规范即校验注解,如@Null,@NotNull,@Pattern,他们位于javax.validation.constraints包下,只提供规范不提供实现。而hibernate validation是对这个规范的实践(不要将hibernate和数据库orm框架联系在一起),他提供了相应的实现,并增加了一些其他校验注解,如@Email,@Length,@Range等等,他们位于org.hibernate.validator.constraints包下。而万能的spring为了给开发者提供便捷,对hibernate validation进行了二次封装,显示校验validated bean时,你可以使用spring……

网友NO.722705

springMVC引入Validation的具体步骤详解

本文简单介绍如何引入validation的步骤,如何通过自定义validation减少代码量,提高生产力。特别提及:非基本类型属性的valid,GET方法的处理,validation错误信息的统一resolve。 本文中validation的实际实现委托给Hibernate validation处理 基本配置 pom引入maven依赖 !-- validation begin --dependency groupIdjavax.validation/groupId artifactIdvalidation-api/artifactId version1.1.0.Final/version/dependencydependency groupIdorg.hibernate/groupId artifactIdhibernate-validator/artifactId version5.4.0.Final/version/dependency!-- validation end -- 增加validation配置 在spring-mvc-servlet.xml中增加如下配置: mvc:annotation-driven validator="validator"bean id="validator" class="org.springframework.validation.beanvalidation.LocalValidatorFactoryBean" property name="providerClass" value="org.hibernate.validator.HibernateValidator" / property name="validationMessageSource" ref="messageSource"//bean//messageSource 为i18n资源管理bean,见applicationContext.xml配置 自定义exceptionHandler 个性化处理validation错误信息,返回给调用方的信息更加友好, 在applicationContext.xml中增加如下配置: !-- 加载i18n消息资源文件 --bean id="messageSource" class="org.springframework.context.support.ResourceBundleMessageSource" property name="basenames" list valueerrormsg/value valuevalidation_error/value /list /property/beanbean id="validationExceptionResolver" class="com.*.exception.Valida……

<
1
>

Copyright 2018-2019 xz577.com 码农之家

版权责任说明