Flutter表单工具插件form_utility的使用

Flutter表单工具插件form_utility的使用

描述

form_utility 这个包提供了一组工具来简化 Flutter 中的表单处理。它包括用于表单字段和验证的类，以及一个用于表单管理的混入（mixin）。该包设计得非常灵活和可扩展，允许你根据需要定义自己的表单字段和验证规则。

安装

要使用此包，请在 pubspec.yaml 文件中添加 form_utility 作为依赖项。

dependencies:
  form_utility: ^x.y.z

然后运行 flutter pub get 来安装它。

使用

首先，在需要功能的地方添加 FormUtility 混入。

接着，你可以通过 FormUtility 混入注册字段和验证规则。FormUtility 提供了方法来注册字段和验证规则，以及验证整个表单并访问表单数据。

registerField(
  InputField(
    name: 'EmailFieldKey',
    isRequired: true,
    validators: [EmailValidator()],
  ),
);

现在你对这些字段有了控制权，并可以按你想要的方式进行验证。

你甚至可以利用跨字段验证。

registerField(
  InputField(
    name: 'ConfirmPasswordKey',
    generateCustomValidators: (formValues) {
      return [
        BaseValidator(
          errorMessage: 'Passwords do not match',
          validation: (value) => value == fields['PasswordKey']?.value,
        ),
      ];
    },
  ),
);

你可以使用预定义的验证器或创建自己的验证器，通过继承 BaseValidator 类实现。

class CustomValidator extends BaseValidator {
  CustomValidator() : super(
    errorMessage: 'your error message',
    validation: (value) => 'your validation logic',
  );
}

表单可以通过调用 validateForm 方法进行验证。如果你需要某个字段的即时验证，你需要将该字段的 hotErrorEnabled 设置为 true。

验证错误信息会由 validateForm 方法返回。你也可以使用 validateField 方法来验证单个字段。

示例代码

以下是一个完整的示例代码，展示了如何使用 form_utility 包来处理表单。

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

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

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  // 这个小部件是你的应用的根节点。
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: '表单工具演示',
      theme: ThemeData(
        colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
        useMaterial3: true,
      ),
      home: const MyHomePage(title: '表单工具演示'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({super.key, required this.title});
  final String title;

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

class _MyHomePageState extends State<MyHomePage> with FormUtility {
  static const String _emailKey = 'email';
  static const String _passwordKey = 'password';
  static const String _confirmPasswordKey = 'confirmPassword';

  String? _emailFieldErrorMessage;
  String? _passwordFieldErrorMessage;
  String? _confirmPasswordFieldErrorMessage;

  [@override](/user/override)
  void initState() {
    registerField(
      InputField(
          name: _emailKey,
          hotErrorEnabled: false,
          isRequired: true,
          validators: [EmailValidator()]),
    );
    registerField(
      InputField(
          name: _passwordKey,
          isRequired: true,
          hotErrorEnabled: true,
          validators: [MinLengthValidator(6, fieldName: 'Password')]),
    );
    registerField(
      InputField(
          name: _confirmPasswordKey,
          isRequired: true,
          hotErrorEnabled: true,
          generateCustomValidators: (fields) {
            return [
              BaseValidator(
                errorMessage: 'Passwords do not match',
                validation: (value) => value == fields[_passwordKey]?.value,
              ),
            ];
          }),
    );
    super.initState();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        backgroundColor: Theme.of(context).colorScheme.inversePrimary,
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            SizedBox(
              width: 200,
              child: TextField(
                onChanged: (text) {
                  updateField(_emailKey, text);
                },
                decoration: InputDecoration(
                  errorText: _emailFieldErrorMessage,
                  label: const Text('Email'),
                ),
              ),
            ),
            const SizedBox(height: 20),
            SizedBox(
              width: 200,
              child: TextField(
                onChanged: (text) {
                  updateField(_passwordKey, text);
                  setState(() {
                    _passwordFieldErrorMessage = getField(_passwordKey).error;
                  });
                },
                decoration: InputDecoration(
                  errorText: _passwordFieldErrorMessage,
                  label: const Text('Password'),
                ),
              ),
            ),
            const SizedBox(height: 20),
            SizedBox(
              width: 200,
              child: TextField(
                onChanged: (text) {
                  updateField(_confirmPasswordKey, text);
                  setState(() {
                    _confirmPasswordFieldErrorMessage =
                        getField(_confirmPasswordKey).error;
                  });
                },
                decoration: InputDecoration(
                  errorText: _confirmPasswordFieldErrorMessage,
                  label: const Text('Confirm Password'),
                ),
              ),
            ),
            const SizedBox(height: 20),
            ElevatedButton(
                onPressed: () {
                  setState(() {
                    _emailFieldErrorMessage = validateField(_emailKey);
                    _passwordFieldErrorMessage = validateField(_passwordKey);
                  });
                  if (_emailFieldErrorMessage != null &&
                      _passwordFieldErrorMessage != null) {
                    return;
                  } else {
                    // 提交表单
                  }
                },
                child: const Text('提交'))
          ],
        ),
      ),
    );
  }
}