异步编程：Stream

目录 keyboard_arrow_down keyboard_arrow_up

接收 Stream 事件
错误事件
使用 Stream
两种 Stream
- 单订阅 Stream
- 广播 Stream
处理 Stream 的方法
修改 Stream 的方法
- transform() 函数
- 读取和解码文件
listen() 方法
其他资源

more_horiz

Dart 中的异步编程以 Future 和 Stream 类为特征。

Future 表示一个不会立即完成的计算。普通函数返回结果，而异步函数返回一个 Future，它最终将包含结果。Future 会告诉你结果何时准备就绪。

Stream 是一系列异步事件。它就像一个异步的 Iterable——不是在你请求时获取下一个事件，而是 Stream 在事件准备就绪时告诉你有一个事件。

Stream 可以通过多种方式创建，这是另一篇文章的主题，但它们都可以以相同的方式使用：异步 for 循环（通常简称为 await for）迭代 Stream 的事件，就像 for 循环迭代 Iterable 一样。例如

dartFuture<int> sumStream(Stream<int> stream) async {
  var sum = 0;
  await for (final value in stream) {
    sum += value;
  }
  return sum;
}

这段代码只是接收整数事件 Stream 的每个事件，将它们加起来，并返回（Future 类型的）总和。当循环体结束时，函数会暂停，直到下一个事件到达或 Stream 完成。

该函数用 async 关键字标记，这是在使用 await for 循环时必需的。

以下示例通过使用 async* 函数生成一个简单的整数 Stream 来测试之前的代码

Future<int> sumStream(Stream<int> stream) async {
  var sum = 0;
  await for (final value in stream) {
    sum += value;
  }
  return sum;
}

Stream<int> countStream(int to) async* {
  for (int i = 1; i <= to; i++) {
    yield i;
  }
}

void main() async {
  var stream = countStream(10);
  var sum = await sumStream(stream);
  print(sum); // 55
}

当 Stream 中没有更多事件时，Stream 就完成了，接收事件的代码会收到此通知，就像收到新事件到达的通知一样。当使用 await for 循环读取事件时，当 Stream 完成时，循环停止。

在某些情况下，错误会在 Stream 完成之前发生；可能是从远程服务器获取文件时网络失败，或者创建事件的代码存在错误，但需要有人知道。

Stream 也可以像传递数据事件一样传递错误事件。大多数 Stream 会在第一个错误后停止，但有可能存在传递多个错误的 Stream，以及在错误事件之后传递更多数据的 Stream。在本文档中，我们只讨论最多传递一个错误的 Stream。

当使用 await for 读取 Stream 时，错误由循环语句抛出。这也结束了循环。你可以使用 try-catch 捕获错误。以下示例在循环迭代器等于 4 时抛出错误

Future<int> sumStream(Stream<int> stream) async {
  var sum = 0;
  try {
    await for (final value in stream) {
      sum += value;
    }
  } catch (e) {
    return -1;
  }
  return sum;
}

Stream<int> countStream(int to) async* {
  for (int i = 1; i <= to; i++) {
    if (i == 4) {
      throw Exception('Intentional exception');
    } else {
      yield i;
    }
  }
}

void main() async {
  var stream = countStream(10);
  var sum = await sumStream(stream);
  print(sum); // -1
}

Stream 类包含许多辅助方法，可以为你对 Stream 执行常见操作，类似于 Iterable 上的方法。例如，你可以使用 Stream API 中的 lastWhere() 在 Stream 中找到最后一个正整数。

dartFuture<int> lastPositive(Stream<int> stream) =>
    stream.lastWhere((x) => x >= 0);

Stream 有两种类型。

最常见的 Stream 类型包含一系列事件，这些事件是更大的整体的一部分。事件需要按正确的顺序传递，并且不能遗漏任何一个。这是你在读取文件或接收 Web 请求时获得的 Stream 类型。

这种 Stream 只能被监听一次。稍后再次监听可能意味着错过初始事件，然后 Stream 的其余部分就没有意义了。当你开始监听时，数据将被获取并分块提供。

另一种 Stream 类型用于可以一次处理一条的单个消息。例如，这种 Stream 可以用于浏览器中的鼠标事件。

你可以随时开始监听这种 Stream，并且你会获得在监听时触发的事件。多个监听器可以同时监听，你可以在取消之前的订阅后再次监听。

Stream<T> 上的以下方法处理 Stream 并返回结果

dartFuture<T> get first;
Future<bool> get isEmpty;
Future<T> get last;
Future<int> get length;
Future<T> get single;
Future<bool> any(bool Function(T element) test);
Future<bool> contains(Object? needle);
Future<E> drain<E>([E? futureValue]);
Future<T> elementAt(int index);
Future<bool> every(bool Function(T element) test);
Future<T> firstWhere(bool Function(T element) test, {T Function()? orElse});
Future<S> fold<S>(S initialValue, S Function(S previous, T element) combine);
Future forEach(void Function(T element) action);
Future<String> join([String separator = '']);
Future<T> lastWhere(bool Function(T element) test, {T Function()? orElse});
Future pipe(StreamConsumer<T> streamConsumer);
Future<T> reduce(T Function(T previous, T element) combine);
Future<T> singleWhere(bool Function(T element) test, {T Function()? orElse});
Future<List<T>> toList();
Future<Set<T>> toSet();

