Spring中@Validated和@Valid区别浅析
目录
- 基本概念
- @Valid和@Validated 批注
- 主要区别
- 什么是嵌套验证?
- 总结
基本概念
Spring Validation 验证框架对参数的验证机制提供了@Validated(Spring's JSR-303规范,是标准JSR-303的一个变种),javax提供了@Valid(标准JSR-303规范),配合BindingResult可以直接提供参数验证结果。其中对于字段的特定验证注解,比如@NotNull。
@Valid和@Validated 批注
在Spring中,我们使用JSR-303的@Valid批注进行方法级别验证。此外,我们还使用它来标记成员属性以进行验证。但是,此注释不支持组验证。
组验证有助于限制验证期间应用的约束。UI向导是一种特殊的用例。在这里,第一步,我们可能有一个特定的字段子组。在后续步骤中,可能存在另一个属于同一bean的组。因此,我们需要在每个步骤中对这些有限的字段应用约束,但是@Valid不支持此约束。
在这种情况下,对于组级别,我们必须使用Spring的@Validated,这是此JSR-303的@Valid的变体。在方法级别使用。为了标记成员属性,我们继续使用@Valid批注。
主要区别
在检验Controller的入参是否符合规范时,使用@Validated或者@Valid在基本验证功能上没有太多区别。但是在分组、注解地方、嵌套验证等功能上两个有所不同:
@Validated | @Valid | |
分组 | 提供分组功能,可在入参验证时,根据不同的分组采用不同的验证机制。 | 无分组功能 |
可注解位置 |
可以用在类型、方法和方法参数上。但是不能用在成员属性上 | 可以用在方法、构造函数、方法参数和成员属性上(两者是否能用于成员属性上直接影响能否提供嵌套验证的功能) |
嵌套验证 |
用在方法入参上无法单独提供嵌套验证功能。 不能用在成员属性上。 也无法提供框架进行嵌套验证。 能配合嵌套验证注解@Valid进行嵌套验证。 |
用在方法入参上无法单独提供嵌套验证功能。 能够用在成员属性上,提示验证框架进行嵌套验证。 能配合嵌套验证注解@Valid进行嵌套验证。 |
什么是嵌套验证?
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,props属性名和属性值,如下所示:
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; }
props属性也有自己的验证机制,比如属性值不能为空。
现在测试,接收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加在方法参数前,都不会对参数进行嵌套验证。
为了能够进行嵌套验证,必须手动在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; }
总结
到此这篇关于Spring中@Validated和@Valid区别的文章就介绍到这了,更多相关Spring @Validated和@Valid区别内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们!