Flutter身份验证插件verify的使用

verify 是一个用于Dart和Flutter项目的函数式编程风格的验证DSL。它允许你创建灵活且可扩展的验证器，适用于各种场景如表单验证、数据解析等。以下是关于如何使用 verify 插件的详细说明和示例。

功能特性

• 完全可扩展：你可以创建自己的组合器、验证器原语等。
• 灵活：基于扩展的API，没有单一类创建，所有都是纯函数。
• 可定制：可以定义自己的错误类型，按需组织验证器。
• BLoC友好：参见示例实现。
• 空安全：作为预发布版本支持。

使用方法

创建验证器

验证器是一个简单的函数别名：

// 根据是否将验证的主题转换为另一种类型，有两种变体
typedef ValidatorT<S, T> = Either<List<dynamic>, T> Function(S subject);
typedef Validator<S> = Either<List<dynamic>, S> Function(S subject);

例如，创建一个简单的电子邮件验证器：

final Validator<String> emailValidator = (String email) {
  return email.contains('@') ? Right(email) : Left(['Bad email format']);
};

简单验证器从谓词创建

使用内置的帮助函数：

final containsAt = Verify.that(
  (String email) => email.contains('@'),
  error: 'Bad email format'
);

复用验证器

通过组合构建更复杂的验证器：

final Validator<String> emailValidator = Verify.all([containsAt, notEmpty]);

验证并转换

验证器也可以转换其输入，例如同时进行解析和验证：

final Validator<String, int> intParsingValidator = (String str) => Right(int.parse(str));

final validator = intParsingValidator.onException((_) => Error('not an integer'));

字段验证

给定一个模型，例如用户：

class User extends Equatable {
  final String? phone;
  final String? mail;
  final int? age;

  const User(this.phone, this.mail, this.age);

  [@override](/user/override)
  List<Object> get props => [phone ?? '', mail ?? '', age ?? ''];
}

可以通过链式调用 check 和 checkField 方法对对象及其字段进行额外检查：

final userValidator = Verify.empty<User>()
    .check((user) => !user.phone!.isEmpty, error: Error('phone empty'))
    .checkField((user) => user.mail!, emailValidator);

final someUser = User('', '', 25);
final Either<List<Error>, User> validationResult = userValidator.verify(someUser);

运行验证器

运行验证器只需传递参数，因为它是函数。为了更优雅地处理，提供了一个 verify 方法，该方法不仅可以转发参数到调用的验证器，还可以过滤错误列表并将其转换为特定错误类型：

final signUpValidation = Verify.subject<SignUpState>();
final errors = signUpValidation
    .verify<SignUpError>(newState); // Either<List<SignUpError>, SignUpState>

内置验证器

虽然 verify 不自带很多内置验证器，但它们非常容易创建。它确实带有一些正则表达式的简写：

final validator = Verify.fromRegex(RegExp(r"(^\d+$)", error: Error('not just digits'))); // Validator<String, int>

表单验证

通常情况下，你会建模你的错误类型类似于以下形式：

enum FormField {
  email,
  password,
  passwordConfirmation,
}

class SignUpError extends ValidationError {
  final String message;
  final FormField field;

  SignUpError(this.message, {required this.field});

  [@override](/user/override)
  String get errorDescription => message;
}

在这种情况下，方便的是能够按字段分组错误：

final validator = Verify.inOrder<SignUpFormState>([
  validateMail,
  validatePassword,
  validateConfirmation,
]);

final Map<FormField, SignUpError> errorMap = validator
    .verify<SignUpError>(someState)
    .errorsGroupedBy((error) => error.field);

示例代码

下面是一个完整的Flutter应用示例，展示了如何在实际项目中使用 verify 插件：

import 'package:flutter/material.dart';
import 'package:verify_example/pages/signup_page.dart';

void main() {
  WidgetsFlutterBinding.ensureInitialized();
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      home: SignUpPage(),
    );
  }
}

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

class _SignUpPageState extends State<SignUpPage> {
  final TextEditingController _emailController = TextEditingController();
  final TextEditingController _passwordController = TextEditingController();
  String _errorMessage = '';

  void _validateAndSubmit() {
    final email = _emailController.text;
    final password = _passwordController.text;

    final emailValidator = Verify.that(
      (String email) => email.contains('@'),
      error: 'Invalid email format',
    );

    final passwordValidator = Verify.that(
      (String password) => password.length >= 6,
      error: 'Password must be at least 6 characters long',
    );

    final combinedValidator = Verify.all([emailValidator, passwordValidator]);

    final result = combinedValidator.verify(email).merge(combinedValidator.verify(password));

    setState(() {
      if (result.isLeft()) {
        _errorMessage = result.fold((errors) => errors.join(', '), (_) => '');
      } else {
        _errorMessage = 'Success!';
      }
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Sign Up'),
      ),
      body: Padding(
        padding: const EdgeInsets.all(16.0),
        child: Column(
          children: <Widget>[
            TextField(
              controller: _emailController,
              decoration: InputDecoration(labelText: 'Email'),
            ),
            TextField(
              controller: _passwordController,
              decoration: InputDecoration(labelText: 'Password'),
              obscureText: true,
            ),
            SizedBox(height: 20),
            ElevatedButton(
              onPressed: _validateAndSubmit,
              child: Text('Sign Up'),
            ),
            SizedBox(height: 20),
            Text(_errorMessage, style: TextStyle(color: Colors.red)),
          ],
        ),
      ),
    );
  }
}