Flutter 类型联合插件 extension_type_unions 的使用

简介

Dart 社区自 2012 年起就一直在请求支持联合类型（union types）。extension_type_unions 插件提供了一个基本的支持，允许在 Dart 中使用联合类型。尽管该插件并不支持新的语法来定义联合类型，但它通过扩展类型的方式实现了对联合类型的基本支持。

联合类型的含义

联合类型是由多个其他类型组合而成的一种类型。例如，可以将 int | String 视为由 int 和 String 组成的联合类型。这意味着任何具有 int 或 String 类型的对象都属于 int | String 类型。

需要注意的是，此插件提供的联合类型是无标签的（untagged），即没有运行时实体跟踪值的实际类型。因此，如果有一个类型为 Object | num 的表达式，并且其运行时类型为 int，则无法确定它被视为该联合类型是因为它是 num 还是因为它是 Object。

使用示例

基本用法

以下是一个简单的示例，展示了如何使用 Union2<int, String>：

import 'package:extension_type_unions/extension_type_unions.dart';

int f(Union2<int, String> x) => x.split(
      (i) => i + 1,
      (s) => s.length,
    );

void main() {
  print(f(1.u21)); // 输出 '2'
  print(f('Hello'.u22)); // 输出 '5'
}

在这个例子中，函数 f 接受一个联合类型 Union2<int, String> 的参数，并根据实际传入的类型执行不同的操作：如果是 int 类型，则加 1；如果是 String 类型，则返回字符串的长度。

使用 splitNamed 方法

除了 split 方法外，还可以使用 splitNamed 方法，它允许处理部分情况并返回 null：

int? doSplitNamedOther(Union2<int, String> u) => u.splitNamed(
      on2: (s) => s.length,
      onOther: (_) => 42,
    );

void main() {
  print(doSplitNamedOther(10.u21)); // 输出 '42'
}

处理无效的联合类型

虽然可以通过显式类型转换引入无效的联合类型值，但可以使用 splitNamed 方法中的 onInvalid 回调来处理这种情况：

var u = true as Union2<int, String>; // 不推荐，但不会报错
print(doSplitNamedInvalid(u)); // 输出 '-1'

完整的示例 Demo

以下是一个完整的示例代码，演示了如何使用 extension_type_unions 插件：

import 'package:extension_type_unions/extension_type_unions.dart';

// 使用 `split` 方法进行类型区分
int doSplit(Union2<int, String> u) => u.split(
      (i) => i,
      (s) => s.length,
    );

// 使用 `splitNamed` 方法处理子集情况，允许返回 null
int? doSplitNamed(Union2<int, String> u) => u.splitNamed(
      on1: (i) => i,
      on2: (s) => s.length,
    );

int? doSplitNamedOther(Union2<int, String> u) => u.splitNamed(
      on2: (s) => s.length,
      onOther: (_) => 42,
    );

int? doSplitNamedInvalid(Union2<int, String> u) => u.splitNamed(
      onInvalid: (_) => -1,
    );

void main() {
  // 使用构造函数创建联合类型值
  print(doSplit(Union2.in1(10))); // 输出 '10'
  print(doSplit(Union2.in2('ab'))); // 输出 '2'

  // 使用扩展方法 `uNK` 创建联合类型值
  print(doSplit(10.u21)); // 输出 '10'
  print(doSplit('ab'.u22)); // 输出 '2'
  print(doSplitNamed(10.u21)); // 输出 '10'
  print(doSplitNamed('ab'.u22)); // 输出 '2'
  print(doSplitNamedOther(10.u21)); // 输出 '42'

  // 编译时错误：类型不匹配
  // Union2<int, String> u1 = Union2.in1(true); // 错误
  // Union2<int, String> u2 = Union2.in2(true); // 错误
  // Union2<int, String> u3 = true.u21; // 错误
  // Union2<int, String> u4 = true.u22; // 错误

  // 强制类型转换可能会引入无效的联合类型值
  var u = true as Union2<int, String>; // 不推荐，但不会报错
  print(doSplitNamedInvalid(u)); // 输出 '-1'
  print(u.isValid); // 输出 'false'
  // doSplit(u); // 抛出异常
}

这个示例展示了如何使用 extension_type_unions 插件创建和处理联合类型值，并提供了多种处理不同类型情况的方法。