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

向右看齐 2022-03-25 13:24 285阅读 0赞

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

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

## 1. 分组 ##

@Validated：提供了一个分组功能，可以在入参验证时，根据不同的分组采用不同的验证机制，这个网上也有资料，不详述。

@Valid：作为标准JSR-303规范，还没有吸收分组的功能。

## [2. 注解地方][2.] ##

@Validated：可以用在类型、方法和方法参数上。但是不能用在成员属性（字段）上

@Valid：可以用在方法、构造函数、方法参数和成员属性（字段）上

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

## [3. 嵌套验证][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不能为空，属性名和属性值不能为空等。在Java技术栈微信公众号回复关键字：*web*，获取更多 Java Web 开发系列文章。推荐阅读：[SpringMVC表单验证器的使用][SpringMVC]

现在我们有个 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的pid为空或者是负数，入参验证不会检测出来。推荐阅读：[初始化 List 集合的六种方式！][List]

为了能够进行嵌套验证，必须手动在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进行嵌套验证。

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

[2.]: https://mp.weixin.qq.com/s/nSIyS35N6KpnFCWdI43THA
[3.]: https://mp.weixin.qq.com/s/5APHlfBgNIwrIUPaPjw6qQ
[SpringMVC]: https://mp.weixin.qq.com/s/s2_Dptmz0CUiCiTACzmJ2A
[List]: https://mp.weixin.qq.com/s/nMcmYdIWYShYyuCWITSnmg