• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 异步并发 (Promise和async/await)
2<!--Kit: ArkTS-->
3<!--Subsystem: CommonLibrary-->
4<!--Owner: @wang_zhaoyong-->
5<!--Designer: @weng-changcheng-->
6<!--Tester: @kirl75; @zsw_zhushiwei-->
7<!--Adviser: @ge-yafang-->
8
9
10Promise和async/await是标准的JS异步语法，提供异步并发能力。异步代码执行时会被挂起，稍后继续执行，确保同一时间只有一段代码在运行。以下是典型的异步并发使用场景：
11
12- I/O 非阻塞操作：网络请求、文件读写、定时器等。
13
14- 任务轻量且无 CPU 阻塞：单次任务执行时间短。
15
16- 逻辑依赖清晰：任务有明确的顺序或并行关系。
17
18异步并发是一种编程语言的特性，允许程序在执行某些操作时不必等待其完成，可以继续执行其他异步代码。
19
20## Promise
21
22Promise是一种用于处理异步操作的对象，可将异步操作转换为类似同步操作的风格，便于代码编写和维护。Promise通过状态机制管理异步操作的不同阶段，有三种状态：pending（进行中）、fulfilled（已完成，也叫resolved）和rejected（已拒绝）。创建后处于pending状态，异步操作完成后转换为fulfilled或rejected状态。
23
24Promise提供了then、catch、finally方法来注册回调函数，以处理异步操作的成功或失败结果。当Promise状态改变时，回调函数会被加入微任务队列等待执行，依赖事件循环机制在宏任务执行完成后优先执行微任务，从而保证回调函数的异步调度。
25
26最基本的用法是通过构造函数实例化一个Promise对象，传入一个带有两个参数的函数，称为executor函数。executor函数接收两个参数：resolve和reject，分别表示异步操作成功和失败时的回调函数。
27例如，以下代码创建了一个Promise对象并模拟了一个异步操作：
28
29```ts
30const promise: Promise<number> = new Promise((resolve: Function, reject: Function) => {
31  setTimeout(() => {
32    const randomNumber: number = Math.random();
33    if (randomNumber > 0.5) {
34      resolve(randomNumber);
35    } else {
36      reject(new Error('Random number is too small'));
37    }
38  }, 1000);
39})
40```
41<!-- @[promise_async_operation](https://gitcode.com/openharmony/applications_app_samples/blob/master/code/DocsSample/ArkTS/ArkTsConcurrent/AsyncConcurrencyOverview/entry/src/main/ets/pages/Index.ets) -->
42
43在上述代码中，setTimeout函数模拟了一个异步操作，1秒后生成一个随机数。如果随机数大于0.5，调用resolve回调函数并传递该随机数；否则调用reject回调函数并传递一个错误对象。
44
45Promise对象创建后，可以使用then方法和catch方法指定fulfilled状态和rejected状态的回调函数。then方法可接受两个参数，一个处理fulfilled状态的函数，另一个处理rejected状态的函数。只传一个参数则表示当Promise对象状态变为fulfilled时，then方法会自动调用这个回调函数，并将Promise对象的结果作为参数传递给它。使用catch方法注册一个回调函数，用于处理“失败”的结果，即捕获Promise的状态改变为rejected状态或操作失败抛出的异常。Promise还可以使用finally注册回调函数，无论Promise最终状态如何（fulfilled或rejected），都会执行该回调函数。例如：
46
47```ts
48const promise: Promise<number> = new Promise((resolve: Function, reject: Function) => {
49  setTimeout(() => {
50    const randomNumber: number = Math.random();
51    if (randomNumber > 0.5) {
52      resolve(randomNumber);
53    } else {
54      reject(new Error('Random number is too small'));
55    }
56  }, 1000);
57})
58
59// 使用 then 方法定义成功和失败的回调
60promise.then((result: number) => {
61  console.info(`The number for success is ${result}`); // 成功时执行
62}, (error: Error) => {
63  console.error(error.message); // 失败时执行
64}
65);
66
67// 使用 then 方法定义成功的回调，catch 方法定义失败的回调
68promise.then((result: number) => {
69  console.info(`Random number is ${result}`); // 成功时执行
70}).catch((error: Error) => {
71  console.error(error.message); // 失败时执行
72});
73
74// 无论成功还是失败都会执行
75promise.finally(() => {
76  console.info('finally complete');
77})
78```
79<!-- @[promise_then_catch_handling](https://gitcode.com/openharmony/applications_app_samples/blob/master/code/DocsSample/ArkTS/ArkTsConcurrent/AsyncConcurrencyOverview/entry/src/main/ets/pages/Index.ets) -->
80
81在上述代码中，then方法的回调函数接收Promise对象的成功结果，并输出至控制台。如果Promise对象进入rejected状态，catch方法的回调函数接收错误对象，并输出至控制台。
82
83> **说明：**
84>
85> 当Promise被reject且未通过catch方法处理时，会触发globalUnhandledRejectionDetected事件。可使用[errorManager.on('globalUnhandledRejectionDetected')](../reference/apis-ability-kit/js-apis-app-ability-errorManager.md#errormanageronglobalunhandledrejectiondetected18)接口监听该事件，以全局捕获未处理的Promise reject。
86
87## async/await
88
89async/await是用于处理异步操作的Promise语法糖，使编写异步代码更加简单和易读。使用async关键字声明异步函数，并使用await关键字等待Promise的解析（fulfilled或rejected），以同步方式编写异步操作的代码。
90
91async函数返回Promise对象，实现异步操作。函数内部可包含零个或多个await关键字，await会暂停执行，直到关联的Promise完成状态转换（fulfilled或rejected）。若函数执行过程中抛出异常，该异常将直接触发返回的Promise进入rejected状态，错误对象可通过catch方法或then的第二个回调参数捕获。
92
93下面是一个使用async/await的示例，模拟同步方法执行异步操作的场景，3秒后返回一个字符串。
94
95```ts
96async function myAsyncFunction(): Promise<string> {
97  const result: string = await new Promise((resolve: Function) => {
98    setTimeout(() => {
99      resolve('Hello, world!');
100    }, 3000);
101  });
102  console.info(result); // 输出： Hello, world!
103  return result;
104}
105
106@Entry
107@Component
108struct Index {
109  @State message: string = 'Hello World';
110  build() {
111    Row() {
112      Column() {
113        Text(this.message)
114          .fontSize(50)
115          .fontWeight(FontWeight.Bold)
116          .onClick(async () => {
117            let res = await myAsyncFunction();
118            console.info('res is: ' + res);
119          })
120      }
121      .width('100%')
122    }
123    .height('100%')
124  }
125}
126```
127<!-- @[async_await_sync_operation](https://gitcode.com/openharmony/applications_app_samples/blob/master/code/DocsSample/ArkTS/ArkTsConcurrent/AsyncConcurrencyOverview/entry/src/main/ets/pages/Index.ets) -->
128
129在上述示例代码中，使用await等待Promise解析，并存储在result变量中。
130
131需要注意的是，等待异步操作时，需将操作包在async函数中，并搭配await使用，且await关键字只在async函数内有效。同时也可使用try/catch块来捕获异常。
132
133```ts
134async function myAsyncFunction(): Promise<void> {
135  try {
136    const result: string = await new Promise((resolve: Function) => {
137      resolve('Hello, world!');
138    });
139    console.info(result); // 输出： Hello, world!
140  } catch (e) {
141    console.error(`Get exception: ${e}`);
142  }
143}
144
145myAsyncFunction();
146```
147<!-- @[async_operation_error_handling_with_try_catch](https://gitcode.com/openharmony/applications_app_samples/blob/master/code/DocsSample/ArkTS/ArkTsConcurrent/AsyncConcurrencyOverview/entry/src/main/ets/pages/Index.ets) -->
148