@Validated和@Valid校验

Posted

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了@Validated和@Valid校验相关的知识,希望对你有一定的参考价值。

参考技术A 一般情况下,若不需要分组校验的话:使用@Valid和@Validated并无特殊差异。

在参数前加 @Valid 注解,如下:

此情况发生,是由于 方法参数是JavaBean,参数的某一个属性 也是JavaBean

若校验的参数是List<User>样式的,用级联嵌套的方法就会失效。因为@Valid只能校验JavaBean,而List不是JavaBean。采用以下2个方法可完善:

controller对应的方法参数,使用ValidList

别再乱用了,这才是 @Validated 和 @Valid 的真正区别!!!

点击关注公众号,实用技术文章及时了解

概述

  • @Valid是使用Hibernate validation的时候使用

  • @Validated是只用Spring Validator校验机制使用

说明:java的JSR303声明了@Valid这类接口,而Hibernate-validator对其进行了实现

@Validation@Valid进行了二次封装,在使用上并没有区别,但在分组、注解位置、嵌套验证等功能上有所不同,这里主要就这几种情况进行说明。

注解位置

  • @Validated:用在类型、方法和方法参数上。但不能用于成员属性(field)

  • @Valid:可以用在方法、构造函数、方法参数和成员属性(field)上

如:

如果@Validated注解在成员属性上,则会报不适用于field错误

分组校验

  • @Validated:提供分组功能,可以在参数验证时,根据不同的分组采用不同的验证机制

  • @Valid:没有分组功能

举例:

定义分组接口:

public interface IGroupA 

 
public interface IGroupB 

定义需要检验的参数bean:

public class StudentBean implements Serializable
    @NotBlank(message = "用户名不能为空")
    private String name;
    //只在分组为IGroupB的情况下进行验证
    @Min(value = 18, message = "年龄不能小于18岁", groups = IGroupB.class)
    private Integer age;
    @Pattern(regexp = "^((13[0-9])|(14[5,7,9])|(15([0-3]|[5-9]))|(166)|(17[0,1,3,5,6,7,8])|(18[0-9])|(19[8|9]))\\\\d8$", message = "手机号格式错误")
    private String phoneNum;
    @Email(message = "邮箱格式错误")
    private String email;
    @MyConstraint
    private String className;

测试代码:

检验分组为IGroupA的情况

@RestController
public class CheckController 
    @PostMapping("stu")
    public String addStu(@Validated(IGroupA.class) @RequestBody StudentBean studentBean)
        return "add student success";
    

测试:

这里对分组IGroupB的就没检验了

如果把测试代码改成下面这样,看看测试结果

@RestController
public class CheckController 
    @PostMapping("stu")
    public String addStu(@Validated(IGroupA.class, IGroupB.class) @RequestBody StudentBean studentBean)
        return "add student success";
    

说明:

1、不分 配groups,默认每次都要进行验证

2、对一个参数需要多种验证方式时,也可通过分配不同的组达到目的。

组序列

默认情况下 不同级别的约束验证是无序的,但是在一些情况下,顺序验证却是很重要。推荐:Java面试题宝典

一个组可以定义为其他组的序列,使用它进行验证的时候必须符合该序列规定的顺序。在使用组序列验证的时候,如果序列前边的组验证失败,则后面的组将不再给予验证。

举例:

定义组序列:

@GroupSequence(Default.class, IGroupA.class, IGroupB.class)
public interface IGroup 

需要校验的Bean,分别定义IGroupA对age进行校验,IGroupB对className进行校验:

public class StudentBean implements Serializable
    @NotBlank(message = "用户名不能为空")
    private String name;
    @Min(value = 18, message = "年龄不能小于18岁", groups = IGroupA.class)
    private Integer age;
    @Pattern(regexp = "^((13[0-9])|(14[5,7,9])|(15([0-3]|[5-9]))|(166)|(17[0,1,3,5,6,7,8])|(18[0-9])|(19[8|9]))\\\\d8$", message = "手机号格式错误")
    private String phoneNum;
    @Email(message = "邮箱格式错误")
    private String email;
    @MyConstraint(groups = IGroupB.class)
    private String className;

测试代码:

@RestController
public class CheckController 
    @PostMapping("stu")
    public String addStu(@Validated(IGroup.class) @RequestBody StudentBean studentBean)
        return "add student success";
    

测试发现,如果age出错,那么对组序列在IGroupA后的IGroupB不进行校验,即例子中的className不进行校验,结果如下:

嵌套校验

一个待验证的pojo类,其中还包含了待验证的对象,需要在待验证对象上注解@Valid,才能验证待验证对象中的成员属性,这里不能使用@Validated

举例:

需要约束校验的bean:

public class TeacherBean 
    @NotEmpty(message = "老师姓名不能为空")
    private String teacherName;
    @Min(value = 1, message = "学科类型从1开始计算")
    private int type;
public class StudentBean implements Serializable
    @NotBlank(message = "用户名不能为空")
    private String name;
    @Min(value = 18, message = "年龄不能小于18岁")
    private Integer age;
    @Pattern(regexp = "^((13[0-9])|(14[5,7,9])|(15([0-3]|[5-9]))|(166)|(17[0,1,3,5,6,7,8])|(18[0-9])|(19[8|9]))\\\\d8$", message = "手机号格式错误")
    private String phoneNum;
    @Email(message = "邮箱格式错误")
    private String email;
    @MyConstraint
    private String className;
 
    @NotNull(message = "任课老师不能为空")
    @Size(min = 1, message = "至少有一个老师")
    private List<TeacherBean> teacherBeans;

注意:

这里对teacherBeans只校验了NotNull, 和 Size,并没有对teacher信息里面的字段进行校验,具体测试如下:

这里teacher中的type明显是不符合约束要求的,但是能检测通过,是因为在student中并没有做 嵌套校验

可以在teacherBeans中加上 @Valid,具体如下:

@Valid
@NotNull(message = "任课老师不能为空")
@Size(min = 1, message = "至少有一个老师")
private List<TeacherBean> teacherBeans;

这里再来测试,会发现如下结果:

来源:blog.csdn.net/herojuice/article/

details/86020101

推荐

Java面试题宝典

技术内卷群,一起来学习!!

PS:因为公众号平台更改了推送规则,如果不想错过内容,记得读完点一下“在看”,加个“星标”,这样每次新文章推送才会第一时间出现在你的订阅列表里。点“在看”支持我们吧!

以上是关于@Validated和@Valid校验的主要内容,如果未能解决你的问题,请参考以下文章

@Validated注解和@Valid注解区别

Java中的参数校验

Java中的参数校验

@Validated 和 @Valid 联合使用,完成service层参数校验

GroupSequenceProvider动态校验入参;@Validated和@Valid的区别

@Valid和@Validated的总结区分(转)