@Validated和@Valid的用法

后端接口经常需要对入参做校验,比如限制非空、长度、类型等。可以用代码校验,但是这样会比较麻烦,代码看着也比较繁琐。所以对于一些简单的校验,可以用注解的方式,这个时候就会用到@Validated或@Valid的注解了,但是这两个注解有什么区别呢?

@Valid是使用Hibernate validation的时候使用。@Validated是只用Spring Validator校验机制使用。
@Validation对@Valid进行了二次封装,在使用上并没有区别,但在分组、注解位置、嵌套验证等功能上有所不同。

@Valid:可以用在方法、构造函数、方法参数和成员属性(field)上。@Validated:用在类型、方法和方法参数上。但不能用于成员属性(field)。如果@Validated注解在成员属性上,则会报不适用于field错误。

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

下面来看具体用法:
定义分组接口:

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]))\\d{8}$", 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";
    }
}

@Validated和@Valid的用法_第1张图片
这里对分组IGroupB的就没检验了,如果把测试代码改成下面这样,看看测试结果。

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

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

public class TeacherBean {
    @NotEmpty(message = "老师姓名不能为空,公众号:Java精选")
    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]))\\d{8}$", 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信息里面的字段进行校验,具体测试如下:
@Validated和@Valid的用法_第3张图片
这里teacher中的type明显是不符合约束要求的,但是能检测通过,是因为在student中并没有做嵌套校验。可以在teacherBeans中加上@Valid,具体如下:

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

这里再来测试,会发现如下结果:
@Validated和@Valid的用法_第4张图片

你可能感兴趣的:(hibernate,java,spring)