Flutter表单验证插件utopia_validation的使用

utopia_validation 是一个用于 Flutter 的表单验证插件，它提供了一种简单且灵活的方式来验证表单输入。通过使用 utopia_validation，你可以轻松地定义验证规则，并在表单提交时检查输入的有效性。

安装

首先，你需要在 pubspec.yaml 文件中添加 utopia_validation 依赖：

dependencies:
  flutter:
    sdk: flutter
  utopia_validation: ^1.0.0  # 请使用最新版本

然后运行 flutter pub get 来安装依赖。

基本用法

1. 导入包：

   import 'package:utopia_validation/utopia_validation.dart';
   

2. 创建验证器：

   你可以使用 Validator 类来创建验证器。Validator 提供了多种内置的验证规则，如 required, minLength, maxLength, email, 等等。

   final validator = Validator({
     'username': [RequiredRule(), MinLengthRule(3)],
     'email': [RequiredRule(), EmailRule()],
     'password': [RequiredRule(), MinLengthRule(6)],
   });
   

3. 验证表单：

   在表单提交时，你可以使用 validator.validate 方法来验证表单数据。validate 方法返回一个 ValidationResult 对象，其中包含验证结果和错误信息。

   void submitForm(Map<String, String> formData) {
     ValidationResult result = validator.validate(formData);
   
     if (result.isValid) {
       // 表单数据有效，继续处理
       print('Form is valid');
     } else {
       // 表单数据无效，显示错误信息
       print('Form is invalid');
       result.errors.forEach((field, errors) {
         print('$field: ${errors.join(', ')}');
       });
     }
   }
   

4. 在 Flutter 表单中使用：

   你可以在 Flutter 的 Form 和 TextFormField 中使用 utopia_validation 来验证用户输入。

   class MyForm extends StatefulWidget {
     @override
     _MyFormState createState() => _MyFormState();
   }
   
   class _MyFormState extends State<MyForm> {
     final _formKey = GlobalKey<FormState>();
     final Map<String, String> _formData = {};
   
     final validator = Validator({
       'username': [RequiredRule(), MinLengthRule(3)],
       'email': [RequiredRule(), EmailRule()],
       'password': [RequiredRule(), MinLengthRule(6)],
     });
   
     void _submitForm() {
       if (_formKey.currentState!.validate()) {
         _formKey.currentState!.save();
         ValidationResult result = validator.validate(_formData);
   
         if (result.isValid) {
           // 表单数据有效，继续处理
           print('Form is valid');
         } else {
           // 表单数据无效，显示错误信息
           print('Form is invalid');
           result.errors.forEach((field, errors) {
             print('$field: ${errors.join(', ')}');
           });
         }
       }
     }
   
     @override
     Widget build(BuildContext context) {
       return Form(
         key: _formKey,
         child: Column(
           children: [
             TextFormField(
               decoration: InputDecoration(labelText: 'Username'),
               onSaved: (value) => _formData['username'] = value!,
               validator: (value) => validator.validateField('username', value),
             ),
             TextFormField(
               decoration: InputDecoration(labelText: 'Email'),
               onSaved: (value) => _formData['email'] = value!,
               validator: (value) => validator.validateField('email', value),
             ),
             TextFormField(
               decoration: InputDecoration(labelText: 'Password'),
               obscureText: true,
               onSaved: (value) => _formData['password'] = value!,
               validator: (value) => validator.validateField('password', value),
             ),
             ElevatedButton(
               onPressed: _submitForm,
               child: Text('Submit'),
             ),
           ],
         ),
       );
     }
   }
   

自定义验证规则

你可以通过继承 ValidationRule 类来创建自定义的验证规则。

class CustomRule extends ValidationRule {
  @override
  String? validate(String? value) {
    if (value != null && value.contains('custom')) {
      return null; // 验证通过
    }
    return 'Value must contain "custom"'; // 验证失败
  }
}

然后在验证器中使用自定义规则：

final validator = Validator({
  'customField': [CustomRule()],
});