Flutter数据验证插件validify的使用

Flutter数据验证插件validify的使用

目录

• 特性
• 安装
• 使用
• API参考
• 为什么使用此系统
• Dart版本
• 问题
• 贡献
• 作者
• 许可证

特性

本仓库中的代码旨在简化您的Flutter项目中的验证过程。它包括：

• 自定义验证器：轻松创建和组合符合您需求的验证器。
• 同步和异步验证：支持两种类型的验证，包括远程检查和复杂操作。
• 内置验证器：包含各种常见的验证器，如必填字段、最小/最大长度、正则表达式匹配等。
• 灵活的错误信息：为每个验证规则定制错误信息。

安装

要将validify用于您的Dart或Flutter项目，在pubspec.yaml文件中添加以下依赖项：

dependencies:
  validify: ^0.0.3

然后运行flutter pub get以安装该包。

使用

class EmailValidator extends Validify {
  [@override](/user/override)
  List<ValidatorFunction> get validators => [
        Validator.require(message: 'Email is required'),
        Validator.pattern(r'^[^@]+@[^@]+\.[^@]+$', message: 'Invalid email format'),
      ];
}

TextFormField(
  controller: _emailController,
  decoration: const InputDecoration(
    labelText: 'Email',
    border: OutlineInputBorder(),
  ),
  validator: EmailValidator().validate,
),

/// ------------ 或者 ------------

final ValidatorFunction _passwordValidator = Validators.combine([
  Validators.require(message: 'Password is required'),
  Validators.minLength(6, message: (length) => 'Password must be at least $length characters long'),
]);

TextFormField(
  controller: _passwordController,
  obscureText: true,
  decoration: const InputDecoration(
    labelText: 'Password',
    border: OutlineInputBorder(),
  ),
  validator: _passwordValidator,
),

API参考

验证器

一个用于创建和管理验证规则的实用类：

• require({String? message}): 检查值是否不为空的验证器。
• minLength(int length, {String? Function(int)? message}): 最小长度验证器。
• maxLength(int length, {String? Function(int)? message}): 最大长度验证器。
• pattern(RegExp pattern, {String? message}): 正则表达式模式匹配验证器。
• combine(List<ValidatorFunction> validators): 组合多个验证器。
• equality(String firstValue, String secondValue, {required String message}): 检查两个值是否相等。
• asyncPattern(RegExp pattern, {String? message}): 异步正则表达式模式匹配验证器。
• custom({required bool Function(String? value) condition, required String message}): 基于条件的自定义验证器。
• trimAndValidate(ValidatorFunction validator): 去除空格后应用提供的验证器。
• dateAfter(DateTime date, {String? message}): 检查日期是否在指定日期之后的验证器。
• combineAsync(List<AsyncValidatorFunction> validators): 组合多个异步验证器。

为什么使用此系统？

• 可重用：一旦设置好，您可以跨不同项目重复使用这些验证器。
• 可扩展：轻松扩展和自定义验证器以适应特定用途。
• 代码清晰：通过抽象验证逻辑来鼓励清晰且可维护的代码。

Dart版本

  sdk: '>=2.17.0 <4.0.0'

问题

请在GitHub页面上提交任何问题、错误报告或功能请求。

贡献

如果您希望为插件做出贡献（例如改进文档、解决错误或添加新功能），请仔细阅读我们的贡献指南，并发送您的拉取请求。

作者

这个validify包由Bedirhan Sağlam开发。您可以通过bedirhansaglam270@gmail.com联系我。

许可证

MIT

示例代码

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

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

class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      debugShowCheckedModeBanner: false,
      theme: ThemeData.light(),
      home: const MyHomePage(),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({Key? key}) : super(key: key);

  [@override](/user/override)
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  final _formKey = GlobalKey<FormState>();

  final TextEditingController _emailController = TextEditingController();
  final TextEditingController _passwordController = TextEditingController();

  // 密码验证器使用Validators类
  final ValidatorFunction _passwordValidator = Validators.combine([
    Validators.require(message: 'Password is required'),
    Validators.minLength(
      6,
      message: (length) => 'Password must be at least $length characters long',
    ),
  ]);

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('验证器示例'),
      ),
      body: Padding(
        padding: const EdgeInsets.all(16.0),
        child: Form(
          key: _formKey,
          child: Column(
            children: <Widget>[
              TextFormField(
                controller: _emailController,
                keyboardType: TextInputType.emailAddress,
                textInputAction: TextInputAction.next,
                decoration: const InputDecoration(
                  labelText: 'Email',
                  border: OutlineInputBorder(),
                ),
                validator: _EmailValidator().validate,
              ),
              const SizedBox(height: 16.0),
              TextFormField(
                controller: _passwordController,
                obscureText: true,
                decoration: const InputDecoration(
                  labelText: 'Password',
                  border: OutlineInputBorder(),
                ),
                validator: _passwordValidator,
              ),
              const SizedBox(height: 16.0),
              ElevatedButton(
                onPressed: () {
                  if (_formKey.currentState?.validate() ?? false) {
                    ScaffoldMessenger.of(context)
                      ..hideCurrentSnackBar()
                      ..showSnackBar(
                        const SnackBar(content: Text('正在处理数据')),
                      );
                  }
                },
                child: const Text('提交'),
              ),
            ],
          ),
        ),
      ),
    );
  }
}

/// 使用这个[_EmailValidator]或者像这样：
///
/// ```dart
///   final ValidatorFunction _emailValidator = Validators.combine([
///    Validators.require(message: 'Email is required'),
///    Validators.pattern(RegExp(r'^[^@]+@[^@]+\.[^@]+$'), message: '无效的电子邮件格式'),
///  ]);
/// ```
class _EmailValidator extends Validify {
  [@override](/user/override)
  List<ValidatorFunction> get validators => [
        Validators.require(message: 'Email is required'),
        Validators.pattern(RegExp(r'^[^@]+@[^@]+\.[^@]+$'),
            message: '无效的电子邮件格式'),
      ];
}