Hibernate Validate详解

小蓝 • 2024-12-22 08:07 • 编程

一、Hibernate Validate简介

Hibernate Validator是一个基于Java的校验框架，实现Bean Validation规范的所有API。Hibernate Validator实现了JSR 303 Bean Validation规范。该规范提供一种验证机制，可以用于在表单验证等场景下进行Java Bean属性的校验。

二、Hibernate Validate注解

Hibernate Validator提供了丰富的注解，以满足各种校验需求。以下是Hibernate Validator提供的常用注解：

@NotNull

用于验证被注释的元素必须不为null，{@code CharSequence} 长度必须大于0。

public class User {

    @NotNull(message = "姓名不能为空")
    private String name;

    // other property
}

@NotBlank

用于验证被注释的字符序列必须不为空（长度不为0）并且不是空白字符串。

public class User {

    @NotBlank(message = "姓名不能为空")
    private String name;

    // other property
}

@NotEmpty

用于验证注释的元素不允许为null或为空。支持元素类型为CharSequence、Collection、Map、数组。

public class User {

    @NotEmpty(message = "手机号不能为空")
    private String mobile;

    @NotEmpty(message = "邮箱不能为空")
    private String email;

    // other property
}

@Min 和 @Max

用于验证被注释的字段的值必须大于或等于/小于或等于指定的值。

public class User {

    @Min(value = 18, message = "年龄必须大于等于18岁")
    private Integer age;

    @Max(value = 100, message = "年龄必须小于等于100岁")
    private Integer age;

    // other property
}

@Email

用于验证被注释的元素必须是电子邮件地址。

public class User {

    @Email(message = "邮箱格式不正确")
    private String email;

    // other property
}

三、Hibernate Validate使用

使用Hibernate Validator需要配置相应的依赖，并在需要校验的Bean字段上添加相应的注解。需要注意的是，需要使用Validator进行校验时，需要使用Validator对应的校验器。ValidatorFactory是校验器工厂，通过ValidatorFactory可以获取Validator进行校验。

示例代码：

定义需要校验的User类：

public class User {

    @NotBlank(message = "用户名不能为空")
    private String username;

    @NotBlank(message = "密码不能为空")
    private String password;

    @Email(message = "邮箱格式不正确")
    private String email;

    @NotNull(message = "年龄不能为空")
    @Min(value = 18, message = "年龄必须大于等于18岁")
    @Max(value = 100, message = "年龄必须小于等于100岁")
    private Integer age;

    // getters and setters
}

根据User类创建测试类：

public class UserValidatorTest {

    private Validator validator;

    @Before
    public void setUp() {
        ValidatorFactory validatorFactory = Validation.buildDefaultValidatorFactory();
        validator = validatorFactory.getValidator();
    }

    @Test
    public void testUserValidator() {
        User user = new User();
        user.setUsername(" ");
        user.setPassword("123456");
        user.setEmail("test.email@test.com");
        user.setAge(12);
        Set<ConstraintViolation> violations = validator.validate(user);
        Assertions.assertEquals(2, violations.size());
    }

}

总结

本文介绍了Hibernate Validator的基本使用方式以及常用注解的使用方法。在实际开发中，Hibernate Validator可以方便快捷地完成表单验证等场景下的Java Bean属性校验。使用Hibernate Validator，可以大大提高开发效率，减少不必要的开发工作量。

原创文章，作者：小蓝，如若转载，请注明出处：https://www.506064.com/n/283209.html