你有没有使用过这些编程骚操作(二)- 验证框架(Part B)

253 阅读2分钟

「这是我参与2022首次更文挑战的第26天,活动详情查看:2022首次更文挑战

一、中级约束注解

可以进行下面三个方面的校验

  • 级联验证
  • 分组验证
  • 组序列

级联属性验证@Valid

级联属性使用@Valid注解进行验证 在User实体类中的friends属性上增加@Valid注解

@Size(min = 1, message = "用户好友不能少于1个")
private List<@Valid User> friends;

在init方法中实例化一个ArrayList用来存放User,并实例化一个User放到ArrayList中,然后调用setter方法给user对象的friends属性赋值。

List<User> friends = new ArrayList<>();
User friend = new User();
friends.add(friend);
User.setFriends(friends);

执行测试 image.png 可以实现对List列表中的User对象进行校验。

在init方法中对friends中的friend对象进行赋值

List<User> friends = new ArrayList<>();
User friend = new User();
friend.setUserId(1);
friend.setUserName("Stark");
friend.setPassword("12345678901234567890");
friends.add(friend);
User.setFriends(friends);

再次测试

image.png 验证通过,控制台不再报任何校验不通过的提示

分组验证,groups属性

对于userId和email属性来说,不同的场景可能要进行不同的验证,如果是登录需要传入userId,需要对用户的userId进行校验,对email则不需要进行校验,而在注册场景中则不需要验证userId,userId是注册成功后系统生成的,但是需要对email进行校验,因为需要通过email接受邮件激活用户,这种情况如何实现校验?

修改User实体类,新增两个接口分组属性,在userId和email属性上设置分组。完整的User实体类代码如下

@Data
public class User {

    public interface LoginGroup {}

    public interface RegisterGroup {}

    @NotNull(message = "用户ID不能为空", groups = LoginGroup.class)
    private Integer userId;
    @NotEmpty(message = "用户的userName不能为空")
    private String userName;
    @NotBlank(message = "用户的password不能为空")
    @Length(min = 6, max = 20, message = "用户密码不能少于6位,不能多于20位")
    private String password;
    @NotNull(message = "用户邮箱不能为空", groups = RegisterGroup.class)
    @Email(message = "用户邮箱格式不正确")
    private String email;
    private String phone;
    @Min(value = 18, message = "用户年龄不能小于18岁")
    @Max(value = 100, message = "用户年龄不能大于100岁")
    private Integer age;
    @Past(message = "用户生日不能为未来的时间点")
    private Date birthday;
    @Size(min = 1, message = "用户好友不能少于1个")
    private List<@Valid User> friends;
}

注释掉init方法中给userId赋值的代码及给email赋值的代码,init方法的代码如下

@Before
public void init(){
    // 初始化验证器
    validator = Validation.buildDefaultValidatorFactory().getValidator();
    User = new User();
    // User.setUserId(1);
    User.setUserName("Stark");
    User.setPassword("12345678901234567890");
    // User.setEmail("213243@stark.com");
    User.setAge(19);
    Calendar calendar = Calendar.getInstance();
    calendar.set(2021,1,1);
    User.setBirthday(calendar.getTime());
    List<User> friends = new ArrayList<>();
    User friend = new User();
    friend.setUserId(1);
    friend.setUserName("Stark");
    friend.setPassword("12345678901234567890");
    friend.setEmail("stark@stark.com");
    friends.add(friend);
    User.setFriends(friends);

}

新增测试方法,模拟登录场景下对userId进行校验

@Test
public void testLoginGroupValidation(){
    set = validator.validate(User,User.LoginGroup.class);
}

执行测试 image.png 登录场景下只对用户ID进行了校验忽略了用户邮箱,输出了用户ID为空的提示信息

新增测试代码,模拟注册场景下对email属性进行校验

@Test
public void testRegisterGroupValidation(){
    set = validator.validate(User,User.RegisterGroup.class);
}

执行测试

image.png 注册场景下只对用户的邮箱进行校验忽略了用户ID的校验,并抛出了用户邮箱为空的提示信息

组序列,对几个分组同时进行验证并且可以自定义验证顺序

在User实体类属性中再增加一个属性,使用注解@GroupSequence来定义验证顺序,一旦校验失败就会抛出提示信息

@GroupSequence({
  LoginGroup.class,
  RegisterGroup.class, 
  Default.class
})
public interface Group {}

注解中没有定义groups属性的其他属性的校验则归属在Default组中

定义测试方法

@Test
public void testGroupSequenceValidation(){
    set = validator.validate(User,User.Group.class);
}

执行该测试方法 image.png 控制台输出了userId为空的提示信息,说明首先对userId进行了校验,userId是属于LoginGroup组,与定义的校验顺序一致并且校验失败后直接抛出提示信息,不在往下进行校验

将userId赋值代码的注释去掉,再次执行测试方法

image.png 当userId校验通过后,开始对email进行校验,email属于RegisterGroup,校验顺序与定义的一致

将email属性赋值代码的注释去掉,并在给userName属性赋值的代码增加注释,再次执行测试

image.png

userName属性的校验是在Default默认组中,最后才进行校验

可以将验证属性较为耗时的组放到最后验证