yeskery

参数验证 @Validated 和 @Valid 的区别

Spring Validation 验证框架对参数的验证机制提供了 @Validated(Spring’s JSR-303规范,是标准JSR-303 的一个变种),java x提供了 @Valid(标准JSR-303规范),配合 BindingResult 可以直接提供参数验证结果。其中对于字段的特定验证注解比如 @NotNull 等网上到处都有,这里不详述

在检验 Controller 的入参是否符合规范时,使用 @Validated 或者 @Valid 在基本验证功能上没有太多区别。但是在分组、注解地方、嵌套验证等功能上两个有所不同:

分组

@Validated:提供了一个分组功能,可以在入参验证时,根据不同的分组采用不同的验证机制,这个网上也有资料,不详述。@Valid:作为标准JSR-303规范,还没有吸收分组的功能。

注解地方

  1. @Validated:可以用在类型、方法和方法参数上。但是不能用在成员属性(字段)上

  2. @Valid:可以用在方法、构造函数、方法参数和成员属性(字段)上

两者是否能用于成员属性(字段)上直接影响能否提供嵌套验证的功能。

嵌套验证

在比较两者嵌套验证时,先说明下什么叫做嵌套验证。比如我们现在有个实体叫做 Item:

  1. public class Item {
  2. @NotNull(message = "id不能为空")
  3. @Min(value = 1, message = "id必须为正整数")
  4. private Long id;
  5. @NotNull(message = "props不能为空")
  6. @Size(min = 1, message = "至少要有一个属性")
  7. private List<Prop> props;
  8. }

Item 带有很多属性,属性里面有属性 id,属性值 id,属性名和属性值,如下所示:

  1. public class Prop {
  2. @NotNull(message = "pid不能为空")
  3. @Min(value = 1, message = "pid必须为正整数")
  4. private Long pid;
  5. @NotNull(message = "vid不能为空")
  6. @Min(value = 1, message = "vid必须为正整数")
  7. private Long vid;
  8. @NotBlank(message = "pidName不能为空")
  9. private String pidName;
  10. @NotBlank(message = "vidName不能为空")
  11. private String vidName;
  12. }

属性这个实体也有自己的验证机制,比如属性和属性值 id 不能为空,属性名和属性值不能为空等。
现在我们有个 ItemController 接受一个 Item 的入参,想要对 Item 进行验证,如下所示:

  1. @RestController
  2. public class ItemController {
  3. @RequestMapping("/item/add")
  4. public void addItem(@Validated Item item, BindingResult bindingResult) {
  5. doSomething();
  6. }
  7. }

如上,如果 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 类如下所示:

  1. public class Item {
  2. @NotNull(message = "id不能为空")
  3. @Min(value = 1, message = "id必须为正整数")
  4. private Long id;
  5. @Valid // 嵌套验证必须用@Valid
  6. @NotNull(message = "props不能为空")
  7. @Size(min = 1, message = "props至少要有一个自定义属性")
  8. private List<Prop> props;
  9. }

然后我们在 ItemController 的 addItem 函数上再使用 @Validated 或者 @Valid,就能对 Item 的入参进行嵌套验证。此时 Item 里面的 props 如果含有 Prop 的相应字段为空的情况,Spring Validation 框架就会检测出来,bindingResult 就会记录相应的错误。

总结一下 @Validated@Valid 在嵌套验证功能上的区别:

@Validated:用在方法入参上无法单独提供嵌套验证功能。不能用在成员属性(字段)上,也无法提示框架进行嵌套验证。能配合嵌套验证注解 @Valid 进行嵌套验证。

@Valid:用在方法入参上无法单独提供嵌套验证功能。能够用在成员属性(字段)上,提示验证框架进行嵌套验证。能配合嵌套验证注解 @Valid 进行嵌套验证。

本文转载自:https://blog.csdn.net/qq_27680317/article/details/79970590

评论

发表评论 点击刷新验证码

提示

该功能暂未开放