Flutter数据验证插件none_or的使用

Flutter数据验证插件none_or的使用

提供了新的类 (None<T>)，该类伪装为一个 Future<T> 以利用 Dart 中唯一可用的联合类型 FutureOr<T>。你可以通过这种方式区分显式 null 值和默认的 None<T> 值。

不幸的是，Dart 语言缺乏真正的联合类型，并且不允许扩展 FutureOr<T> 的功能。因此，此包采用了一些变通方法，使用 NoneOr<T>? 类型别名作为可能为 T、null 或 None（这是一个新类，实现 Future 但完全不打算像 future 那样行为）的参数。

赞助

特别感谢我们的赞助商 Scrapp Inc 支持本包的开发！

功能

该包引入了一个新的类 None<T>，它是 Future<T> 的有效实现，可以替代 FutureOr<T> 类型的参数或变量。None 类型包括一个静态方法 fallback，可以从主要字段返回 T?，当主要字段是 T? 或为 null 时。然而，如果主要字段是 None<T> 或 Future<T>，它可以返回可选的 fallback 参数。

开始使用

在你的 pubspec.yaml 文件中添加该包：

dependencies:
  none_or: latest

导入该包：

import 'package:none_or/none_or.dart';

以下是使用示例。

使用示例

该包预期的用途是在允许区分显式 null 值和省略的值方面。以下示例展示了如何使用 NoneOr<T> 来提升具有可空字段的类的 copyWith 函数：

import 'package:none_or/none_or.dart';
import 'package:flutter/foundation.dart';

/// 一个简单的不可变类，包含一个使用 NoneOr<T> 的 copyWith 函数，
/// 可以忽略传递给 copyWith 的隐式无变化值，同时尊重显式提供的值，包括 `null`
[@immutable](/user/immutable)
class _NoneOrExampleClass {
  final bool nonNullableField;
  final bool? nullableField;

  const _NoneOrExampleClass({
    required this.nonNullableField,
    this.nullableField,
  });

  [@override](/user/override)
  String toString() => 'Example($nonNullableField, $nullableField)';

  /// 创建 [this] 的副本，用给定的字段更改
  _NoneOrExampleClass copyWith({
    bool? nonNullableField,
    NoneOr<bool>? nullableField = const None(),
  }) =>
      _NoneOrExampleClass(
        nonNullableField: nonNullableField ?? this.nonNullableField,
        nullableField: None.fallback(nullableField, this.nullableField),
      );

  /// 创建 [this] 的副本，用给定的字段更改
  _NoneOrExampleClass copyWithAlt({
    NoneOr<bool> nonNullableField = const None(),
    NoneOr<bool>? nullableField = const None(),
  }) =>
      _NoneOrExampleClass(
        nonNullableField: None.fallback(nonNullableField, this.nonNullableField),
        nullableField: None.fallback(nullableField, this.nullableField),
      );

  _NoneOrExampleClass copyWithAlt2({
    NoneOr<bool> nonNullableField = const None(),
    // 注意 NoneOr<bool?> 实际上与 NoneOr<bool>? 或 NoneOr<bool?>? 相同 - 使用你觉得最合适的语法。
    // 在未来，我们可能会引入自定义的 linter 规则来决定在哪里放置 "?" 字符
    NoneOr<bool?>? nullableField = const None(),
  }) =>
      _NoneOrExampleClass(
        nonNullableField: None.fallback(nonNullableField, this.nonNullableField),
        nullableField: None.fallback(nullableField, this.nullableField),
      );
}

// 示例使用

void _exampleUsage() {
  // 基线
  _NoneOrExampleClass e0 = _NoneOrExampleClass(
    nonNullableField: true,
    nullableField: true,
  ); // Example(true, true)

  // 使用 copyWith 进行复制：

  // 对于非可空基础字段的简单示例：

  // 1. 如果字段被省略，则假定为 null，并保持现有值（true）
  _NoneOrExampleClass s1 = e0.copyWith(); // Example(true, true)
  // 2. 如果字段标记为 null，则现有值保持不变（true）
  _NoneOrExampleClass s2 = e0.copyWith(nonNullableField: null); // Example(true, true)
  // 3. 如果字段提供了一个值，则覆盖现有值（false）
  _NoneOrExampleClass s3 = e0.copyWith(nonNullableField: false); // Example(false, true)

  // 对于可空基础字段的简单示例：
  
  // 1. 如果字段被省略，则假定为 None()，并保持现有值（true）
  _NoneOrExampleClass s1 = e0.copyWith(); // Example(true, true)
  // 2. 如果字段标记为 null，则现有值被覆盖为 null（null）
  _NoneOrExampleClass s2 = e0.copyWith(nullableField: null); // Example(true, null)
  // 3. 如果字段提供了一个值，则覆盖现有值（false）
  _NoneOrExampleClass s3 = e0.copyWith(nullableField: false); // Example(true, false)
}