Validators

在 ChatGPT 中打开

验证器在将数据提交到数据模型之前，会根据定义的约束对您的 UI 组件中的数据进行验证。您可以应用验证器来验证数据是否满足某些标准，例如是否在指定范围内、是否匹配某个模式或是否为空。

验证是在每个绑定上进行配置的，允许特定规则应用于每个数据点。每条数据根据其自身的要求进行验证。

添加验证器

通过在 BindingBuilder 上使用 useValidator 方法向绑定添加验证器。

context.bind(nameTextField, "name")
  .useValidator(value -> !value.isEmpty(), "名称不能为空")
  .useValidator(value -> value.length() >= 3, "名称必须至少包含 3 个字符")
  .add();

在上面的示例中，两个验证器验证名称是否不为空，并且至少包含三个字符。

验证器处理

每个绑定可以添加的验证器数量没有限制。绑定按插入顺序应用验证器，并在首次违规时停止。

实现验证器

您可以通过实现 Validator<T> 接口来创建可重用的自定义验证器，其中 T 是您要验证的数据类型。此设置涉及定义 validate 方法，该方法检查数据并返回 ValidationResult。

以下是一个检查用户电子邮件是否有效的可重用验证器示例。

import com.webforj.data.validation.server.ValidationResult;
import com.webforj.data.validation.server.validator.Validator;

public class EmailValidator implements Validator<String> {
  private static final String PATTERN = "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,6}$";

  @Override
  public ValidationResult validate(String value) {
    if (value.matches(PATTERN)) {
        return ValidationResult.valid();
    } else {
        return ValidationResult.invalid("无效的电子邮件地址");
    }
  }
}

在绑定中使用验证器

定义验证器后，您可以轻松地将其应用于应用中的任何相关绑定。这在需要在应用不同部分之间使用通用验证规则的组件中尤其有用，例如用户电子邮件地址或密码强度。

要将 EmailValidator 应用于绑定：

BindingContext<User> context = new BindingContext<>(User.class);
context.bind(ageField, "age")
  .useValidator(new EmailValidator())
  .add();

覆盖验证器消息

您可以在绑定到特定 UI 组件时自定义验证器的错误消息。这使您能够在验证失败时为用户提供更详细或相关的信息。当同一验证器适用于多个组件，但根据使用的上下文需要不同的指导时，自定义消息尤其有用。

以下是如何在绑定中覆盖可重用验证器的默认消息：

BindingContext<User> context = new BindingContext<>(User.class);
context.bind(emailField, "email")
  .useValidator(
    Validator.from(new EmailValidator(), "无效电子邮件地址的自定义消息"))
  .add();

在上面的示例中，代码对电子邮件字段应用了 EmailValidator，并为该字段定制了一条错误消息。

理解 Validator.from

Validator.from 方法用一个新验证器封装一个传入的验证器，从而允许您在验证器不支持自定义消息的情况下指定自定义错误消息。当您需要在多个组件中应用相同的验证逻辑，但每个实例需要不同的上下文特定错误消息时，这种技术特别有用。

动态验证消息 25.12

默认情况下，验证消息是绑定时设置的静态字符串。在支持多种语言的应用中，当用户切换语言环境时，这些静态消息不会更新。为了解决这个问题，useValidator 和 Validator 工厂方法都接受一个 Supplier<String>，在每次验证失败时调用，从而允许消息动态解析。

带动态消息的内联验证器

将 Supplier<String> 传递给 useValidator，而不是普通的 String：

context.bind(nameTextField, "name")
  .useValidator(value -> !value.isEmpty(), () -> t("validation.name.required"))
  .useValidator(value -> value.length() >= 3, () -> t("validation.name.minLength"))
  .add();

每次运行验证且谓词失败时，供应商调用 t()，该方法解析当前语言环境的消息。

带动态消息的工厂方法

Validator.of 和 Validator.from 工厂方法也接受供应商：

// 创建一个基于谓词的带动态消息的验证器
Validator<String> required = Validator.of(
  value -> !value.isEmpty(),
  () -> t("validation.required")
);

// 用动态覆盖消息包装现有验证器
Validator<String> email = Validator.from(
  new EmailValidator(),
  () -> t("validation.email.invalid")
);

语言环境感知的自定义验证器

对于需要在内部生成语言环境敏感消息的可重用验证器，实现 LocaleAware 接口。当通过 BindingContext.setLocale() 更改语言环境时，上下文将自动将新的语言环境传播给实现此接口的所有验证器。下一个验证运行将生成更新语言环境中的消息。