除了 drain() 和 pipe() 之外，所有这些函数都对应于 Iterable 上的类似函数。每个函数都可以通过使用带有 await for 循环的 async 函数（或仅使用其他方法之一）轻松编写。例如，一些实现可能是

dartFuture<bool> contains(Object? needle) async {
  await for (final event in this) {
    if (event == needle) return true;
  }
  return false;
}

Future forEach(void Function(T element) action) async {
  await for (final event in this) {
    action(event);
  }
}

Future<List<T>> toList() async {
  final result = <T>[];
  await forEach(result.add);
  return result;
}

Future<String> join([String separator = '']) async =>
    (await toList()).join(separator);

（实际实现稍微复杂一些，但主要是出于历史原因。）

Stream 上的以下方法基于原始 Stream 返回一个新的 Stream。每个方法都会等到有人监听新的 Stream 后才监听原始 Stream。

dartStream<R> cast<R>();
Stream<S> expand<S>(Iterable<S> Function(T element) convert);
Stream<S> map<S>(S Function(T event) convert);
Stream<T> skip(int count);
Stream<T> skipWhile(bool Function(T element) test);
Stream<T> take(int count);
Stream<T> takeWhile(bool Function(T element) test);
Stream<T> where(bool Function(T event) test);

前面的方法对应于 Iterable 上将可迭代对象转换为另一个可迭代对象的类似方法。所有这些都可以使用带有 await for 循环的 async 函数轻松编写。

dartStream<E> asyncExpand<E>(Stream<E>? Function(T event) convert);
Stream<E> asyncMap<E>(FutureOr<E> Function(T event) convert);
Stream<T> distinct([bool Function(T previous, T next)? equals]);

asyncExpand() 和 asyncMap() 函数类似于 expand() 和 map()，但允许它们的函数参数是异步函数。distinct() 函数在 Iterable 上不存在，但本可以存在。

dartStream<T> handleError(Function onError, {bool Function(dynamic error)? test});
Stream<T> timeout(
  Duration timeLimit, {
  void Function(EventSink<T> sink)? onTimeout,
});
Stream<S> transform<S>(StreamTransformer<T, S> streamTransformer);

最后三个函数更特殊。它们涉及错误处理，而 await for 循环无法做到这一点——到达循环的第一个错误将结束循环及其对 Stream 的订阅。无法从中恢复。以下代码展示了如何使用 handleError() 在 await for 循环中使用 Stream 之前从中删除错误。

dartStream<S> mapLogErrors<S, T>(
  Stream<T> stream,
  S Function(T event) convert,
) async* {
  var streamWithoutErrors = stream.handleError((e) => log(e));
  await for (final event in streamWithoutErrors) {
    yield convert(event);
  }
}

transform() 函数不仅用于错误处理；它是一个更通用的 Stream“映射”。普通的 map 对每个传入事件都需要一个值。但是，特别是对于 I/O Stream，可能需要多个传入事件才能生成一个输出事件。StreamTransformer 可以处理这种情况。例如，像 Utf8Decoder 这样的解码器就是转换器。转换器只需要一个函数 bind()，它可以通过 async 函数轻松实现。

以下代码读取一个文件并在 Stream 上运行两个转换。它首先将数据从 UTF8 转换，然后通过 LineSplitter 运行它。打印所有行，除了任何以井号“#”开头的行。

dartimport 'dart:convert';
import 'dart:io';

void main(List<String> args) async {
  var file = File(args[0]);
  var lines = utf8.decoder
      .bind(file.openRead())
      .transform(const LineSplitter());
  await for (final line in lines) {
    if (!line.startsWith('#')) print(line);
  }
}

Stream 上的最后一个方法是 listen()。这是一个“底层”方法——所有其他 Stream 函数都根据 listen() 定义。

dartStreamSubscription<T> listen(
  void Function(T event)? onData, {
  Function? onError,
  void Function()? onDone,
  bool? cancelOnError,
});

要创建新的 Stream 类型，你只需扩展 Stream 类并实现 listen() 方法——Stream 上的所有其他方法都调用 listen() 才能工作。

listen() 方法允许你开始监听 Stream。在你这样做之前，Stream 只是一个惰性对象，描述了你想看到的事件。当你监听时，会返回一个 StreamSubscription 对象，它表示生成事件的活动 Stream。这类似于 Iterable 只是对象的集合，但迭代器是执行实际迭代的对象。

Stream 订阅允许你暂停订阅、在暂停后恢复订阅以及完全取消订阅。你可以设置回调函数，以便在每个数据事件或错误事件以及 Stream 关闭时调用。

阅读以下文档，详细了解如何在 Dart 中使用 Stream 和异步编程。

创建 Dart Stream，一篇关于创建你自己的 Stream 的文章
Future 和错误处理，一篇解释如何使用 Future API 处理错误的文章
异步支持，语言之旅中的一个章节
Stream API 参考

除非另有说明，否则本网站上的文档反映的是 Dart 3.7.1 版本。页面上次更新于 2025-02-13。查看源代码或报告问题。

异步编程：Stream

接收 Stream 事件

错误事件

使用 Stream

两种 Stream

单订阅 Stream

广播 Stream

处理 Stream 的方法

修改 Stream 的方法

transform() 函数

读取和解码文件

listen() 方法

其他资源