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

lieeps 发布于2019-08-16 14:37 / 2566人阅读

摘要：也就是说如果传的中有的为空或者是负数，入参验证不会检测出来。为了能够进行嵌套验证，必须手动在实体的字段上明确指出这个字段里面的实体也要进行验证。用在方法入参上无法多带带提供嵌套验证功能。

来源：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 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的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 props;
}

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

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

@Validated： 用在方法入参上无法多带带提供嵌套验证功能。不能用在成员属性（字段）上，也无法提示框架进行嵌套验证。能配合嵌套验证注解@Valid进行嵌套验证。

@Valid： 用在方法入参上无法多带带提供嵌套验证功能。能够用在成员属性（字段）上，提示验证框架进行嵌套验证。能配合嵌套验证注解@Valid进行嵌套验证。

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

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

GPU云服务器云服务器宽带和专线的区别专线和宽带的区别空间和域名的区别功能和作用的区别

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/73113.html

@Validated和@Valid的区别？校验级联属性（内部类）

摘要：毕竟永远相信本文能给你带来意想不到的收获使用示例关于数据校验这一块在中的使用案例，我相信但凡有点经验的程序员应该没有不会使用的，并且还不乏熟练的选手。每篇一句 NBA里有两大笑话：一是科比没天赋，二是詹姆斯没技术相关阅读【小家Java】深入了解数据校验：Java Bean Validation 2.0（JSR303、JSR349、JSR380）Hibernate-Validati...

Winer 2019-08-19 10:14 评论0 收藏0
让Controller支持对平铺参数执行@Valid数据校验

摘要：方案一借助对方法级别数据校验的能力首先必须明确一点此能力属于框架的，而部分框架。每篇一句在金字塔塔尖的是实践，学而不思则罔，思而不学则殆（现在很多编程框架都只是教你碎片化的实践）相关阅读【小家Java】深入了解数据校验：Java Bean Validation 2.0（JSR303、JSR349、JSR380）Hibernate-Validation 6.x使用案例【小家Spr...

printempw 2019-08-19 10:15 评论0 收藏0
Spring方法级别数据校验：@Validated + MethodValidationPostPr

摘要：就这样借助相关约束注解，就非常简单明了，语义清晰的优雅的完成了方法级别入参校验返回值校验的校验。但倘若是返回值校验执行了即使是失败了，方法体也肯定被执行了只能哪些类型上提出这个细节的目的是约束注解并不是能用在所有类型上的。每篇一句在《深度工作》中作者提出这么一个公式：高质量产出=时间*专注度。所以高质量的产出不是靠时间熬出来的，而是效率为王相关阅读【小家Java】深入了解数据校...

孙吉亮 2019-08-19 10:11 评论0 收藏0
Hibernate-Validator 验证参数

摘要：添加依赖，如果使用了，则不需要引用任何依赖，因为包中已经包含了依赖在类的属性上加上对应的注解核查结果中文不能为空检查结果中文级联校验不能超过个嫌疑人集合被注释的元素必须为被注释的元素必须不为被注释的元素必须为被注释的元素必须为被 1.添加 Hibernate-Validator 依赖，如果使用了springboot，则不需要引用任何依赖，因为spring-boot-starter-we...

myeveryheart 2019-08-16 18:37 评论0 收藏0
Java验证

摘要：校验器可以通过对象报告校验失败的信息接口定义示例如下，可以使用等工具测试用户名不能为空常用注解也可以自定义注解及其校验规则获取并初始化注解信息设置自定义校验规则人的姓名不能为空参考 Q: 为什么后端需要校验，只交给前端校验行不行A: 前后端都需要校验后端校验防止请求过来的非法数据，对后端进行破坏 Java后端常用的校验框架 Apache commons-validator http...

funnyZhang 2019-08-15 12:17 评论0 收藏0