Flutter功能未知插件must_be的使用

Flutter 功能未知插件 must_be 的使用

是的，你没有看错，这是另一个验证包。

但是它更符合 Dart 的习惯用法，例如，使用级联语法进行值验证。

这类似于一个在测试中检查值的框架。

requireThat('value')..mustBeGreaterThan(6)..mustBeLessThanOrEqualTo(10)

目前包含常见的验证和巴西的数据验证（如：RG、CPF、CNH、CEP 等）。

在数据中设置约束

对一个值进行验证。

requireThat('teste@gmail.com').mustBeEmail()

你可以设置验证字段名。

requireThat('teste@gmail.com', name: 'email').mustBeEmail()

但如果日期违反了限制会发生什么？ 会抛出一个带有违反约束的消息的 异常，如果存在字段名，则消息中也会包含该字段名。

requireThat('teste@gmail.com').mustBeEmail('error')

如果我想定义更多的约束呢？

这个 Dart 方面由我们来处理，所以让我们使用级联操作符语法。

requireThat('value')..mustBeGreaterThan(6)..mustBeLessThanOrEqualTo(10)

这真是太棒了。

创建你的约束

这里再次由 Dart 来帮助我们使用扩展方法。

首先，创建一个 Constraint 子类，例如：

class SameDay extends Constraint {
  const SameDay(this.date, [String? message]) : super(message);

  final DateTime date;
}

现在，为要验证的数据类型创建一个 Require 扩展，并调用你想要的方法（模式为 mustBe...），并在其中调用 mustBe 方法。

extension RequireString<T extends String> on Require<T?> {
  /// 验证 [String] 是否为空。
  void mustBeBlank([String? message]) =>
      mustBe(value?.trimLeft().isEmpty ?? true, Blank(message));
}

在 Require 中，你可以访问值和字段名（value 和 name）。

如何验证？

当一个约束被违反时，会抛出一个 异常，然后有一个支持函数可以捕获这个异常并返回其消息。如果没有违反约束，则返回 null。

validate(
    () => requireThat(10).mustBeGreaterThan(10),
    ifNotValid: (_) => 'error',
) // 输出 -> 'error'

你还可以对每个违反的约束执行任何操作。

validate(
    () => requireThat(10)..mustBeGreaterThan(10)..mustBeLessThan(100),
     ifNotValid: (constraint) => switch (constraint.constraintViolation) {
        GreaterThanOrEqualTo(min: final min) =>
          'name must have at least $min characters',
        LessThan(max: final max) => 'name must be up to $max characters',
        _ => null,
    },),
)

你也可以使用 try/catch。

对于自定义消息，请参阅下方的自定义错误消息部分。

它非常适合用于 TextFormFields 的验证。

TextFormField(
    validator: (value) => validate(
        () => requireThat(value, name: 'nick')
            ..mustBeGreaterThanOrEqualTo(3)
            ..mustBeLessThan(10),
    ),
    decoration: const InputDecoration(
        labelText: 'Nickname',
        border: OutlineInputBorder(),
    ),
),

自定义错误消息

如果你想在调用 validate 函数时更改默认的约束消息，可以使用 ValidationsLocalization。

void main() {
    ValidationsLocalization.on<Email>((constraint) => '自定义消息 - ${constraintException.name}-${constraintException.value}');
}

这不会翻译或更改约束异常消息，为此请这样做：

requireThat('value').mustBeGreaterThan(5, '自定义消息');

在 validate 函数中有 ifNotValid 函数，然后传递你想要的消息，根据违反的约束。

validate
    () => requireThat(10).mustBeGreaterThan(0),
    ifNotValid: (constraint) => constraint.when({
        isType<LessThan>(): (_) => 'less',
        isType<GreaterThan>(): (_) => 'greater',
    }),
)

测试

有一个新的 matcher 用于抛出 ConstraintException：

expect(
    () => requireThat(2, name: 'number').mustBeGreaterThan(2),
    throwsConstraintException<GreaterThan>(
        constraintMessage: '必须大于 2',
        name: 'number',
        value: 2,
    ),
);

维护者

Kauê Martins

支持

如果你喜欢这个包，请给它一个 ⭐️。如果你想帮忙，请：

• Fork 这个仓库
• 发送带有新功能的 Pull Request
• 分享这个包
• 如果你发现一个错误或想建议一个新的扩展，请创建一个 issue

Pull Request 标题遵循 Conventional Commits。

许可证

版权所有 © 2023 Kauê Martins。
该项目遵循 MIT 许可证。

完整示例 Demo

以下是完整的示例代码：

import 'dart:io';

import 'package:must_be/must_be.dart';

void main() {
  ValidationsLocalization.on<Blank>(
    (_) => '错误，没有正确答案',
  );

  while (true) {
    stdout.writeln("你的名字是什么？");
    final name = stdin.readLineSync();
    final msg = validate(
      () => requireThat(name)
        ..mustBeGreaterThanOrEqualTo(3)
        ..mustBeLessThanOrEqualTo(10),
      ifNotValid: (constraint) => switch (constraint.constraintViolation) {
        GreaterThanOrEqualTo(min: final min) =>
          '名字必须至少有 $min 个字符',
        LessThan(max: final max) => '名字最多只能有 $max 个字符',
        _ => null,
      },
    );
    if (msg == null) {
      break;
    }
    stdout.writeln(msg);
  }

  while (true) {
    stdout.writeln('你多大了？');
    final age = int.parse(stdin.readLineSync() ?? '0');
    try {
      requireThat(age, name: '年龄').mustBeGreaterThanOrEqualTo(
        18,
        '你还年轻，至少需要满 18 岁',
      );
      break;
    } on ConstraintException catch (exception) {
      stdout.writeln(exception.constraintViolation.message);
    }
  }

  stdout.writeln("最好的状态管理器是什么？");
  final stateManager = stdin.readLineSync();
  final notCorrectAnswer =
      validate(() => requireThat(stateManager).mustBeBlank());
  stdout.writeln(notCorrectAnswer ?? '好极了！');
}