Spring 中数据校验 @Validated和@Valid 的区别
Spring Validation验证框架对参数的验证机制提供了@Validated(Spring's JSR-303标准,是规范JSR-303的一个变种),javax提供了@Valid(规范JSR-303标准),配合BindingResult能够间接提供参数验证后果。
两者比照
在测验Controller的入参是否符合规范时,应用@Validated或者@Valid在根本验证性能上没有太多区别。然而在分组、注解中央、嵌套验证等性能上两个有所不同:
分组
@Validated:提供了一个分组性能,能够在入参验证时,依据不同的分组采纳不同的验证机制,这个网上也有材料,不详述。@Valid:作为规范JSR-303标准,还没有排汇分组的性能。
注解中央
@Validated:能够用在类型、办法和办法参数上。然而不能用在成员属性(字段)上
@Valid:能够用在办法、构造函数、办法参数和成员属性(字段)上
两者是否能用于成员属性(字段)上间接影响是否提供嵌套验证的性能。
嵌套验证
在比拟两者嵌套验证时,先阐明下什么叫做嵌套验证。比方咱们当初有个实体叫做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 中有很多属性,包含含有List汇合的属性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;}
属性这个实体也有本人的验证机制,比方属性和属性值id不能为空,属性名和属性值不能为空等。
当初咱们有个ItemController承受一个Item的入参,想要对Item进行验证,如下所示:
@RestControllerpublic 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进行嵌套验证。