【Validation】@Validated和@Valid区别：Spring validation验证框架对入参实体进行嵌套验证必须在相应属性（字段）加上@Valid而不是@Validated

灰太狼 2022-12-19 08:53 161阅读 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. 注解地方

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

# 约束性注解(简单)说明 #

<table> 
 <tbody> 
 <tr> 
 <td> 注解 </td> 
 <td> 功能 </td> 
 </tr> 
 <tr> 
 <td> @AssertFalse </td> 
 <td> 可以为null,如果不为null的话必须为false </td> 
 </tr> 
 <tr> 
 <td> @AssertTrue </td> 
 <td> 可以为null,如果不为null的话必须为true </td> 
 </tr> 
 <tr> 
 <td> @DecimalMax </td> 
 <td> 设置不能超过最大值 </td> 
 </tr> 
 <tr> 
 <td> @DecimalMin </td> 
 <td> 设置不能超过最小值 </td> 
 </tr> 
 <tr> 
 <td> @Digits </td> 
 <td> 设置必须是数字且数字整数的位数和小数的位数必须在指定范围内 </td> 
 </tr> 
 <tr> 
 <td> @Future </td> 
 <td> 日期必须在当前日期的未来 </td> 
 </tr> 
 <tr> 
 <td> @Past </td> 
 <td> 日期必须在当前日期的过去 </td> 
 </tr> 
 <tr> 
 <td> @Max </td> 
 <td> 最大不得超过此最大值 </td> 
 </tr> 
 <tr> 
 <td> @Min </td> 
 <td> 最大不得小于此最小值 </td> 
 </tr> 
 <tr> 
 <td> @NotNull </td> 
 <td> 不能为null，可以是空 </td> 
 </tr> 
 <tr> 
 <td> @Null </td> 
 <td> 必须为null </td> 
 </tr> 
 <tr> 
 <td> @Pattern </td> 
 <td> 必须满足指定的正则表达式 </td> 
 </tr> 
 <tr> 
 <td> @Size </td> 
 <td> 集合、数组、map等的size()值必须在指定范围内 </td> 
 </tr> 
 <tr> 
 <td> @Email </td> 
 <td> 必须是email格式 </td> 
 </tr> 
 <tr> 
 <td> @Length </td> 
 <td> 长度必须在指定范围内 </td> 
 </tr> 
 <tr> 
 <td> @NotBlank </td> 
 <td> 字符串不能为null,字符串trim()后也不能等于“” </td> 
 </tr> 
 <tr> 
 <td> @NotEmpty </td> 
 <td> 不能为null，集合、数组、map等size()不能为0；字符串trim()后可以等于“” </td> 
 </tr> 
 <tr> 
 <td> @Range </td> 
 <td> 值必须在指定范围内 </td> 
 </tr> 
 <tr> 
 <td> @URL </td> 
 <td> 必须是一个URL </td> 
 </tr> 
 </tbody> 
</table>

参考：[https://blog.csdn.net/qq\_27680317/article/details/79970590?utm\_medium=distribute.pc\_relevant.none-task-blog-BlogCommendFromMachineLearnPai2-1.channel\_param&depth\_1-utm\_source=distribute.pc\_relevant.none-task-blog-BlogCommendFromMachineLearnPai2-1.channel\_param][https_blog.csdn.net_qq_27680317_article_details_79970590_utm_medium_distribute.pc_relevant.none-task-blog-BlogCommendFromMachineLearnPai2-1.channel_param_depth_1-utm_source_distribute.pc_relevant.none-task-blog-BlogCommendFromMachineLearnPai2-1.channel_param]

[https://blog.csdn.net/fly\_duck/article/details/107849845?utm\_medium=distribute.pc\_relevant\_t0.none-task-blog-BlogCommendFromMachineLearnPai2-1.channel\_param&depth\_1-utm\_source=distribute.pc\_relevant\_t0.none-task-blog-BlogCommendFromMachineLearnPai2-1.channel\_param][https_blog.csdn.net_fly_duck_article_details_107849845_utm_medium_distribute.pc_relevant_t0.none-task-blog-BlogCommendFromMachineLearnPai2-1.channel_param_depth_1-utm_source_distribute.pc_relevant_t0.none-task-blog-BlogCommendFromMachineLearnPai2-1.channel_param]

[https_blog.csdn.net_qq_27680317_article_details_79970590_utm_medium_distribute.pc_relevant.none-task-blog-BlogCommendFromMachineLearnPai2-1.channel_param_depth_1-utm_source_distribute.pc_relevant.none-task-blog-BlogCommendFromMachineLearnPai2-1.channel_param]: https://blog.csdn.net/qq_27680317/article/details/79970590?utm_medium=distribute.pc_relevant.none-task-blog-BlogCommendFromMachineLearnPai2-1.channel_param&depth_1-utm_source=distribute.pc_relevant.none-task-blog-BlogCommendFromMachineLearnPai2-1.channel_param
[https_blog.csdn.net_fly_duck_article_details_107849845_utm_medium_distribute.pc_relevant_t0.none-task-blog-BlogCommendFromMachineLearnPai2-1.channel_param_depth_1-utm_source_distribute.pc_relevant_t0.none-task-blog-BlogCommendFromMachineLearnPai2-1.channel_param]: https://blog.csdn.net/fly_duck/article/details/107849845?utm_medium=distribute.pc_relevant_t0.none-task-blog-BlogCommendFromMachineLearnPai2-1.channel_param&depth_1-utm_source=distribute.pc_relevant_t0.none-task-blog-BlogCommendFromMachineLearnPai2-1.channel_param