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

来源：blog.csdn.net/qq_27680317/article/details/79970590 整编：Java技术栈（公众号ID：javastack）

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

另外，栈长已经整理了 Java 系列核心知识点文章，关注Java技术栈公众号，在后台回复关键字：java，便可获取。

关注公众号，天天推送一篇干货。