@Valid 注解解释了 Java Bean 验证的过去和现在。
Spring @Valid 注解 校验实体属性
- 1 @Valid 介绍
- 1.1 前言
- 1.2 Bean Validation
- 1.3 关于validation包
- 1.3 关于Spring Hibernate Validator支持的约束集信息(constraints)
- 2 简单的使用
- 2.1配置项
- 2.1.1 maven -- jar包引入
- 2.1.2 SpringMVC配置
- 2.2 实现方式
- 2.2.1 @Valid + BindingResult + javax.validation.constraints.*
- 2.2.2 validator.validate()
- 2.2.3 代码示例
- 2.2.4 对比不同实现的一些总结。
- 3 补充 @Validated 注解 + javax.validation.constraints.*
1 @Valid 介绍
1.1 前言
在我们日常开发中,数据校验的实现是一件比较痛苦的事情,繁琐且无趣,对于一般的业务而言,极少出现一些过于复杂的校验,常常都是非空,长度,最大最小值,正则,数据关联,定值等等。我在开发过程中为了减少我写这些代码的coding成本,由此认识了javax.validation包下的 @Valid 注解 和 Java 的 Bean Validation 规范。
1.2 Bean Validation
首先了解下JSR(Java Specification Requests)
JSR:Java Specification Requests的缩写,意思是Java 规范提案。是指向JCP(Java Community Process)提出新增一个标准化技术规范的正式请求。任何人都可以提交JSR,以向Java平台增添新的API和服务。JSR已成为Java界的一个重要标准。
Bean Validation 是一个运行时的数据验证框架,在验证之后验证的错误信息会被马上返回。
Java 在2009年的 JAVAEE 6 中发布了 JSR303以及javax下的validation包内容。
这项工作的主要目标是为java应用程序开发人员提供 基于java对象的 约束(constraints)声明 和 对约束的验证工具(validator),以及约束元数据存储库和查询API。
但是该内容并没有具体的实现, Hibernate-Validator框架 提供了 JSR 303 规范中所有内置 constraint 的实现,除此之外还有一些附加的 constraint。
注意:此处的Hibernate 不是 Hibernate ORM
后续关于Bean Validation 的规范提案 和 各个版本的实现 陆续得以迭代,各个版本的信息如下:
Bean Validation Version | release year | JSR Version | Hibernate impl version | apache BVal impl version |
---|---|---|---|---|
Bean Validation 1.0 | 2009年 | JSR 303 | Hibernate-Validator-4.3.1.Final | org.apache.bval 0.5 |
Bean Validation 1.1 | 2013年 | JSR 349 | Hibernate-Validator-5.1.1.Final | org.apache.bval 1.1.2 |
Bean Validation 2.0 | 2017年 | JSR 380 | Hibernate-Validator-6.0.1.Final | org.apache.bval 2.0.3(最新版本) |
本文主要基于 Hibernate-Validator 框架的实现为主。
1.3 关于validation包
Java-Api文档
其中 javax.validation.constraints包下是 bean validation 支持的约束,以注解的形式使用。
1.3 关于Spring Hibernate Validator支持的约束集信息(constraints)
截取自 IBM JSR 303
表 1. Bean Validation 中内置的 constraint
表 2. Hibernate Validator 附加的 constraint
2 简单的使用
2.1配置项
2.1.1 maven – jar包引入
如果使用springMVC ,需要在 pom文件中引入对应的jar包。
<!-- hibernate.validator jar包-->
<dependency>
<groupId>org.hibernate.validator</groupId>
<artifactId>hibernate-validator</artifactId>
<version>6.0.17.Final</version>
</dependency>
这里不需要引入 javax.validation包,hibernate-validator框架中已经有引入了。
如果使用springboot,笔者使用的 2.1.7.RELEASE 版本,其中 spring-boot-starter-web 包中已经引入了 hibernate-validator 6.0.17.RELEASE了,不需要我们手动添加。
如果使用的非maven项目,需要下载对应的jar引入到项目中。
2.1.2 SpringMVC配置
<!--配置中需要注意的地方:
LocalValidatorFactoryBean :
validationMessageSource通过set方法注入,然后转换为MessageInterpolator对象,如果不配置validationMessageSource信息源,那么会使用默认的信息源HibernateValidations_xx_xx.properties,位于org.hibernate.validator包下,具体使用哪个文件由Locale.getDefaultLocale()决定。-->
<bean id="validator" class="org.springframework.validation.beanvalidation.LocalValidatorFactoryBean">
<property name="providerClass" value="org.hibernate.validator.HibernateValidator" />
<property name="validationMessageSource" ref="hibernate_validator_messages"/>
</bean>
2.2 实现方式
这部分介绍关心实现的小伙伴也可以略过,直接看实现。
2.2.1 @Valid + BindingResult + javax.validation.constraints.*
BindingResult 是 spring 对于 Hibernate-Validator的进一步封装,主要处理 约束违反信息 的处理。也就是当 判断 校验不通过时 所获取的 默认的或者自定义的 错误信息。
使用 @Valid 结合 BindingResult实例,Spring将对被注解的实体进行约束校验,原理是AOP。
2.2.2 validator.validate()
springboot 自动将 ValidatorFactory 加载到了IOC容器中,不需要进行配置(注意:SpringMVC 需要进行配置)。我们可以使用自动注入的方式获取 ValidatorFactory接口的实现的实例,进而获取 Validator接口的实现的实例,调用.validate(T var1, Class<?>… var2)方法对 java bean 进行约束检验。基于此,还可以用作AOP切面的开发。
validator接口源码
package javax.validation;
import java.util.Set;
import javax.validation.executable.ExecutableValidator;
import javax.validation.metadata.BeanDescriptor;
public interface Validator {
<T> Set<ConstraintViolation<T>> validate(T var1, Class<?>... var2);
<T> Set<ConstraintViolation<T>> validateProperty(T var1, String var2, Class<?>... var3);
<T> Set<ConstraintViolation<T>> validateValue(Class<T> var1, String var2, Object var3, Class<?>... var4);
BeanDescriptor getConstraintsForClass(Class<?> var1);
<T> T unwrap(Class<T> var1);
ExecutableValidator forExecutables();
}
ValidatorFactory 工厂接口源码
package javax.validation;
public interface ValidatorFactory extends AutoCloseable {
Validator getValidator();
ValidatorContext usingContext();
MessageInterpolator getMessageInterpolator();
TraversableResolver getTraversableResolver();
ConstraintValidatorFactory getConstraintValidatorFactory();
ParameterNameProvider getParameterNameProvider();
ClockProvider getClockProvider();
<T> T unwrap(Class<T> var1);
void close();
}
2.2.3 代码示例
下面我们用一个简单的示例来完成上诉提到的两种实现。
首先我们创建一个 简单的 po 类,也就是我们的业务实体类。
假设一个后台管理系统的职员信息管理模块,需要新增员工信息。
新建一个Employee类 用于 封装 职员的基础信息
package com.onesport.kern.beanValidationTest.dao;
//看包名就知道这个是hibernate附加的constraints
import org.hibernate.validator.constraints.Length;
//javax.validation.constraints包下所支持的一些约束类型
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Past;
import javax.validation.constraints.Pattern;
import java.util.Date;
/**
* @author Kern
* @Title: Employee
* @ProjectName kern-demo
* @Description: TODO
* @date 2019/9/1718:53
*/
public class Employee {
@NotNull(message = "姓名必填!")
@Length(max = 20, message = "姓名过长!")
private String name;
@NotNull(message = "工牌必填!")
@Pattern(regexp = "^[0-9]\\d{10}",message = "请输入10位数字工牌!")//长度10,0-9
private String badgeCode;
@Pattern(regexp = "^[1-2]",message = "性别参数错误!")
@NotNull(message = "性别必填!")
private String gender;
@Past(message = "无效的出生日期!")
private Date birthDate;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getBadgeCode() {
return badgeCode;
}
public void setBadgeCode(String badgeCode) {
this.badgeCode = badgeCode;
}
public String getGender() {
return gender;
}
public void setGender(String gender) {
this.gender = gender;
}
public Date getBirthDate() {
return birthDate;
}
public void setBirthDate(Date birthDate) {
this.birthDate = birthDate;
}
@Override
public String toString() {
return "Employee{" +
"name='" + name + '\'' +
", badgeCode='" + badgeCode + '\'' +
", gender=" + gender +
", birthDate=" + birthDate +
'}';
}
}
无论是@Valid注解 + BindingResult 这种形式 或者是 直接调用Validator.validate() 方法,我们都可以直接使用这个 po 对象。
接下来我们简便点来,直接写出来两种实现方式的controller层方法。这里忽略了service层,如有其他的业务可以在service层写。代码如下:
package com.onesport.kern.beanValidationTest.control;
import com.onesport.kern.beanValidationTest.dao.Employee;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.validation.BindingResult;
import org.springframework.validation.FieldError;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import javax.validation.*;
import java.util.List;
import java.util.Set;
/**
* @author Kern
* @Title: EmployeeControl
* @ProjectName kern-demo
* @Description: TODO
* @date 2019/9/1722:26
*/
@RequestMapping(path = "/employee")
@RestController
public class EmployeeControl {
//换行符
private static String lineSeparator = System.lineSeparator();
/**
* 注解实现
* 使用@Valid 注解 实体, 并传入参数bindResult以获取校验结果信息
* @param employee
* @param bindingResult
* @return
*/
@PostMapping("/bindingResult")
public Object addEmployee(@RequestBody @Valid Employee employee, BindingResult bindingResult){
if (bindingResult.hasErrors()){
//校验结果以集合的形式返回,当然也可以获取单个。具体可以查看bindResult的API文档
List<FieldError> fieldErrorList = bindingResult.getFieldErrors();
//StringBuilder组装异常信息
StringBuilder builder = new StringBuilder();
//遍历拼装
fieldErrorList.forEach(error -> {
builder.append(error.getDefaultMessage() + lineSeparator);
});
builder.insert(0,"use @Valid n BingdingResult :" +lineSeparator);
return builder.toString();
}
//TODO there can invoke service layer method to do someting
return "添加职员信息成功:" + employee.toString();
}
//Spring boot 已帮我们把 validation 的关键对象的实例装载如 IOC 容器中
@Autowired
private ValidatorFactory autowiredValidatorFactory;
@Autowired
private Validator autowiredValidator;
/**
* 调用validator实现
* @param employee
* @return
*/
@PostMapping("/validator")
public Object addEmployee(@RequestBody Employee employee){
System.out.println("这里将导入 由 Springboot 的 IOC 容器中获取的 校验器工厂和 校验器类");
System.out.println("validator工厂类:"+ autowiredValidatorFactory.toString());
System.out.println("validator类:"+ autowiredValidator.toString());
/**
* 下述的工厂类和校验器类也可以使用上述由IOC容器中获取的对象实例代替
*/
//实例化一个 validator工厂
ValidatorFactory validatorFactory = Validation.buildDefaultValidatorFactory();
//获取validator实例
Validator validator = validatorFactory.getValidator();
//调用调用,得到校验结果信息 Set
Set<ConstraintViolation<Employee>> constraintViolationSet = validator.validate(employee);
//StringBuilder组装异常信息
StringBuilder builder = new StringBuilder();
//遍历拼装
constraintViolationSet.forEach(violationInfo -> {
builder.append(violationInfo.getMessage() + lineSeparator);
});
if (builder.toString().length() > 0){
builder.insert(0,"use validator :" +lineSeparator);
return builder.toString();
}
//TODO there can invoke service layer method to do someting
return "添加职员信息成功:" + employee.toString();
}
}
上下两个方法,分别对应两种实现。我们测试一下结果。这里直接使用yapi接口管理工具来测试了。
首先调用一下第一个实现 @Valid + BingdingResult:
参数:
结果:
再调用一下第二个实现 直接调用 validator
参数: 这次我们只把姓名和工牌写错
结果:
控制台console:
返回信息:
2.2.4 对比不同实现的一些总结。
我们回过头来看一下上述两种实现,第一种实现 BindingResult是 Spring 提供的再封装工具,底层是调用 spring aop ,在我们业务开发中实现也相对简单,method body 也可以很方便的进行封装成一个通用的工具方法供调用,以免重复写这些代码。但是总是要带这个bindResult 参数还是比较烦。
而第二种实现方法就相对较为灵活,同样也是可编程的,在对一些Excel批量导入的数据校验等等的场景会较为灵活。
3 补充 @Validated 注解 + javax.validation.constraints.*
这部分一直没有补充,趁五一前补充一下,源码看了个大概,没有细研究,但大体上应该没错。
自spring 3.1 版本起提供了 @Validated 注解用于方法参数的表单校验, 同样也是基于 JSR-303 标准,是spring mvc对表单校验支撑框架的进一步封装。
前景提要,需要依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-validation</artifactId>
<version>你的springboot版本</version>
</dependency>
下面的介绍内容建议结合源码一起看。
@Target({ElementType.TYPE, ElementType.METHOD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Validated {
/**
指定验证组, 可以看下 javax.validation.groups.Default 接口, 就是校验的时候注解指定组,然后两两对应,
支持继承关系
*/
Class<?>[] value() default {};
}
这个注解可以注释到类,方法,参数上,意思也很简单,如果注解到类上,则类的所有方法的所有参数都进行表单校验,以此类推方法级别和参数级别的。
该注解结合基于BeanPostProcessor的 MethodValidationPostProcessor , 在bean构建后搜索相关的注解和 validation注解,如果匹配到参数需要进行校验,插入切面和配置的校验器在请求时拦截并校验。
@Configuration
@ConditionalOnClass({ExecutableValidator.class})
@ConditionalOnResource(
resources = {"classpath:META-INF/services/javax.validation.spi.ValidationProvider"}
)
@Import({PrimaryDefaultValidatorPostProcessor.class})
public class ValidationAutoConfiguration {
public ValidationAutoConfiguration() {
}
@Bean
@Role(2)
@ConditionalOnMissingBean({Validator.class})
public static LocalValidatorFactoryBean defaultValidator() {
LocalValidatorFactoryBean factoryBean = new LocalValidatorFactoryBean();
MessageInterpolatorFactory interpolatorFactory = new MessageInterpolatorFactory();
factoryBean.setMessageInterpolator(interpolatorFactory.getObject());
return factoryBean;
}
@Bean
@ConditionalOnMissingBean
public static MethodValidationPostProcessor methodValidationPostProcessor(Environment environment, @Lazy Validator validator) {
MethodValidationPostProcessor processor = new MethodValidationPostProcessor();
boolean proxyTargetClass = (Boolean)environment.getProperty("spring.aop.proxy-target-class", Boolean.class, true);
processor.setProxyTargetClass(proxyTargetClass);
processor.setValidator(validator);
return processor;
}
}
关于校验器
如果你不对校验器进行配置,springboot自动注入的是LocalValidatorFactoryBean, 即一个支持国际化语言翻译的校验器工厂类,题外话(简单说你可以使用例如 i18n 等国际化技术来 翻译 你 校验注解上的 消息 , 例如 @NotNull(message="Validation.UserId.NotNull")
,然后根据语言环境转换这个message。)
上面
关于切面拦截器
我们做好配置和编码后程序织入的切面如何处理呢?一段代码可以很简单的说明
// ==================================== part1 自动注入 ========================================
public class ValidationAutoConfiguration {
//自动注入注入了 MethodValidationPostProcessor 注意参入了一个懒加载的校验器,这个是可以配置的
@Bean
public static MethodValidationPostProcessor methodValidationPostProcessor(Environment environment, @Lazy Validator validator) {
}
}
// ==================================== part2 Bean初始化 ========================================
public class MethodValidationPostProcessor extends AbstractBeanFactoryAwareAdvisingPostProcessor
implements InitializingBean {
@Nullable
private Validator validator;
/**
* Validator 也是可以配置的
*/
public void setValidator(Validator validator) {// 忽略实现}
/**
* 工厂同理
*/
public void setValidatorFactory(ValidatorFactory validatorFactory) {// 忽略实现}
/**
这个类是 InitializingBean 的实现,初始化完成后会构造一个默认的切面advice, 最终构造的默认就是 MethodVali
推荐阅读
-
反传销网8月30日发布:视频区块链里的骗子,币里的韭菜,杜子建骂人了!金融大V周召说区块链!——“一小帮骗子玩一大帮小白,被割韭菜,小白还轮流被割,割的就是你!” 什么区块链,统统是骗子 作者:周召(知乎金融领域大V,毕业于上海财经大学,目前任职上海某股权投资基金合伙人) 有人问我,区块链现在这么火,到底是不是骗局? 我的回答是: 是骗局。而且我并不是说数字货币是骗局,而是说所有搞区块链的都是骗局。 -01- 区块链是一种鸡肋技术 人类社会任何技术的发明应用,本质都是为了提高社会的生产效率。而所谓区块链技术本质不过是几种早已成熟的技术的大杂烩,冗余且十分低效,除了提高了洗钱和诈骗的效率以外,对人类社会的进步毫无贡献。 真正意义上的区块链得包含三个要素:分布式系统(包括记账和存储),无法篡改的数据结构,以及共识算法,三者互为基础和因果,就像三体世界一样。看上去挺让人不明觉厉的,而经过几年的瞎折腾,稍微懂点区块链的碰了几次壁后都已经渐渐明白区块链其实并没有什么卵用,区块链技术已经名存实亡,沦为了营销工具和传销组织的画皮。 因为符合上述定义的、以比特币为代表的原教旨区块链技术,是反效率的,从经济学角度来说,不但不是一种帕累托改进,甚至还可以说是一种帕累托倒退。 原教旨区块链技术的效率十分低下,因为要遍历所有节点,只能做非常轻量级的数据应用,一旦涉及到大量的数据传输与更新,区块链就瞎了。 一方面整条链交易速度会极慢,另一方面数据库容量极速膨胀,考虑到人手一份的存储机制,区块链其实是对存储资源和能源的一种极大的浪费。 这里还没有加上为了取得所谓的共识和挖矿消耗的巨大的能源,如果说区块链技术是屎,那么这波区块链投机浪潮可谓人类历史上最大规模的搅屎运动。 区块链也验证不了任何东西。 所谓的智能合约,即不智能,也非合约。我看有人还说,如果有了智能合约,就可以跟老板签一份放区块链上,如果明年销售业绩提升30%,就加薪10%,由于区块链不能篡改,不能抵赖,所以老板必须得执行,说得有板有眼,不懂行的愣一看,好像还真是那么回事。 但仔细一想,问题就来了。首先,在区块链上如何证明你真的达到了30%业绩提升?即便真的达到老板耍赖如何执行? 也就是说,如果区块链真这么厉害,要法院和仲裁干什么。 人类社会真正的符合成本效益原则的是代理制度。之前有人说要用区块链改造注册会计师行业,我不知道他准备怎么设计,我猜想他思路大概是这样的,首先肯定搞去中心化,让所有会计师到链上来,然后一个新人要成为注册会计师就要所有会计师同意并记录在链上。 那我就请问了,我每天上班累死累活,为什么还要花时间去验证一个跟我无关的的人的专业能力?最优做法当然是组织一个委员会,让专门的人来负责,这不就是现在注册会师协会干的事儿吗?区块链的逻辑相当于什么事情都要拿出来公投,这个绝对是扯淡的。 当然这么说都有点抬举区块链了,区块链技术本身根本没有判断是非能力,如果这么高级的人工智能,靠一个无脑分布式记账就能实现的话,我们早就进入共产主义社会了。 虽然EOS等数字货币采用了超级节点,通过再中心化的方式提高效率,有点行业协会的意思,是对区块链原教旨主义的一种修正,但是依然无法突破区块链技术最本质的局限性。有人说,私有链和联盟链是区块链技术的未来,也是扯淡,因为区块链技术没有未来。如果有,说明他是包装成区块链的伪区块链技术。 区块链所涉及的所有底层技术,不管是分布式数据库技术,加密技术,还是点对点传输技术等,基本都是早已存在没什么秘密可言的技术。 比特币系统最重要的特性是封闭性和自洽性,他验证不了任何系统自身以外产生的信息的真实性。 所谓系统自身产生的信息,就是数据库数据的变动信息,有价值的基本上有且只有交易信息。所以说比特币最初不过是中本聪一种炫技的产物,来证明自己对几种技术的掌握,你看我多牛逼,设计出了一个像三体一样的系统。因此,数字货币很有可能是区块链从始至终唯一的杀手应用。 比特币和区块链概念从诞生到今天已经快10年了,很多人说区块链技术在爆发的前夜,但这个前夜好像是不是有点过长了啊朋友,跟三体里的长夜有一拼啊。都说区块链技术像是90年代初的互联网,可是90年代初的互联网在十年发展后,已经出现了一大批伟大的公司,阿里巴巴在99年都成立了,区块链怎么除了币还是币呢? 正规的数字货币未来发展的形式无外乎几种,要么就是论坛币形式,或者类似股票的权益凭证等。问题是论坛币和股票之前,本来也都电子化了,区块链来了到底改变了什么呢? 所有想把TOKEN和应用场景结合起来的人最后都很痛苦,最后他们会发现区块链技术就是脱裤子放屁,自己辛苦搞半天,干嘛不自己作为中心关心门来收钱?最后这些人都产生了价值的虚无感,最终精神崩溃,只能发币疯狂收割韭菜,一边嘴里还说着我是个好人之类的奇怪的话。 因此,之前币圈链圈还泾渭分明,互相瞧不起,但这两年链圈逐渐坐不住了,想着是不是趁着泡沫没彻底破灭之前赶快收割一波,不然可能什么都捞不着了。 前段时间和一个名校毕业的链圈朋友瞎聊天,他说他们“致力于用区块链技术解决数字版权保护问题”,我就问他一个问题,你们如何保证你链的版权所有权声明是真实的,万一盗版者抢先一步把数据放在链上怎么办。他说他们的解决方案是连入国家数字版权保护中心的数据库进行验证…… 所以说区块链技术就是个鸡肋,研究到最后都会落入效率与真实性的黑洞,很多人一头扎进链圈后才发现,真正意义上的区块链技术,其实什么都干不了。 -02- 不是蠢就是坏的区块链媒体 空气币和区块链的造富神话,让区块链自媒体也开始迎风乱扭。一群群根本不知道区块链为何物的妖魔鬼怪纷纷进驻区块链自媒体战场,开始大放厥词胡编乱造。 任何东西,但凡只要和区块,链,分,分布式,记账,加密,验证,可追溯等等这些个关键词沾到哪怕一点点,这些所谓的区块链媒体人就会像狗闻到了屎了一样疯狂地把区块链概念往上套。 这让我想起曾经一度也是热闹非凡的物联网,我曾经去看过江苏一家号称要改变世界的“物联网”企业,过去一看是生产路由器的,我黑人问号脸,对方解释说没有路由器万物怎么互联,我觉得他说得好有道理,竟无言以对。 好,下面让我们进入奇葩共赏析时间,来看看区城链媒体经常有哪些危言耸听的奇谈怪论 区块链(分布式记账)的典型应用是*?? 正如前面所说,真正意义上的区块链分布式记账,不光包括“记”这个动作,还包括分布式存储和共识机制等。而*诞生远远早于区块链这个词的出现,勉强算是“分布式编辑”吧,就被很多区块链媒体拿来强行充当区块链技术应用的典范。 其实事实恰恰相反,*恰恰是去中心化失败的典范,现在如果没有精英和专业人士的编辑和维护,*早就没法看了。 区块链会促进社会分工?? 罗振宇好像就说过类似的话,虽然罗振宇说过很多没有逻辑的话,但这句话绝对是最没逻辑思维的。很多区块链自媒体也常常用这句话来忽悠老百姓,说分工代表效率提高社会进步,而区块链“无疑”会促进分工,他们的理由仅仅是分工和分布式记账都共用一个“分”字,就强行把他们扯到一起。 实际情况恰恰相反,区块链是逆分工的,区块链精神是号召所有人积极地参与到他不擅长也不想掺合的事情里面去。 区块链不能像上帝一样许诺他的子民死后上天国,只能给他们许诺你们是六度人脉中的第一级,我可以赚后面五级人的钱,你处于金字塔的顶端。
-
@Valid 注解解释了 Java Bean 验证的过去和现在。
-
@Validated和@Valid区别-1.分组 @Validated:提供了一个分组功能,可以在入参验证时,根据不同的分组采用不同的验证机制。没有添加分组属性时,默认验证没有分组的验证属性。 伪代码如下: public interface First{ } public interface Second{ } public class UserModel { @NotNull(message = "{id.empty}", groups = { First.class }) private int id; @NotNull(message = "{username.empty}", groups = { First.class, Second.class }) private String username; @NotNull(message = "{content.empty}", groups = { First.class, Second.class }) private String content; } public String save(@Validated( { Second.class }) UserModel userModel, BindingResult result) { if (result.hasErrors) { return "validate/error"; } return "redirect:/success"; } 对一个参数需要多种验证方式时,也可通过分配不同的组达到目的。例: @NotEmpty(groups = { First.class }) @Size(min = 3, max = 8, groups = { Second.class }) private String name; 分组还支持组序列 默认情况下,不同组别的约束验证是无序的,然而在某些情况下,约束验证的顺序却很重要,如下面两个例子:(1)第二个组中的约束验证依赖于一个稳定状态来运行,而这个稳定状态是由第一个组来进行验证的。(2)某个组的验证比较耗时,CPU 和内存的使用率相对比较大,最优的选择是将其放在最后进行验证。因此,在进行组验证的时候尚需提供一种有序的验证方式,这就提出了组序列的概念。 一个组可以定义为其他组的序列,使用它进行验证的时候必须符合该序列规定的顺序。在使用组序列验证的时候,如果序列前边的组验证失败,则后面的组将不再给予验证。 public interface GroupA { } public interface GroupB { } @GroupSequence( { GroupA.class, GroupB.class }) public interface Group { } public @ResponseBody String addPeople(@Validated({Group.class}) People p,BindingResult result) { if(result.hasErrors) { return "0"; } return "1"; } @Valid:作为标准JSR-303规范,还没有吸收分组的功能。 2.注解地方 @Validated:可以用在类型、方法和方法参数上。但是不能用在成员属性(字段)上 @Valid:可以用在方法、构造函数、方法参数和成员属性(字段)上 两者是否能用于成员属性(字段)上直接影响能否提供嵌套验证的功能。 3.嵌套验证 在比较两者嵌套验证时,先说明下什么叫做嵌套验证。 比如我们现在有个实体叫做Item: public class Item { @NotNull(message = "id不能为空") @Min(value = 1, message = "id必须为正整数") private Long id; @NotNull(message = "props不能为空") @Size(min = 1, message = "至少要有一个属性") private List<Prop> props; } Item带有很多属性,属性里面有:pid、vid、pidName和vidName,如下所示: public class Prop { @NotNull(message = "pid不能为空") @Min(value = 1, message = "pid必须为正整数") private Long pid; @NotNull(message = "vid不能为空") @Min(value = 1, message = "vid必须为正整数") private Long vid; @NotBlank(message = "pidName不能为空") private String pidName; @NotBlank(message = "vidName不能为空") private String vidName; } 属性这个实体也有自己的验证机制,比如pid和vid不能为空,pidName和vidName不能为空等。 现在我们有个ItemController接受一个Item的入参,想要对Item进行验证,如下所示: @RestController public class ItemController { @RequestMapping("/item/add") public void addItem(@Validated Item item, BindingResult bindingResult) { doSomething; } } 在上图中,如果Item实体的props属性不额外加注释,只有@NotNull和@Size,无论入参采用@Validated还是@Valid验证,Spring Validation框架只会对Item的id和props做非空和数量验证,不会对props字段里的Prop实体进行字段验证,也就是@Validated和@Valid加在方法参数前,都不会自动对参数进行嵌套验证。也就是说如果传的List中有Prop的pid为空或者是负数,入参验证不会检测出来。 为了能够进行嵌套验证,必须手动在Item实体的props字段上明确指出这个字段里面的实体也要进行验证。由于@Validated不能用在成员属性(字段)上,但是@Valid能加在成员属性(字段)上,而且@Valid类注解上也说明了它支持嵌套验证功能,那么我们能够推断出:@Valid加在方法参数时并不能够自动进行嵌套验证,而是用在需要嵌套验证类的相应字段上,来配合方法参数上@Validated或@Valid来进行嵌套验证。 我们修改Item类如下所示: public class Item { @NotNull(message = "id不能为空") @Min(value = 1, message = "id必须为正整数") private Long id; @Valid // 嵌套验证必须用@Valid @NotNull(message = "props不能为空") @Size(min = 1, message = "props至少要有一个自定义属性") private List<Prop> props; } 然后我们在ItemController的addItem函数上再使用@Validated或者@Valid,就能对Item的入参进行嵌套验证。此时Item里面的props如果含有Prop的相应字段为空的情况,Spring Validation框架就会检测出来,bindingResult就会记录相应的错误。 总结一下@Validated和@Valid在嵌套验证功能上的区别:
-
深入了解数据验证(Bean Validation):由浅入深地掌握 @Valid 的作用(级联验证)和常用的注释解释约束 [尽情学习 Java] (下)