Flutter数据验证插件dart_data_validation的使用

Flutter数据验证插件dart_data_validation的使用

dart_data_validation 是一个用于在Dart应用程序中进行数据验证的包。它允许你定义自定义验证规则，并将其应用于不同类型的数据。

概述

dart_data_validation 包提供了一组工具，用于在Dart应用程序中进行数据验证。你可以定义自定义验证规则并应用到不同的数据类型上。

安装

要使用此包，请在你的 pubspec.yaml 文件中添加 dart_data_validation 作为依赖：

dependencies:
  dart_data_validation: ^1.0.1

特性

• 数据验证：使用自定义规则验证数据，并排除特定数据类型。
• 验证结果：获取详细的验证结果信息，包括数据是否有效或无效，以及验证失败时的错误消息列表。
• TextFormField验证：方便地验证Flutter的 TextFormField 小部件中的用户输入。
• 易于使用：只需定义你的验证规则，然后使用 validate 方法或 textFormFieldValidator 方法进行验证。
• 可定制的错误消息：为验证失败提供自定义错误消息，以向用户提供有意义的反馈。
• 灵活的规则定义：定义验证规则为接受动态参数并返回布尔值的函数，允许复杂的验证场景。
• 与Flutter集成：无缝集成数据验证到你的Flutter应用程序中。

使用方法

在你的Dart文件中导入该包：

import 'package:dart_data_validation/dart_data_validation.dart';

验证器类

Validator 类是数据验证的主要入口点。它提供了定义验证规则和验证数据的方法。

构造函数

通过指定 excludedTypes 和 validationRules 参数创建一个新的 Validator 实例：

Validator({
  List<Type> excludedTypes = const [],
  List<Function(dynamic)> validationRules = const [],
})

• excludedTypes（可选）：应从验证中排除的数据类型列表。
• validationRules（可选）：验证规则的函数列表，这些函数接受动态参数并返回布尔值。

验证

使用 validate 方法根据配置的验证规则验证数据：

ValidationResult validate(dynamic data, {
  String? dataValidationFailedMessage,
  String? typeNotAllowedMessage,
})

• data：要验证的数据。
• dataValidationFailedMessage（可选）：如果数据验证失败，则包含在无效结果中的自定义消息。
• typeNotAllowedMessage（可选）：当数据类型被排除时，包含在无效结果中的自定义消息。

validate 方法返回一个表示验证结果的 ValidationResult 对象。

TextFormField验证

textFormFieldValidator 方法是一个方便的方法，专门用于验证 TextFormField 的值：

String? textFormFieldValidator(String? value, {String? errorMessage})

• value：要验证的值。
• errorMessage（可选）：如果值无效，则返回的自定义错误消息。

示例

以下是如何使用 dart_data_validation 包的一个示例：

import 'package:dart_data_validation/dart_data_validation.dart';

void main() {
  // 定义验证规则
  final validationRules = [
    (data) => data != null, // 规则：数据不能为空
    (data) => data is String, // 规则：数据必须是字符串
    (data) => data.isNotEmpty, // 规则：字符串不能为空
  ];

  // 创建一个新的验证器
  final validator = Validator(validationRules: validationRules);

  // 验证数据
  final data = 'Hello, world!';
  final validationResult = validator.validate(data);

  // 检查验证结果
  if (validationResult.isValid) {
    print('数据有效。');
  } else {
    print('数据无效。错误：${validationResult.errors}');
  }
}

验证器示例

import 'package:flutter/material.dart';
import 'package:dart_data_validation/dart_data_validation.dart';

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  final formKey = GlobalKey<FormState>();

  final validator = Validator(
    validationRules: [
      (data) => data.isNotEmpty, // 规则：字符串不能为空
      (data) => data.length > 8 && data.length < 18, // 规则：长度必须在8到18之间
    ],
  );

  MyApp({super.key});

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('表单验证'),
        ),
        body: Center(
          child: Padding(
            padding: const EdgeInsets.all(16.0),
            child: Form(
              key: formKey,
              child: Column(
                mainAxisAlignment: MainAxisAlignment.center,
                children: [
                  TextFormField(
                    decoration: const InputDecoration(
                      labelText: '请输入值',
                    ),
                    validator: (value) {
                      final errorMessage = validator.textFormFieldValidator(value, errorMessage: "请输入有效的操作。\n• 不能为空\n• 8-18个字符");
                      return errorMessage;
                    },
                  ),
                  const SizedBox(height: 16.0),
                  ElevatedButton(
                    onPressed: () {
                      // 验证表单

                      if (formKey.currentState!.validate()) {
                        print('表单有效。');
                      } else {
                        print('表单无效。');
                      }
                    },
                    child: const Text('提交'),
                  ),
                ],
              ),
            ),
          ),
        ),
      ),
    );
  }
}