Flutter表单验证插件validator_generator的使用

Flutter表单验证插件validator_generator的使用

概述

validator_generator 是一个用于生成表单验证器的 Dart 构建系统插件。通过在类上添加注解，该插件会在构建时生成相应的验证器类。

安装

要配置项目以使用 validator_generator，请在 pubspec.yaml 文件中添加依赖：

dependencies:
  validator_annotation: ^x.x.x

dev_dependencies:
  build_runner: ^x.x.x
  validator_generator: ^x.x.x

然后运行以下命令来获取依赖项：

flutter pub get

示例

假设你有一个名为 UserModel 的类，它包含两个字段：email 和 password。我们希望为这些字段添加验证规则，并生成相应的验证器类。

步骤 1: 添加注解

首先，在 UserModel 类上添加 @ClassValidator 注解，并在每个字段上添加适当的验证注解。

import 'package:validator_annotation/validator_annotation.dart';

part 'user_model.validator.dart';

@ClassValidator(
  // 只获取第一个错误
  stopWhenFirstError: false,
  // 验证函数命名约定
  namingConvention: NamingConvention.snack_case,
)
class UserModel {
  // 对 email 字段应用非空字符串验证
  @IsNotEmptyStringValidator()
  // 对 email 字段应用电子邮件验证
  @IsEmailValidator(
    // 自定义字段名
    fieldName: 'email',
    // 自定义错误消息
    errorMessage: '不是有效的电子邮件',
  )
  final String email;

  @IsNotEmptyStringValidator()
  final String password;

  const UserModel({
    required this.email,
    required this.password,
  });
}

步骤 2: 运行构建工具

运行以下命令以生成相应的验证器类文件 user_model.validator.dart：

dart run build_runner build

步骤 3: 查看生成的验证器类

构建完成后，会生成 user_model.validator.dart 文件。以下是生成的文件内容：

// GENERATED CODE - DO NOT MODIFY BY HAND

// ignore_for_file: non_constant_identifier_names

part of 'user_model.dart';

// **************************************************************************
// ValidatorModelGenerator
// **************************************************************************

class UserModelValidator {
  static String? validate_email(String value) {
    final validatorAnnotations = [
      const IsNotEmptyStringValidator(),
      const IsEmailValidator(fieldName: 'email', errorMessage: '不是有效的电子邮件')
    ];
    return validateField(
      value,
      validatorAnnotations,
    );
  }

  static String? validate_password(String value) {
    final validatorAnnotations = [const IsNotEmptyStringValidator()];
    return validateField(
      value,
      validatorAnnotations,
    );
  }

  static ValidationResult validate(UserModel instance) {
    // 验证数据
    final validationDatas = [
      ValidationData(
        instanceMemberSymbol: 'email',
        valueToValidate: instance.email,
        annotations: [
          const IsNotEmptyStringValidator(),
          const IsEmailValidator(
              fieldName: 'email', errorMessage: '不是有效的电子邮件')
        ],
      ),
      ValidationData(
        instanceMemberSymbol: 'password',
        valueToValidate: instance.password,
        annotations: [const IsNotEmptyStringValidator()],
      )
    ];

    // 验证器选项
    const stopWhenFirstError = false;
    return validateInstance(
      validationDatas,
      stopWhenFirstError: stopWhenFirstError,
    );
  }
}

使用验证器

现在你可以使用生成的验证器类来验证 UserModel 实例。

void main() {
  final user = UserModel(email: '', password: '');

  final validationResult = UserModelValidator.validate(user);

  if (validationResult.isValid) {
    print('表单验证通过');
  } else {
    print('表单验证失败');
    validationResult.errors.forEach((error) {
      print(error.message);
    });
  }
}