java 校验框架 - Bean Validation

0. 引言

我们在写一些业务逻辑，经常需要写一些业务合法性校验，而这些校验是否可能是共用或者通用性的，那有没有想过有什么好的使用方式，今天就介绍下
java 提供的校验框架 - Bean Validation 官网：https://beanvalidation.org/

1. 什么是 Bean Validation

Bean Validation 是一套用于 Java Bean 验证的规范，它定义了一组标准的验证注解，用于验证 Java Bean 的属性值是否符合指定的约束条件。

2. 验证注解

Bean Validation 定义了一组标准的验证注解，用于验证 Java Bean 的属性值是否符合指定的约束条件。这些注解包括：

@NotNull: 验证属性值是否非空
@Null: 验证属性值是否为空
@NotEmpty: 验证属性值是否非空且长度大于 0
@NotBlank: 验证属性值是否非空且去除空格后的长度大于 0
@Size: 验证属性值的长度是否在指定的范围内
@Min: 验证属性值是否大于或等于指定的最小值
@Max: 验证属性值是否小于或等于指定的最大值
@Pattern: 验证属性值是否符合指定的正则表达式
@Email: 验证属性值是否为有效的电子邮件地址
@URL: 验证属性值是否为有效的 URL 地址

3. Bean Validation 的实现

Bean Validation 有多个实现，其中最流行的是 Hibernate Validator。

Hibernate Validator 是一个开源的 Bean Validation 实现，它提供了对所有标准验证注解的支持，并支持自定义验证注解。

4. 快速实战

• maven 项目中引入如下配置

<!-- 校验框架 -->
<dependency>
    <groupId>javax.validation</groupId>
    <artifactId>validation-api</artifactId>
    <version>2.0.1.Final</version>
</dependency>
<!-- 框架实现 -->
<dependency>
    <groupId>org.hibernate.validator</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>6.0.17.Final</version>
</dependency>

• 通过对于类 Order 的校验配置，看看简单的使用过程
  对于属性定义了多种校验规则

public class Order {

    @NotNull(message="订单号不能为空")
    @Min(value = 1, message = "订单号必须大于 0")
    @Max(value = 10000, message = "订单号不能超过 10000")
    private Long id;

    @NotEmpty(message = "下单用户不能为空")
    private String userName;

    @NotEmpty(message = "地址不能为空")
    private String address;

    @NotNull(message = "手机号不能为空")
    @Pattern(regexp = "^[1]([3-9])[0-9]{9}$")
    private String mobile;

    private String status;

    @NotNull(message = "创建时间不能为空")
    private Date createTime;

	// 此处省略 get set

• 测试

public class TestValidate {

	/**
	 * 通用校验方法，
	 * 通过 Validation 构建验证器，并调用校验方法
	 */
    public static void valid(Object obj) {
        Validator validator = Validation.buildDefaultValidatorFactory().getValidator();
        Set<ConstraintViolation<Object>> validates = validator.validate(obj);
        Iterator<ConstraintViolation<Object>> iterator = validates.iterator();
        while (iterator.hasNext()) {
            String message = iterator.next().getMessage();
            // 输出校验结果，根据实际业务场景进行处理，这里测试 输出结果
            System.out.println(message);
        }
    }

    public static void main(String[] args) {
        Order order = new Order();
        // 调用通用的校验方法
        valid(order);
    }
}

• 输出结果

订单号不能为空
手机号不能为空
下单用户不能为空
地址不能为空
创建时间不能为空

5. 总结

以上就是对 Bean Validation 的简单使用，Bean Validation 可以应用于各种场景，包括：

• Web 开发：用于验证表单提交的数据
• 服务端开发：用于验证服务端请求参数
• 数据持久化：用于验证数据库操作参数

大家可以先测试用起来，有些配置或者使用方式可以一起探索。后面我们再尝试在实际场景中使用它。