• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 使用JSVM-API接口处理异步操作
2
3## 简介
4
5使用JSVM-API接口处理异步操作。异步操作是指需要一定时间才能完成的操作，例如从网络下载数据或读取大型文件。与同步操作不同，异步操作不会阻塞主线程，而是会在后台执行。当异步操作完成后，事件循环将把它放入任务队列中，等待主线程空闲时执行。
6
7## 基本概念
8
9Promise是JavaScript中用来处理异步操作的对象，Promise有pending（待定）、fulfilled（已兑现）和rejected（已拒绝）三种状态，Promise的初始状态是pending，resolve函数可以使其状态从pending变为fulfilled（已兑现），reject函数可以使其状态从pending变为rejected(已拒绝)，一旦兑现或拒绝Promise的状态将不能更改。下面是一些基本概念：
10
11- **同步**： 同步是指代码按照顺序一行一行地执行，每行代码的执行都会等待上一行代码执行完成后再继续执行。在同步执行中，如果某个操作需要花费较长时间，那么整个程序的执行就会被阻塞，直到该操作完成才能继续执行后续代码。
12- **异步**：异步是指任务可以同时执行，不需要等待上一个任务结束。在JavaScript中，常见的异步操作包括定时器、事件监听、网络请求等。异步任务不会阻塞后续任务的执行，而是通过回调函数或Promise对象来处理任务的结果。
13- **Promise**：Promise是一个JavaScript对象，用于处理异步操作。Promise作用于外部，通常通过then、catch和finally方法暴露给外部以添加自定义逻辑。
14- **deferred**：deferred是延迟对象，它可以与Promise对象关联，设置Promise的回调函数resolve和reject。deferred作用于内部，维护异步模型的状态并设置回调函数resolve和reject。
15- **resolve**：此函数可以将Promise的状态从pending（待定）改为fulfilled（已兑现），向resolve中传入的参数可以在Promise对象的then方法中获取。
16- **reject**：此函数可以将Promise的状态从pending（待定）改为rejected（已拒绝），向reject中传入的参数可以在Promise对象的catch方法中获取。
17
18这些基本概念在处理异步操作中非常重要，开发者需要通过适当的方法来处理异步操作，Promise可以链式调用多个异步操作，使代码清晰整洁，便于维护。JSVM-API提供的方法可以帮助开发者在JSVM模块中处理JavaScript中的异步操作。
19
20## 接口说明
21
22| 接口                       | 功能说明                       |
23|----------------------------|--------------------------------|
24| OH_JSVM_IsPromise            | 查询Promise是否为Promise对象|
25| OH_JSVM_CreatePromise        | 创建一个延迟对象和一个JavaScript promise|
26| OH_JSVM_ResolveDeferred      | 通过与之关联的延迟对象来解析JavaScript promise|
27| OH_JSVM_RejectDeferred       | 通过与之关联的延迟对象来拒绝JavaScript Promise|
28| OH_JSVM_PromiseRegisterHandler | 为 Promise 创建兑现或拒绝后的回调 |
29
30## 使用示例
31
32JSVM-API接口开发流程参考[使用JSVM-API实现JS与C/C++语言交互开发流程](use-jsvm-process.md)，本文仅对接口对应C++相关代码进行展示。
33
34### OH_JSVM_IsPromise
35
36判断给定的JSVM_Value是否表示一个Promise对象。
37
38cpp部分代码
39
40```cpp
41// hello.cpp
42#include "napi/native_api.h"
43#include "ark_runtime/jsvm.h"
44#include <hilog/log.h>
45// OH_JSVM_IsPromise的样例方法
46static JSVM_Value IsPromise(JSVM_Env env, JSVM_CallbackInfo info)
47{
48    size_t argc = 1;
49    JSVM_Value args[1] = {nullptr};
50    OH_JSVM_GetCbInfo(env, info, &argc, args, nullptr, nullptr);
51    bool isPromise = false;
52    JSVM_Status status = OH_JSVM_IsPromise(env, args[0], &isPromise);
53    if (status != JSVM_OK) {
54        OH_LOG_ERROR(LOG_APP, "JSVM OH_JSVM_IsPromise fail");
55    } else {
56        OH_LOG_INFO(LOG_APP, "JSVM OH_JSVM_IsPromise success:%{public}d", isPromise);
57    }
58    JSVM_Value result = nullptr;
59    OH_JSVM_GetBoolean(env, isPromise, &result);
60    return result;
61}
62// IsPromise注册回调
63static JSVM_CallbackStruct param[] = {
64    {.data = nullptr, .callback = IsPromise},
65};
66static JSVM_CallbackStruct *method = param;
67// IsPromise方法别名，供JS调用
68static JSVM_PropertyDescriptor descriptor[] = {
69    {"isPromise", nullptr, method++, nullptr, nullptr, nullptr, JSVM_DEFAULT},
70};
71
72// 样例测试js
73const char *srcCallNative = R"JS(isPromise())JS";
74```
75
76预期结果
77```
78JSVM OH_JSVM_IsPromise success:0
79```
80
81### OH_JSVM_CreatePromise
82
83OH_JSVM_CreatePromise用于创建一个Promise对象。
84
85### OH_JSVM_ResolveDeferred & OH_JSVM_RejectDeferred
86
87用于对Promise关联的deferred对象进行解析，OH_JSVM_ResolveDeferred将其从挂起状态转换为已兑现状态，OH_JSVM_RejectDeferred将其从挂起状态转换为已拒绝状态。
88
89cpp部分代码
90
91```cpp
92// hello.cpp
93#include "napi/native_api.h"
94#include "ark_runtime/jsvm.h"
95#include <hilog/log.h>
96// OH_JSVM_CreatePromise、OH_JSVM_ResolveDeferred、OH_JSVM_RejectDeferred的样例方法
97static JSVM_Value CreatePromise(JSVM_Env env, JSVM_CallbackInfo info)
98{
99    JSVM_Deferred defer = nullptr;
100    JSVM_Value promise = nullptr;
101    JSVM_Status status = OH_JSVM_CreatePromise(env, &defer, &promise);
102    bool isPromise = false;
103    JSVM_Value returnIsPromise = nullptr;
104    OH_JSVM_IsPromise(env, promise, &isPromise);
105    if (status != JSVM_OK) {
106        OH_LOG_ERROR(LOG_APP, "JSVM CreatePromise fail");
107    } else {
108        OH_LOG_INFO(LOG_APP, "JSVM CreatePromise success:%{public}d", isPromise);
109    }
110    // 将布尔值转为可以返回的JSVM_Value
111    OH_JSVM_GetBoolean(env, isPromise, &returnIsPromise);
112    return returnIsPromise;
113}
114
115static JSVM_Value ResolveRejectDeferred(JSVM_Env env, JSVM_CallbackInfo info)
116{
117    // 获得并解析参数
118    size_t argc = 3;
119    JSVM_Value args[3] = {nullptr};
120    OH_JSVM_GetCbInfo(env, info, &argc, args, nullptr, nullptr);
121    // 第一个参数为向resolve传入的信息，第二个参数为向reject传入的信息，第三个参数为Promise的状态
122    bool status = false;
123    OH_JSVM_GetValueBool(env, args[2], &status);
124    // 创建Promise对象
125    JSVM_Deferred deferred = nullptr;
126    JSVM_Value promise = nullptr;
127    JSVM_Status createStatus = OH_JSVM_CreatePromise(env, &deferred, &promise);
128    if (createStatus != JSVM_OK) {
129        OH_JSVM_ThrowError(env, nullptr, "Create promise failed");
130        return nullptr;
131    }
132    // 根据第三个参数设置resolve或reject
133    if (status) {
134        OH_JSVM_ResolveDeferred(env, deferred, args[0]);
135        OH_LOG_INFO(LOG_APP, "OH_JSVM_ResolveDeferred resolve");
136    } else {
137        OH_JSVM_RejectDeferred(env, deferred, args[1]);
138        OH_LOG_INFO(LOG_APP, "OH_JSVM_RejectDeferred reject");
139    }
140    JSVM_Value result = nullptr;
141    OH_JSVM_GetBoolean(env, true, &result);
142    return result;
143}
144// CreatePromise,ResolveRejectDeferred注册回调
145static JSVM_CallbackStruct param[] = {
146    {.data = nullptr, .callback = CreatePromise},
147    {.data = nullptr, .callback = ResolveRejectDeferred},
148};
149static JSVM_CallbackStruct *method = param;
150// CreatePromise,ResolveRejectDeferred方法别名，供JS调用
151static JSVM_PropertyDescriptor descriptor[] = {
152    {"createPromise", nullptr, method++, nullptr, nullptr, nullptr, JSVM_DEFAULT},
153    {"resolveRejectDeferred", nullptr, method++, nullptr, nullptr, nullptr, JSVM_DEFAULT},
154};
155
156// 样例测试js
157const char *srcCallNative = R"JS(createPromise();
158                                 resolveRejectDeferred('success','fail', true);
159                                 resolveRejectDeferred('success','fail', false);)JS";
160```
161
162预期结果
163```
164JSVM CreatePromise success:1
165OH_JSVM_ResolveDeferred resolve
166OH_JSVM_RejectDeferred reject
167```
168
169## OH_JSVM_PromiseRegisterHandler
170
171用于设置 Promise 解析或拒绝后的回调，效果等价于调用原生的 `Promise.then()` 或 `Promise.catch()`
172
173cpp 部分代码
174```
175static int PromiseRegisterHandler(JSVM_VM vm, JSVM_Env env) {
176    const char *defineFunction = R"JS(
177        var x1 = 0;
178        var x2 = 0;
179        function f1(x) {
180            x1 = x;
181            return x + 1;
182        }
183        function f2(x) {
184            x2 = x;
185            return x + 1;
186        }
187    )JS";
188
189    const char *init = R"JS(
190        x1 = 0;
191        x2 = 0;
192    )JS";
193
194    JSVM_Script script;
195    JSVM_Value jsSrc;
196    JSVM_Value result;
197
198    // 定义 JS 函数 f1 和 f2
199    CHECK_RET(OH_JSVM_CreateStringUtf8(env, defineFunction, JSVM_AUTO_LENGTH, &jsSrc));
200    CHECK_RET(OH_JSVM_CompileScript(env, jsSrc, nullptr, 0, true, nullptr, &script));
201    CHECK_RET(OH_JSVM_RunScript(env, script, &result));
202
203    // 初始化 x1， x2 为 0
204    CHECK_RET(OH_JSVM_CreateStringUtf8(env, init, JSVM_AUTO_LENGTH, &jsSrc));
205    CHECK_RET(OH_JSVM_CompileScript(env, jsSrc, nullptr, 0, true, nullptr, &script));
206    CHECK_RET(OH_JSVM_RunScript(env, script, &result));
207
208    // 获取函数 f1 和 f2
209    JSVM_Value global;
210    CHECK_RET(OH_JSVM_GetGlobal(env, &global));
211    JSVM_Value f1;
212    CHECK_RET(OH_JSVM_GetNamedProperty(env, global, "f1", &f1));
213    JSVM_Value f2;
214    CHECK_RET(OH_JSVM_GetNamedProperty(env, global, "f2", &f2));
215
216    // 创建 Promise
217    JSVM_Value promise;
218    JSVM_Deferred deferred;
219    CHECK_RET(OH_JSVM_CreatePromise(env, &deferred, &promise));
220    // 为 promise 注册回调函数，并将 then 调用的结果（新的 Promise）赋值给 promise1
221    JSVM_Value promise1;
222    CHECK_RET(OH_JSVM_PromiseRegisterHandler(env, promise, f1, nullptr, &promise1));
223    // 为 promise1 注册回调函数
224    CHECK_RET(OH_JSVM_PromiseRegisterHandler(env, promise1, f2, nullptr, nullptr));
225
226    // 获取 promise 解析前 x1 和 x2 的值
227    JSVM_Value x1;
228    CHECK_RET(OH_JSVM_GetNamedProperty(env, global, "x1", &x1));
229    int32_t x1Int;
230    CHECK_RET(OH_JSVM_GetValueInt32(env, x1, &x1Int));
231    JSVM_Value x2;
232    CHECK_RET(OH_JSVM_GetNamedProperty(env, global, "x2", &x2));
233    int32_t x2Int;
234    CHECK_RET(OH_JSVM_GetValueInt32(env, x2, &x2Int));
235    OH_LOG_INFO(LOG_APP, "Before promise resolved, x1: %{public}d, x2: %{public}d", x1Int, x2Int);
236
237    // 解析 promise
238    JSVM_Value resolveValue;
239    CHECK_RET(OH_JSVM_CreateInt32(env, 2, &resolveValue));
240    OH_JSVM_ResolveDeferred(env, deferred, resolveValue);
241    deferred = nullptr;
242
243    // 获取 promise 解析后 x1 和 x2 的值
244    CHECK_RET(OH_JSVM_GetNamedProperty(env, global, "x1", &x1));
245    CHECK_RET(OH_JSVM_GetValueInt32(env, x1, &x1Int));
246    CHECK_RET(OH_JSVM_GetNamedProperty(env, global, "x2", &x2));
247    CHECK_RET(OH_JSVM_GetValueInt32(env, x2, &x2Int));
248    OH_LOG_INFO(LOG_APP, "After promise resolved, x1: %{public}d, x2: %{public}d", x1Int, x2Int);
249
250    return 0;
251}
252
253static void RunDemo(JSVM_VM vm, JSVM_Env env) {
254    if (PromiseRegisterHandler(vm, env) != 0) {
255        OH_LOG_INFO(LOG_APP, "Run PromiseRegisterHandler failed");
256    }
257}
258```
259
260预期结果
261```
262Before promise resolved, x1: 0, x2: 0
263After promise resolved, x1: 2, x2: 3
264```
265