目录

Dart 库中充满了返回 FutureStream 对象的函数。这些函数是异步的:它们在设置可能耗时的操作(例如 I/O)后返回,而无需等待该操作完成。

asyncawait 关键字支持异步编程,让你可以编写看起来类似于同步代码的异步代码。

处理 Future

#

当你需要已完成 Future 的结果时,你有两个选择

使用 asyncawait 的代码是异步的,但它看起来很像同步代码。例如,这里有一些代码使用 await 来等待异步函数的结果

dart
await lookUpVersion();

要使用 await,代码必须位于 async 函数中,即标记为 async 的函数

dart
Future<void> checkVersion() async {
  var version = await lookUpVersion();
  // Do something with version
}

使用 trycatchfinally 来处理使用 await 的代码中的错误和清理

dart
try {
  version = await lookUpVersion();
} catch (e) {
  // React to inability to look up the version
}

你可以在 async 函数中多次使用 await。例如,以下代码等待函数的结果三次

dart
var entrypoint = await findEntryPoint();
var exitCode = await runExecutable(entrypoint, args);
await flushThenExit(exitCode);

await expression 中,expression 的值通常是 Future;如果不是,则该值会自动包装在 Future 中。此 Future 对象表示返回对象的承诺。await expression 的值是返回的对象。await 表达式会使执行暂停,直到该对象可用。

如果你在使用 await 时收到编译时错误,请确保 await 位于 async 函数中。例如,要在应用的 main() 函数中使用 awaitmain() 的主体必须标记为 async

dart
void main() async {
  checkVersion();
  print('In main: version is ${await lookUpVersion()}');
}

有关使用 future、asyncawait 的交互式介绍,请参阅 异步编程代码实验室

声明 async 函数

#

async 函数是其主体用 async 修饰符标记的函数。

向函数添加 async 关键字会使其返回一个 Future。例如,考虑这个返回字符串的同步函数

dart
String lookUpVersion() => '1.0.0';

如果你将其更改为 async 函数(例如,因为未来的实现将非常耗时),返回的值将是 Future

dart
Future<String> lookUpVersion() async => '1.0.0';

请注意,函数主体不需要使用 Future API。Dart 会在必要时创建 Future 对象。如果你的函数不返回有用的值,请将其返回类型设为 Future<void>

有关使用 future、asyncawait 的交互式介绍,请参阅 异步编程代码实验室

处理 Stream

#

当你需要从 Stream 获取值时,你有两个选择

  • 使用 async 和一个异步 for 循环await for)。
  • 使用 Stream API,如 dart:async 文档 中所述。

异步 for 循环具有以下形式

dart
await for (varOrType identifier in expression) {
  // Executes each time the stream emits a value.
}

expression 的值必须为 Stream 类型。执行过程如下

  1. 等待流发出一个值。
  2. 执行 for 循环的主体,并将变量设置为该发出的值。
  3. 重复 1 和 2,直到流关闭。

要停止侦听流,可以使用 breakreturn 语句,这会跳出 for 循环并取消订阅流。

如果你在实现异步 for 循环时遇到编译时错误,请确保 await for 位于 async 函数中。例如,要在应用的 main() 函数中使用异步 for 循环,main() 的主体必须标记为 async

dart
void main() async {
  // ...
  await for (final request in requestServer) {
    handleRequest(request);
  }
  // ...
}

有关 Dart 异步编程支持的更多信息,请查看 dart:async 库文档。