SpringBoot服务端数据校验过程详解

2020-02-24 16:01:32王振洲

三、@Valid和@Validated的区别

@Valid是使用Hibernate validation的时候。

@Validated是使用Spring Validator校验机制(在spring-context依赖下)。

java的JSR303声明了@Valid这类接口,而Hibernate-validator对其进行了实现,@Validation对@Valid进行了二次封装,在使用上并没有区别,但在分组、注解位置、嵌套验证等功能上有所不同。

1. 注解位置上

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

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

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

2. 分组校验

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

@Valid:没有分组功能。

(1) 定义分组接口

public interface IGroupA {
}

public interface IGroupB {
}

(2) 定义需要校验的参数bean

public class Student 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;

  public String getName() {
    return name;
  }

  public void setName(String name) {
    this.name = name;
  }

  public Integer getAge() {
    return age;
  }

  public void setAge(Integer age) {
    this.age = age;
  }

  public String getPhoneNum() {
    return phoneNum;
  }

  public void setPhoneNum(String phoneNum) {
    this.phoneNum = phoneNum;
  }

  public String getEmail() {
    return email;
  }

  public void setEmail(String email) {
    this.email = email;
  }
}

(3) 检验分组为IGroupA的情况

@RestController
public class CheckController {

  @PostMapping("/stu")
  public String addStu(@Validated({IGroupA.class}) Student studentBean){
    return "add student success";
  }
}

很明显,这里对IGroupA是不起作用的,修改为@Validated({IGroupB.class})或@Validated({IGroupA.class, IGroupB.class})。

说明:

不分配groups,默认每次都要进行验证
对一个参数需要多种验证方式时,也可通过分配不同的组达到目的。

3. 组序列

默认情况下 不同级别的约束验证是无序的,但是在一些情况下,顺序验证却是很重要。

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