关于程序员:Spring-中数据校验-Validated和Valid-的区别

34次阅读

共计 2217 个字符,预计需要花费 6 分钟才能阅读完成。

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 进行验证,如下所示:

@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 进行嵌套验证。

正文完
 0