使用 Bean Validation 约束列表中的字符串：限定邮箱域名

Bean Validation 规范提供了一种强大的机制，用于验证 Java Bean 的属性。当需要验证集合（例如 List）中的元素时，可以使用容器元素约束。本文将详细介绍如何使用 @Pattern 注解结合容器元素约束，对字符串列表中的邮箱地址进行校验，确保它们都以 @gmail.com 结尾。

容器元素约束简介

容器元素约束允许您对集合中的每个元素应用约束。这对于验证集合中的数据非常有用，例如验证邮箱地址列表、电话号码列表等。在 Bean Validation 2.0 及更高版本中，可以通过在泛型类型参数前添加约束注解来实现容器元素约束。

使用 @Pattern 验证邮箱域名

假设我们有一个 List，其中包含邮箱地址，我们希望确保所有邮箱地址都以 @gmail.com 结尾。可以使用以下代码实现：

import javax.validation.constraints.Pattern;
import java.util.List;

public class EmailList {

    private List<@Pattern(regexp = "^(.+)@(gmail\\.com)$") String> emails;

    public List getEmails() {
        return emails;
    }

    public void setEmails(List emails) {
        this.emails = emails;
    }
}

代码解释：

• @Pattern(regexp = "^(.+)@(gmail\\.com)$"): 这个注解应用于 List 的泛型类型参数 String 之前，表示对列表中的每个字符串元素应用正则表达式约束。
  • regexp = "^(.+)@(gmail\\.com)$": 这是一个正则表达式，用于匹配以 @gmail.com 结尾的邮箱地址。
    • ^: 匹配字符串的开头。
    • (.+): 匹配一个或多个任意字符（除了换行符）。
    • @: 匹配 @ 字符。
    • gmail\\.com: 匹配 gmail.com 字符串，注意 . 需要转义。
    • $: 匹配字符串的结尾。

示例代码

import javax.validation.Validation;
import javax.validation.Validator;
import javax.validation.ValidatorFactory;
import java.util.Arrays;
import java.util.List;
import java.util.Set;
import javax.validation.ConstraintViolation;

public class Main {

    public static void main(String[] args) {
        ValidatorFactory factory = Validation.buildDefaul
tValidatorFactory();
        Validator validator = factory.getValidator();

        EmailList emailList = new EmailList();
        List emails = Arrays.asList("valid.email@gmail.com", "invalid.email@example.com");
        emailList.setEmails(emails);

        Set> violations = validator.validate(emailList);

        if (!violations.isEmpty()) {
            for (ConstraintViolation violation : violations) {
                System.err.println(violation.getPropertyPath() + " : " + violation.getMessage());
            }
        } else {
            System.out.println("Validation successful!");
        }
    }
}

运行结果：

emails[1] : must match "^(.+)@(gmail\.com)$"

代码解释：

1. 创建 ValidatorFactory 和 Validator: 使用 Validation.buildDefaultValidatorFactory() 创建一个 ValidatorFactory，然后使用 factory.getValidator() 获取一个 Validator 实例。
2. 创建 EmailList 对象: 创建一个 EmailList 对象，并设置包含有效和无效邮箱地址的列表。
3. 验证对象: 使用 validator.validate(emailList) 验证 EmailList 对象。 validate() 方法返回一个 Set>，其中包含所有验证失败的约束。
4. 处理验证结果: 如果 violations 集合不为空，则遍历集合并打印每个验证失败的约束信息。 否则，打印 "Validation successful!"。

注意事项

• 确保你的项目中包含 Bean Validation 的依赖。可以使用 Maven 或 Gradle 等构建工具添加依赖。例如，在 Maven 中，可以添加以下依赖：

    org.hibernate.validator
    hibernate-validator
    6.2.0.Final 


    org.glassfish
    jakarta.el
    4.0.2 

• 正则表达式需要进行转义，例如 . 需要转义为 \\., \ 本身也需要转义为 \\\\。
• 如果需要支持不同的邮箱域名，可以将正则表达式配置为可配置的属性。

总结

通过结合 @Pattern 注解和容器元素约束，可以方便地对集合中的元素进行模式验证，从而确保数据的有效性和一致性。 本文提供了一个验证邮箱域名列表的示例，您可以根据实际需求修改正则表达式，以适应不同的验证场景。 掌握容器元素约束的使用，可以提高数据校验的灵活性和可维护性。