Flutter表单字段保护插件field_guard的使用

field_guard 是一个强大的Flutter库，提供了丰富的工具来实现表单字段的验证和格式化功能。它通过定义各种规则和约束条件，简化了自定义表单的创建过程，并且支持多种内置验证和格式化方法。

主要类和方法

1. FieldGuardValidator

用于定义字段验证规则和错误消息。

构造函数

FieldGuardValidator({FieldGuardErrorMessages? customErrorMessages, bool optionalField = false})

方法

• validate(): 返回一个 FormFieldStringValidator 函数，执行基于定义规则的字段验证。
• required(): 添加必填字段验证规则。
• range({int min, int max}): 检查输入值是否在指定范围内。
• minLength(int len): 检查输入值是否达到最小长度。
• maxLength(int len): 检查输入值是否不超过最大长度。
• length(int len): 检查输入值是否具有精确长度。
• validPanIND(): 检查印度永久账户号码 (PAN) 是否有效。
• validIFSC(): 检查印度金融系统代码 (IFSC) 是否有效。
• validEmail(): 检查电子邮件地址是否有效。
• matchRegex(RegExp regex, String errorMessage): 使用正则表达式匹配输入值。
• strongPassword(): 检查密码强度。
• validAccountNumber(): 检查账号是否有效。
• validUpiID(): 检查UPI ID是否有效。
• validIndianZipCode(): 检查印度邮政编码是否有效。
• validCreditCardNumber(): 检查信用卡号是否有效。

2. FieldGuardFormatter

提供文本格式化功能，强制特定文本转换。

构造函数

FieldGuardFormatter()

方法

• format(): 返回包含定义文本格式化规则的 TextInputFormatter 对象列表。
• toTitleCase(): 将输入文本转换为标题大小写（每个单词的第一个字母大写）。
• allowedInput(FieldGuardAllowedInput allowedInput): 允许仅特定输入模式。
• disallowFirstWhiteSpace(): 禁止输入第一个字符为空格。
• maxCoupledWhiteSpaces({int max = 1}): 限制连续空格的最大数量。
• toLowerCase(): 将输入文本转换为小写。
• toUpperCase(): 将输入文本转换为大写。

3. FieldGuardCustomValidatorForm

管理字段验证和数据绑定的自定义验证表单。

构造函数

FieldGuardCustomValidatorForm({required List<FieldGuardLinkerElement> linkers})

方法

• validateForm(): 验证整个表单。
• getValidatorBykey(String key): 根据键检索 FieldGuardValidator。
• getControllerByKey(String key): 根据键检索 TextEditingController。
• updateLinkerElement(FieldGuardLinkerElement linkerElement): 更新链接元素。
• findLinkerElementByKey(String key): 根据键检索 FieldGuardLinkerElement。

4. FieldGuardLinkerElement

表示自定义验证表单中的单个链接元素。

构造函数

FieldGuardLinkerElement({required String key, required TextEditingController controller, required FieldGuardValidator validator})

方法

• update({TextEditingController? controller, FieldGuardValidator? validator}): 创建带有可选更新的控制器和验证器的新实例。

Enum: FieldGuardAllowedInput

定义可用于 allowedInput 方法的各种允许输入模式。

模式

• numberOnly(pattern: '0-9')
• alphabetOnly(pattern: 'A-Za-z')
• alphaNumericOnly(pattern: '0-9A-Za-z')
• alphabetsWithWhiteSpaces(pattern: 'A-Za-z ')
• numbersWithWhiteSpaces(pattern: '0-9 ')
• alphaNumericWithWhiteSpaces(pattern: '0-9A-Za-z ')
• emailAddress(pattern: '0-9A-Za-z@.-_')

示例 Demo

以下是一个完整的示例，展示如何使用 field_guard 插件进行表单验证和格式化：

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

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

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Field Guard Example',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(),
    );
  }
}

class MyHomePage extends StatefulWidget {
  [@override](/user/override)
  _MyHomePageState createState() => _MyHomePageState();
}

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

  final _validator = FieldGuardValidator()
    ..required()
    ..minLength(5)
    ..validEmail();

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Field Guard Example'),
      ),
      body: Padding(
        padding: const EdgeInsets.all(16.0),
        child: Form(
          key: _formKey,
          child: Column(
            children: <Widget>[
              TextFormField(
                controller: _controller,
                decoration: InputDecoration(labelText: 'Email'),
                validator: _validator.validate(),
              ),
              SizedBox(height: 20),
              ElevatedButton(
                onPressed: () {
                  if (_formKey.currentState!.validate()) {
                    ScaffoldMessenger.of(context).showSnackBar(
                      SnackBar(content: Text('Form is valid')),
                    );
                  } else {
                    ScaffoldMessenger.of(context).showSnackBar(
                      SnackBar(content: Text('Form is invalid')),
                    );
                  }
                },
                child: Text('Submit'),
              ),
            ],
          ),
        ),
      ),
    );
  }
}