小蚂蚁 发表于 2021-10-5 18:36:15

详解Spring 参数验证@Validated和@Valid的区别

这篇文章主要介绍了详解参数验证 @Validated 和 @Valid 的区别,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
spring validation验证框架对参数的验证机制提供了@validated(spring's jsr-303 规范,是标准 jsr-303 的一个变种),javax提供了@valid(标准jsr-303规范),配合 bindingresult 可以直接提供参数验证结果。其中对于字段的特定验证注解比如 @notnull 等网上到处都有,这里不详述
在检验 controller 的入参是否符合规范时,使用 @validated 或者 @valid 在基本验证功能上没有太多区别。但是在分组、注解地方、嵌套验证等功能上两个有所不同:
1. 分组
@validated:提供了一个分组功能,可以在入参验证时,根据不同的分组采用不同的验证机制,这个网上也有资料,不详述。@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带有很多属性,属性里面有属性id,属性值id,属性名和属性值,如下所示:


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;
}
属性这个实体也有自己的验证机制,比如属性和属性值id不能为空,属性名和属性值不能为空等。
现在我们有个 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>中有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 在嵌套验证功能上的区别:
@validated: 用在方法入参上无法单独提供嵌套验证功能。不能用在成员属性(字段)上,也无法提示框架进行嵌套验证。能配合嵌套验证注解@valid进行嵌套验证。
@valid: 用在方法入参上无法单独提供嵌套验证功能。能够用在成员属性(字段)上,提示验证框架进行嵌套验证。能配合嵌套验证注解@valid进行嵌套验证。
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持CodeAE代码之家。
原文链接:https://segmentfault.com/a/1190000017962734

http://www.zzvips.com/article/175511.html
页: [1]
查看完整版本: 详解Spring 参数验证@Validated和@Valid的区别