写在开头：
- 本文在 三方库移植之NAPI开发[1]—Hello OpenHarmony NAPI 的基础上修改hellonapi.cpp、index.ets，接着学习NAPI异步模型的Promise、Callback方式。
- 本文共有三个示例，分别是
Callback 异步接口示例、Promise 异步接口示例、规范异步接口示例。在本文末尾的资源中提供了这三个示例的源代码，读者可以下载在开发板上运行。 - 开发基于最新的OpenHarmony3.2Beta3版本及API9,标准系统开发板为润和软件DAYU200。
NAPI异步方式实现原理
-
同步方式和异步方式：
同步方式，所有的代码处理都在原生方法（主线程）中完成。
异步方式，所有的代码处理在多个线程中完成。 -
实现NAPI异步方法的步骤：
1）立即返回一个临时结果给js调用者
2）另起线程完成异步业务逻辑的执行
3）通过callback或promise返回真正的结果 -
异步工作项工作时序图：
- 原生方法被调用时，原生方法完成
数据接收、数据类型转换、存入上下文数据，之后创建异步工作项 异步工作项会加入调度队列,由异步工作线程池统一调度，原生方法返回空值（Callback方式）或返回Promise对象（Promise方式）。- 异步方式依赖NAPI框架提供的
napi_create_async_work()函数创建异步工作项
napi_create_async_work()在foundation/arkui/napi/native_engine/native_node_api.cpp第71行
NAPI_EXTERN napi_status napi_create_async_work(napi_env env,napi_value async_resource,napi_value async_resource_name,napi_async_execute_callback execute,napi_async_complete_callback complete,void* data,napi_async_work* result)
参数说明：
[in] env: 传入接口调用者的环境，包含js引擎等，由框架提供，默认情况下直接传入即可。
[in] async_resource: 可选项，关联async_hooks。
[in] async_resource_name: 异步资源标识符，主要用于async_hooks API暴露断言诊断信息。
[in] execute: 执行业务逻辑计算函数，由worker线程池调度执行。在该函数中执行IO、CPU密集型任务，不阻塞主线程。
[in] complete: execute参数指定的函数执行完成或取消后，触发执行该函数。此函数在EventLoop线程中执行。
[in] data: 用户提供的上下文数据，用于传递数据。
[out] result: napi_async_work*指针，用于返回当前此处函数调用创建的异步工作项。 返回值：返回napi_ok表示转换成功，其他值失败。
napi_create_async_work里有两个回调：
- execute
- execute函数用于执行工作项的业务逻辑，异步工作项被调度后，该函数从上下文数据中获取输入数据，在worker线程中完成
业务逻辑计算（不阻塞主线程）并将结果写入上下文数据。 - 因为execute函数不在JS线程中，所以不允许execute函数调用napi的接口。业务逻辑的返回值可以返回到complete回调中处理。
- execute函数用于执行工作项的业务逻辑，异步工作项被调度后，该函数从上下文数据中获取输入数据，在worker线程中完成
- complete
- 业务逻辑处理execute函数执行完成或被取消后，触发EventLoop执行complete函数，complete函数从上下文数据中获取结果，转换为JS类型，调用
JS回调函数或通过Promise resolve()返回结果。 - 可以调用napi的接口，将execute中的返回值封装成JS对象返回。此回调在JS线程中执行。
- 业务逻辑处理execute函数执行完成或被取消后，触发EventLoop执行complete函数，complete函数从上下文数据中获取结果，转换为JS类型，调用
- 管理简单的异步操作的方法还有这些
- napi_delete_async_work(napi_env env, napi_async_work work)
删除异步工作线程 - napi_queue_async_work(napi_env env, napi_async_work work)
将刚创建的异步工作项加到队列（排队），由底层去调度执行 - napi_cancel_async_work(napi_env env, napi_async_work work)
取消异步工作项
- napi_delete_async_work(napi_env env, napi_async_work work)
NAPI支持异步模型
- OpenHarmony标准系统异步接口实现支持Promise方式和Callback方式。NAPI支持异步模型，提供了Promise、Callback方式。
- 标准系统异步接口实现规范要求，若引擎开启Promise特性支持，则异步方法必须同时支持Callback方式和Promise方式。
- 由应用开发者决定使用哪种方式，通过是否传递Callback函数区分异步方法是Callback方式还是Promise方式
- 不传递Callback即为Promise方式（方法执行结果为Promise实例对象），否则为Callback方式
- Promise、Callback 异步模型都是 OHOS 标准异步模型。
- Callback异步模型
- 用户在调用接口的时候，接口实现将异步执行任务
- 任务执行结果以参数的形式提供给用户注册的回调函数,这些参数的第一个是 Error 或 undefined 类型，分别表示执行出错与正常。
- Promise异步模型
- 对象的状态不受外界影响；
- 一旦状态改变了就不会再变，也就是说任何时候Promise都只有一种状态。
- ES6原生提供了Promise对象，Promise是异步编程的一种解决方案，可以替代传统的解决方案回调函数和事件；
- promise对象是一个异步操作的结果，提供了一些API使得异步执行可以按照同步的流表示出来，避免了层层嵌套的回调函数，保证了回调是以异步的方式进行调用的；
- 用户在调用这些接口的时候，接口实现将异步执行任务，同时返回一个 Promise 对象，其代表异步操作的结果；
- 在返回的结果的个数超过一个时，其以对象属性的形式返回。
- ES6：全称ECMAScript 6.0。ECMAScript 是JavaScript语言的国际标准，JavaScript是ECMAScript的实现。
Callback 异步接口
Callback 异步接口示例代码
hellonapi.cpp文件
#include <string.h>
#include <stdio.h>
#include "napi/native_node_api.h"
#include "napi/native_api.h"// 用户提供的上下文数据，在原生方法（初始化数据）、executeCB、completeCB之间传递数据
struct AddonData {napi_async_work asyncWork = nullptr;napi_deferred deferred = nullptr;napi_ref callback = nullptr;double args[2] = {0};double result = 0;
};// 业务逻辑处理函数，由worker线程池调度执行。
static void addExecuteCB(napi_env env, void *data) {AddonData *addonData = (AddonData *)data;// 执行复杂计算，不阻塞主线程。此处用一个加法简单示意。addonData->result = addonData->args[0] + addonData->args[1];
}// 业务逻辑处理完成回调函数，在业务逻辑处理函数执行完成或取消后触发，由EventLoop线程中执行。
static void addCallbackCompleteCB(napi_env env, napi_status status, void *data) {AddonData *addonData = (AddonData *)data;napi_value callback = nullptr;napi_get_reference_value(env, addonData->callback, &callback);napi_value undefined = nullptr;napi_get_undefined(env, &undefined);napi_value result = nullptr;napi_create_double(env, addonData->result, &result);napi_value callbackResult = nullptr;// 执行回调函数napi_call_function(env, undefined, callback, 1, &result, &callbackResult);// 删除napi_ref对象if (addonData->callback != nullptr) {napi_delete_reference(env, addonData->callback);}// 删除异步工作项napi_delete_async_work(env, addonData->asyncWork);delete addonData;
}static napi_value addCallback(napi_env env, napi_callback_info info) {// 获取3个参数，值的类型是js类型（napi_value）size_t argc = 3;napi_value args[3];napi_value thisArg = nullptr;NAPI_CALL(env, napi_get_cb_info(env, info, &argc, args, &thisArg, nullptr));// 获取并判断js参数类型napi_valuetype valuetype0;NAPI_CALL(env, napi_typeof(env, args[0], &valuetype0));napi_valuetype valuetype1;NAPI_CALL(env, napi_typeof(env, args[1], &valuetype1));if (valuetype0 != napi_number || valuetype1 != napi_number) {napi_throw_type_error(env, nullptr, "Wrong arguments. 2 numbers expected.");return NULL;}napi_valuetype valuetype2;NAPI_CALL(env, napi_typeof(env, args[2], &valuetype2));if (valuetype2 != napi_function) {napi_throw_type_error(env, nullptr, "Callback function expected.");return NULL;}// 异步工作项上下文用户数据，传递到异步工作项的execute、complete中传递数据auto addonData = new AddonData{.asyncWork = nullptr,};// 将接收到的参数传入用户自定义上下文数据NAPI_CALL(env, napi_get_value_double(env, args[0], &addonData->args[0]));NAPI_CALL(env, napi_get_value_double(env, args[1], &addonData->args[1]));NAPI_CALL(env, napi_create_reference(env, args[2], 1, &addonData->callback));// 创建async work，创建成功后通过最后一个参数接收async work的handlenapi_value resourceName = nullptr;napi_create_string_utf8(env, "addCallback", NAPI_AUTO_LENGTH, &resourceName);napi_create_async_work(env, nullptr, resourceName, addExecuteCB, addCallbackCompleteCB, (void *)addonData,&addonData->asyncWork);// 将刚创建的async work加到队列，由底层去调度执行napi_queue_async_work(env, addonData->asyncWork);// 原生方法返回空对象napi_value result = 0;NAPI_CALL(env, napi_get_null(env, &result));return result;
}// napi_addon_register_func
static napi_value registerFunc(napi_env env, napi_value exports) {static napi_property_descriptor desc[] = {DECLARE_NAPI_FUNCTION("addCallback", addCallback),};NAPI_CALL(env, napi_define_properties(env, exports, sizeof(desc) / sizeof(desc[0]), desc));return exports;
}// 定义napi_module，指定当前NAPI模块对应的模块名
//以及模块注册对外接口的处理函数，具体扩展的接口在该函数中声明
// nm_modname: 模块名称，对应eTS代码为import nm_modname from '@ohos.ohos_shared_library_name'
//示例对应eTS代码为：import hellonapi from '@ohos.hellonapi'
static napi_module hellonapiModule = {.nm_version = 1,.nm_flags = 0,.nm_filename = nullptr,.nm_register_func = registerFunc, // 模块对外接口注册函数.nm_modname = "hellonapi", // 自定义模块名.nm_priv = ((void*)0),.reserved = { 0 },
};// 模块定义好后，调用NAPI提供的模块注册函数napi_module_register(napi_module* mod)函数注册到系统中。
// register module，设备启动时自动调用此constructor函数，把模块定义的模块注册到系统中
extern "C" __attribute__((constructor)) void hellonapiModuleRegister()
{napi_module_register(&hellonapiModule);
}
index.ets
import prompt from '@system.prompt';
import hellonapi from '@ohos.hellonapi'@Entry
@Component
struct TestAdd {build() {Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {Button("hellonapi.addCallback(x, y, callback)").margin(10).fontSize(20).onClick(() => {let num1 = 123, num2 = 456hellonapi.addCallback(num1, num2, (result) => {prompt.showToast({ message: `hellonapi.addCallback(${num1}, ${num2}) = ${result}` })})})}.width('100%').height('100%')}
}
@ohos.hellonapi.d.ts
declare namespace hellonapi {function addCallback(num1: number, num2: number, callback:(result: number) => void): void;/*** ** @since 9* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore*/}
export default hellonapi;
主线程：获取JS传入参数
获取JS传入参数在异步工作项工作时序图中位置，在图中用红框标记如下
// 获取并判断js参数类型napi_valuetype valuetype0;NAPI_CALL(env, napi_typeof(env, args[0], &valuetype0));
// 使用napi_typeof接口进行参数类型的判断napi_valuetype valuetype1;NAPI_CALL(env, napi_typeof(env, args[1], &valuetype1));// 如果valuetype2调用的不是数据类型，则抛出异常“Wrong arguments. 2 numbers expected.”if (valuetype0 != napi_number || valuetype1 != napi_number) {napi_throw_type_error(env, nullptr, "Wrong arguments. 2 numbers expected.");return NULL;}napi_valuetype valuetype2;NAPI_CALL(env, napi_typeof(env, args[2], &valuetype2));// 如果valuetype2调用的不是function类型(callback)，则抛出异常“Callback function expected”if (valuetype2 != napi_function) {napi_throw_type_error(env, nullptr, "Callback function expected.");return NULL;}
- 使用napi_typeof接口进行参数类型的判断
- NAPI_CALL（）是用来调用NAPI中的API的。
主线程：初始化上下文数据
初始化上下文数据在异步工作项工作时序图中位置，在图中用红框标记如下
- 异步方法需要在不同线程中传递各种
业务数据（上下文数据），就需要定义一个结构体保存这些被传递的信息。用于在主线程方法、Work线程、EventLoop线程之间传递数据。
struct 结构体名(也就是可选标记名）{ 成员变量；}；//使用分号；表示定义结束。
- 本示例定义的上下文数据包含：
异步工作项对象、回调函数、2个参数（加数、被加数）、业务逻辑处理结果等4个属性。
// 定义异步工作项上下文数据
// 用户提供的上下文数据，用于在主线程方法、Work线程、EventLoop线程之间传递数据。
struct AddonData {napi_async_work asyncWork = nullptr; //异步工作对象asyncWorknapi_ref callback = nullptr; //回调函数callbackdouble args[2] = {0}; //2个输入参数double result = 0; //业务逻辑处理结果result（返回值）
};
- OpenHarmony的NAPI框架将ECMAScript标准中定义的Boolean、Null、Undefined、Number、BigInt、String、Symbol和Object八种
数据类型和Function类型，都已统一封装为napi_value类型，故可如获取数据类型的参数一样获取Function类型的参数。
Function是JavaScript提供的一种引用类型，通过Function类型创建Function对象。
在JavaScript中，函数也是以对象的形式存在的，每个函数都是一个Function对象。
- 定义好结构体后,接着我们将接收到的3个参数（
加数、被加数、回调函数）转换存入上下文数据完成初始化上下文数据，- number类型的（
加数、被加数）转换为double直接存入。 - Function类型的参数（
回调函数）怎么处理？不能直接存入napi_value类型。- 因为牵涉到NAPI对象生命周期管理问题。napi_value类型引用对象的生命周期在原生方法退出后结束，后面在work线程无法获取其值。
- NAPI提供了一种生命期限长于原生方法的对象引用类型—— napi_ref，所以调用napi_create_reference()函数将接收到的napi_value类型的回调函数参数callback转换为napi_ref类型。napi_create_reference()函数定义如下：
- number类型的（
NAPI_EXTERN napi_status napi_create_reference(napi_env env,napi_value value,uint32_t initial_refcount,napi_ref* result);
参数说明：
[in] env: 传入接口调用者的环境，包含js引擎等，由框架提供，默认情况下直接传入即可。
[in] value: 需要创建一个引用的napi_value对象
[in] initial_refcount: 初始化引用次数。
[out] result: 指针，指向新创建的napi_ref对象。 返回值：返回napi_ok表示转换成功，其他值失败。
- napi_ref引用对象在原生方法退出后不自动回收，由用户管理napi_ref类型对象的生命周期。
- 用户管理napi_ref类型对象的生命周期的方法有
- napi_create_reference() ： 将napi_value包装成napi_ref引用对象
- napi_get_reference_value() ： 从napi_ref引用对象中取得napi_value
- napi_delete_reference() ：删除napi_ref引用对象
- 通过
napi_create_reference()方法将napi_value创建一个napi_ref，这个napi_ref是可以跨作用域传递的，然后在需要用到的地方用napi_get_reference_value()方法将napi_ref还原为napi_value，用完后再用napi_delete_reference()方法删除引用对象以便释放相关内存资源。
- 用户管理napi_ref类型对象的生命周期的方法有
static napi_value addAsyncCallback(napi_env env, napi_callback_info info) {
// NAPI定义API方法时的接收参数为(napi_env, napi_callback_info)
// 其中napi_callback_info为上下文的信息。size_t argc = 3; // 有3个参数（`加数`、`被加数`、`回调函数`）到上下文中napi_value args[3];napi_value thisArg = nullptr;NAPI_CALL(env, napi_get_cb_info(env, info, &argc, args, &thisArg, nullptr));
// NAPI提供了napi_get_cb_info()方法可从napi_callback_info中获取参数列表、this及其他数据。...// 异步工作项上下文用户数据，传递到异步工作项的execute、complete中传递数据// 创建结构体addonData用于保存各种需要在异步线程中传递的数据信息auto addonData = new AddonData{.asyncWork = nullptr,};// 将接收到的3个参数（`加数`、`被加数`、`回调函数`）传入用户自定义上下文数据NAPI_CALL(env, napi_get_value_double(env, args[0], &addonData->args[0]));// NAPI_CALL（）是用来调用NAPI中的API的// NAPI提供napi_get_value_double方法将JS类型double值转换为C++类型的double值NAPI_CALL(env, napi_get_value_double(env, args[1], &addonData->args[1])); NAPI_CALL(env, napi_create_reference(env, args[2], 1, &addonData->callback));//调用napi_create_reference()函数将接收到的napi_value类型的回调函数callback转换为napi_ref类型，将napi_value包装成napi_ref引用对象。并保存到asyncContext上下文数据中，以便后续在C++异步线程中能够回调该js fuction类型。//参数解释如下// env: 传入接口调用者的环境，包含js引擎等，由框架提供，默认情况下直接传入即可// args[2]: 引用的napi_value对象 (加数和被加数)// 1：初始化引用1次// &addonData->callback: 指向新创建的napi_ref 对象(callback) ...
}
- NAPI_CALL（）是用来调用NAPI中的API的。
主线程：创建异步工作项
创建异步工作项在异步工作项工作时序图中位置，在图中用红框标记如下
- 第一步：在创建
异步工作项前，分别声明addExecuteCB、addAsyncCompleteCB这2个函数，分别用作于napi_create_async_work(napi_env env,napi_value async_resource,napi_value async_resource_name,napi_async_execute_callback execute,napi_async_complete_callback complete,void* data,napi_async_work* result)函数的execute、complete参数。 - 第二步：利用NAPI框架提供的napi_create_async_work()函数创建
异步工作项，将addExecuteCB、addAsyncCompleteCB这2个函数存入上下文数据的asyncWork属性
// 业务逻辑处理函数，由异步work线程池统一调度
static void addExecuteCB(napi_env env, void *data) {
}// 业务逻辑处理完成回调函数，在业务逻辑处理函数执行完成或取消后触发。
static void addAsyncCompleteCB(napi_env env, napi_status status, void *data) {
}static napi_value addAsyncCallback(napi_env env, napi_callback_info info) {...// 创建async work，创建成功后通过最后一个参数接收async work的handlenapi_value resourceName = nullptr;// 根据UTF8编码格式的 C/C++字符串 创建一个 JS字符串对象.
// 传入的参数是Javascript值类型，被NAPI框架封装成统一的唯一类型——napi_value类型，为了能够进行计算，我们需要获取其对应在C/C++中的类型的值。将C/C++ utf8类型的值转为node_value类型，返回给JS代码napi_create_string_utf8(env, "addCallback", NAPI_AUTO_LENGTH, &resourceName); //参数说明如下//env: 传入接口调用者的环境，包含js引擎等，由框架提供，默认情况下直接传入即可//addCallback：定义的上下文信息中的addCallback对象//NAPI_AUTO_LENGTH：字符长度//resourceName:创建的napi_value对象// 异步方式依赖NAPI框架提供的napi_create_async_work()函数创建异步工作项napi_create_async_work(env, nullptr, resourceName, addExecuteCB , addCallbackCompleteCB , (void *)addonData,&addonData->asyncWork);//参数说明如下//env: 传入接口调用者的环境，包含js引擎等，由框架提供，默认情况下直接传入即可。//第二个参数是nullptr//resourceName: 定义的上下文信息中的addCallback对象（异步资源标识符），主要用于async_hooks API暴露断言诊断信息。//addExecuteCB:执行业务逻辑计算函数，由worker线程池调度执行。在该函数中执行IO、CPU密集型任务，不阻塞主线程。//addCallbackCompleteCB: execute参数指定的函数执行完成或取消后，触发执行该函数。此函数在EventLoop线程中执行。//(void *)addonData: 用户提供的上下文数据，用于传递数据。//&addonData->asyncWork: 用于返回当前此处函数调用创建的异步工作项。 返回值：返回napi_ok表示转换成功，其他值失败。...
}
主线程：异步工作项加入队列，等待调度
异步工作项加入队列，等待调度在异步工作项工作时序图中位置，在图中用红框标记如下
static napi_value addAsyncCallback(napi_env env, napi_callback_info info) {...// 将刚创建的异步工作项（async work）加到队列，由work thread调度执行napi_queue_async_work(env, addonData->asyncWork);// 其中asyncWork是上下文数据中创建的异步工作对象，用于管理异步工作线程。...
}
主线程：原生方法返回临时返回值
-
调用napi_queue_async_work()将
异步工作项加入调度队列，由异步work线程池统一调度，原生方法返回空值退出。 -
用户在调用接口的时候，接口实现将异步执行任务,任务执行结果以参数的形式提供给用户注册的回调函数（callback）,这些参数的第一个是 Error 或 undefined 类型，分别表示执行出错与正常。
static napi_value addAsyncCallback(napi_env env, napi_callback_info info) {...// 为异步方法创建临时返回值,在此处原生方法临时返回值是一个空对象napi_value result = 0;// callback接口返回参数为void，用napi_get_null（）构造一个空对象的返回值即可。NAPI_CALL(env, napi_get_null(env, &result));return result;
}
work线程：执行业务逻辑、把计算结果写入上下文数据
执行业务逻辑、把计算结果写入上下文数据在异步工作项工作时序图中位置，在图中用红框标记如下
创建异步工作项前，声明了addExecuteCB这个函数，用作于napi_create_async_work()函数的execute参数。
-
execute函数在异步工作项被调度后在work线程中执行
- 不阻塞主线程（不阻塞UI界面）
- 可执行IO、CPU密集型等任务。
-
执行业务逻辑:业务逻辑计算是一个简单的加法，并把计算结果存入上下文数据的result属性 -
把计算结果写入上下文数据:把execute函数的结构体指向上下文数据中结构体。
// 业务逻辑处理函数，由worker线程池调度执行。
static void addExecuteCB(napi_env env, void *data) {// 把计算结果写入上下文数据，把addonData指向AddonDataAddonData *addonData = (AddonData *)data;// 执行业务逻辑，// 不阻塞主线程。此处是一个加法addonData->result = addonData->args[0] + addonData->args[1];
}EventLoop线程：把上下文中的结果转为JS类型、调用JS回调函数
把上下文中的结果转为JS类型、调用JS回调函数在异步工作项工作时序图中位置，在图中用红框标记如下
- 创建
异步工作项前，声明addAsyncCompleteCB这个函数，用作于napi_create_async_work()函数的complete参数。- 第一步：addAsyncCompleteCB从接收到的
上下文数据中获取结果，调用napi_call_function()方法执行JS回调函数返回数据给JS。 - 第二步: 释放（删除）过程中创建的napi_ref引用对象、异步工作项等对象。
- 第一步：addAsyncCompleteCB从接收到的
// 业务逻辑处理完成回调函数，在业务逻辑处理函数执行完成或取消后触发，由EventLoop线程中执行。
static void addCallbackCompleteCB(napi_env env, napi_status status, void *data) {
//所有的接口调用返回一个napi_status类型的状态码，用来表明接口调用成功或者失败AddonData *addonData = (AddonData *)data;napi_value callback = nullptr;//从napi_ref引用对象中取得napi_valuenapi_get_reference_value(env, addonData->callback, &callback);napi_value undefined = nullptr;napi_get_undefined(env, &undefined);napi_value result = nullptr;napi_create_double(env, addonData->result, &result);napi_value callbackResult = nullptr;// 执行回调函数napi_call_function(env, undefined, callback, 1, &result, &callbackResult);// 删除napi_ref对象if (addonData->callback != nullptr) {napi_delete_reference(env, addonData->callback);}// 删除异步工作项napi_delete_async_work(env, addonData->asyncWork);delete addonData;
}
- NAPI框架提供了
napi_call_function()函数供扩展Natvie代码（C/C++代码）调用JS函数，用于执行回调函数等场景。函数定义如下：
// Methods to work with Functions
NAPI_EXTERN napi_status napi_call_function(napi_env env,napi_value recv,napi_value func,size_t argc,const napi_value* argv,napi_value* result)
参数说明：
[in] env: 传入接口调用者的环境，包含js引擎等，由框架提供，默认情况下直接传入即可。
[in] recv: 传给被调用的this对象。
[in] func: 被调用的函数.
[in] argc: 函数参数个数（对应函数数组的长度）。
[in] argv: 函数参数数组.
[out] result: func函数执行的返回值。 返回值：返回napi_ok表示转换成功，其他值失败。
- 因对象生命周期管理问题，
上下文数据的callback属性的类型为napi_ref，需要调用napi_get_reference_value()函数获取其指向的napi_value对象值才调用napi_call_function()函数。 napi_get_reference_value函数定义：
// Attempts to get a referenced value. If the reference is weak,
// the value might no longer be available, in that case the call
// is still successful but the result is nullptr.
NAPI_EXTERN napi_status napi_get_reference_value(napi_env env, napi_ref ref, napi_value* result)
参数说明：
[in] env: 传入接口调用者的环境，包含js引擎等，由框架提供，默认情况下直接传入即可。
[in] ref: napi_ref对象
[out] result: napi_ref引用的napi_value对象。 返回值：返回napi_ok表示转换成功，其他值失败。
-
执行回调函数是为了在异步操作之后调用JS函数
-
napi_delete_reference（）用于删除上下文数据中定义的napi_ref对象callback。napi_ref引用对象在原生方法退出后不自动回收，由用户管理napi_ref类型对象的生命周期。 -
napi_delete_async_work()用于删除异步工作线程,在异步调用的结尾释放async_work和相关业务数据的内存
Callback异步接口总结
以下图片为个人总结，可以在文末下载清晰的图片，下载之后推荐到[diagrams]。
Promise异步接口
Promise异步接口示例代码
hellonapi.cpp
#include <string.h>
#include<stdio.h>
#include "napi/native_node_api.h"
#include "napi/native_api.h"// 用户提供的上下文数据，在原生方法（初始化数据）、executeCB、completeCB之间传递数据
struct AddonData {napi_async_work asyncWork = nullptr;napi_deferred deferred = nullptr;napi_ref callback = nullptr;double args[2] = {0};double result = 0;};// 业务逻辑处理函数，由worker线程池调度执行。
static void addExecuteCB(napi_env env, void *data) {AddonData *addonData = (AddonData *)data;// 执行复杂计算，不阻塞主线程。此处用一个加法简单示意。addonData->result = addonData->args[0] + addonData->args[1];// addonData->result = addonData->args[0] + addonData[1];
}static void addPromiseCompleteCB(napi_env env, napi_status status, void *data) {AddonData *addonData = (AddonData *)data;napi_value result = nullptr;napi_create_double(env, addonData->result, &result);napi_resolve_deferred(env, addonData->deferred, result);// 删除napi_ref对象if (addonData->callback != nullptr) {napi_delete_reference(env, addonData->callback);}// 删除异步工作项napi_delete_async_work(env, addonData->asyncWork);delete addonData;addonData = nullptr;
}static napi_value addPromise(napi_env env, napi_callback_info info) {// 获取2个参数，值的类型是js类型（napi_value）size_t argc = 2;napi_value args[2];napi_value thisArg = nullptr;NAPI_CALL(env, napi_get_cb_info(env, info, &argc, args, &thisArg, nullptr));// 获取并判断js参数类型napi_valuetype valuetype0;NAPI_CALL(env, napi_typeof(env, args[0], &valuetype0));napi_valuetype valuetype1;NAPI_CALL(env, napi_typeof(env, args[1], &valuetype1));if (valuetype0 != napi_number || valuetype1 != napi_number) {napi_throw_type_error(env, nullptr, "Wrong arguments. 2 numbers expected.");return NULL;}// 创建promisenapi_value promise = nullptr;napi_deferred deferred = nullptr;NAPI_CALL(env, napi_create_promise(env, &deferred, &promise));// 异步工作项上下文用户数据，传递到异步工作项的execute、complete之间传递数据auto addonData = new AddonData{.asyncWork = nullptr,.deferred = deferred,};// 将接收到的参数传入NAPI_CALL(env, napi_get_value_double(env, args[0], &addonData->args[0]));NAPI_CALL(env, napi_get_value_double(env, args[1], &addonData->args[1]));// 创建async work，创建成功后通过最后一个参数(addonData->asyncWork)返回async work的handlenapi_value resourceName = nullptr;napi_create_string_utf8(env, "addAsyncCallback", NAPI_AUTO_LENGTH, &resourceName);napi_create_async_work(env, nullptr, resourceName, addExecuteCB, addPromiseCompleteCB, (void *)addonData,&addonData->asyncWork);// 将刚创建的async work加到队列，由底层去调度执行napi_queue_async_work(env, addonData->asyncWork);// 原生方法返回promisereturn promise;}// napi_addon_register_func
//2.指定模块注册对外接口的处理函数，具体扩展的接口在该函数中声明
static napi_value registerFunc(napi_env env, napi_value exports)
{static napi_property_descriptor desc[] = {{ "addPromise", nullptr, addPromise, nullptr, nullptr, nullptr, napi_default, nullptr }};napi_define_properties(env, exports, sizeof(desc) / sizeof(desc[0]), desc);return exports;
}// 1.先定义napi_module，指定当前NAPI模块对应的模块名
//以及模块注册对外接口的处理函数，具体扩展的接口在该函数中声明
// nm_modname: 模块名称，对应eTS代码为import nm_modname from '@ohos.ohos_shared_library_name'
//示例对应eTS代码为：import hellonapi from '@ohos.hellonapi'
static napi_module hellonapiModule = {.nm_version = 1,.nm_flags = 0,.nm_filename = nullptr,.nm_register_func = registerFunc, // 模块对外接口注册函数.nm_modname = "hellonapi", // 自定义模块名.nm_priv = ((void*)0),.reserved = { 0 },
};//3.模块定义好后，调用NAPI提供的模块注册函数napi_module_register(napi_module* mod)函数注册到系统中。
// register module，设备启动时自动调用此constructor函数，把模块定义的模块注册到系统中
extern "C" __attribute__((constructor)) void hellonapiModuleRegister()
{napi_module_register(&hellonapiModule);
}
index.ets
import prompt from '@system.prompt';
import hellonapi from '@ohos.hellonapi'@Entry
@Component
struct TestAdd {build() {Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {Button("hellonapi.addPromise(x, y).then(...)").margin(1).fontSize(20).onClick(() => {let num1 = 123, num2 = 456hellonapi.addPromise(num1, num2).then((result) => {prompt.showToast({ message: `hellonapi.addPromise(${num1}, ${num2}) = ${result}` })})})}.width('100%').height('100%')}
}
@ohos.hellonapi.d.ts
declare namespace hellonapi {function addPromise(num1: number, num2: number): Promise<number>;/*** ** @since 9* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore*/}
export default hellonapi;
创建Promise
-
Promise整体处理流程和Callback方式一样,在此小节只讨论Promise不同于Callback的部分
-
首先创建Promise，NAPI框架中提供了napi_create_promise()函数用于创建Promise，调用该函数输出2个对象——deferred、promise。
- promise用于原生方法返回，deferred传入异步工作项的上下文数据。complete函数中，应用napi_resolve_deferred()函数 或 napi_reject_deferred() 函数返回数据。
函数定义如下：
napi_status napi_create_promise(napi_env env,napi_deferred* deferred,napi_value* promise);
参数说明：
[in] env: 传入接口调用者的环境，包含js引擎等，由框架提供，默认情况下直接传入即可。
[out] deferred: 返回接收刚创建的deferred对象，关联Promise对象，后面使用napi_resolve_deferred() 或 napi_reject_deferred() 返回数据。
[out] promise: 关联上面deferred对象的JS Promise对象 返回值：返回napi_ok表示转换成功，其他值失败。
static napi_value addPromise(napi_env env, napi_callback_info info) {// 创建promisenapi_value promise = nullptr;napi_deferred deferred = nullptr;// 创建promise对象。promise用于返回promise对象给js调用者NAPI_CALL(env, napi_create_promise(env, &deferred, &promise));...// 返回promisereturn promise;
}
初始化上下文数据
- 定义一个上下文数据结构，用于保存和传递数据。Promise方式加上deferred属性。
// 用户提供的上下文数据，在原生方法（初始化数据）、executeCB、completeCB之间传递数据
struct AddonData {...napi_deferred deferred = nullptr;double args[2] = {0};...
};static napi_value addPromise(napi_env env, napi_callback_info info) {// 获取2个参数，值的类型是js类型（napi_value）size_t argc = 2;napi_value args[2];napi_value thisArg = nullptr;NAPI_CALL(env, napi_get_cb_info(env, info, &argc, args, &thisArg, nullptr));...// 创建promisenapi_value promise = nullptr;napi_deferred deferred = nullptr;NAPI_CALL(env, napi_create_promise(env, &deferred, &promise));...// 将接收到的参数传入NAPI_CALL(env, napi_get_value_double(env, args[0], &addonData->args[0]));NAPI_CALL(env, napi_get_value_double(env, args[1], &addonData->args[1]));...
}
- Callback方式在addCallback传入的是三个参数，Promise方式在addPromise传入的是两个参数。
创建异步工作项
-
同Callback方式一样在创建异步工作项前，分别声明2个函数，分别用作于napi_create_async_work()函数的execute、complete参数。
-
异步工作项创建OK后，将其存入上下文数据的asyncWork属性，并调用napi_queue_async_work()将异步工作项加入调度队列，由异步work线程池统一调度，原生方法返回Promise对象退出。
// 用户提供的上下文数据，在原生方法（初始化数据）、executeCB、completeCB之间传递数据
struct AddonData {napi_async_work asyncWork = nullptr;napi_deferred deferred = nullptr;double args[2] = {0};double result = 0;
};static napi_value addPromise(napi_env env, napi_callback_info info) {...// 创建async work，创建成功后通过最后一个参数(addonData->asyncWork)用于后续在C++的异步线程中返回真正的计算结果napi_value resourceName = nullptr;napi_create_string_utf8(env, "addAsyncCallback", NAPI_AUTO_LENGTH, &resourceName);napi_create_async_work(env, nullptr, resourceName, addExecuteCB, addPromiseCompleteCB, (void *)addonData,&addonData->asyncWork);// 将刚创建的async work加到队列，由底层去调度执行napi_queue_async_work(env, addonData->asyncWork);// 原生方法返回promisereturn promise;
}
execute 回调处理
此处完全同Callback方式，无需修改。
// 业务逻辑处理函数，由worker线程池调度执行。
static void addExecuteCB(napi_env env, void *data) {AddonData *addonData = (AddonData *)data;// 执行复杂计算，不阻塞主线程。此处用一个加法简单示意。addonData->result = addonData->args[0] + addonData->args[1];
}
complete 回调处理
- 调用NAPI提供的napi_resolve_deferred() 或 napi_reject_deferred() 返回数据。之后释放过程中创建的napi_ref引用对象、异步工作项等对象。
static void addPromiseCompleteCB(napi_env env, napi_status status, void *data) {AddonData *addonData = (AddonData *)data;napi_value result = nullptr;napi_create_double(env, addonData->result, &result);napi_resolve_deferred(env, addonData->deferred, result);// 删除napi_ref对象if (addonData->callback != nullptr) {napi_delete_reference(env, addonData->callback);}// 删除异步工作项napi_delete_async_work(env, addonData->asyncWork);delete addonData;addonData = nullptr;
}
规范异步接口
hellonapi.cpp
#include <string.h>
#include<stdio.h>
#include "napi/native_node_api.h"
#include "napi/native_api.h"struct AddonData {napi_async_work asyncWork = nullptr;napi_deferred deferred = nullptr;napi_ref callback = nullptr;double args[2] = {0};double result = 0;
};// 业务逻辑处理函数，由worker线程池调度执行。
static void addExecuteCB(napi_env env, void *data) {AddonData *addonData = (AddonData *)data;// 执行复杂计算，不阻塞主线程。此处用一个加法简单示意。addonData->result = addonData->args[0] + addonData->args[1];
}// 业务逻辑处理完成回调函数，在业务逻辑处理函数执行完成或取消后触发，由EventLoop线程中执行。
static void addCallbackCompleteCB(napi_env env, napi_status status, void *data) {AddonData *addonData = (AddonData *)data;napi_value callback = nullptr;napi_get_reference_value(env, addonData->callback, &callback);napi_value undefined = nullptr;napi_get_undefined(env, &undefined);napi_value result = nullptr;napi_create_double(env, addonData->result, &result);napi_value callbackResult = nullptr;// 执行回调函数napi_call_function(env, undefined, callback, 1, &result, &callbackResult);// 删除napi_ref对象if (addonData->callback != nullptr) {napi_delete_reference(env, addonData->callback);}// 删除异步工作项napi_delete_async_work(env, addonData->asyncWork);delete addonData;
}static void addPromiseCompleteCB(napi_env env, napi_status status, void *data) {AddonData *addonData = (AddonData *)data;napi_value result = nullptr;napi_create_double(env, addonData->result, &result);napi_resolve_deferred(env, addonData->deferred, result);// 删除napi_ref对象if (addonData->callback != nullptr) {napi_delete_reference(env, addonData->callback);}// 删除异步工作项napi_delete_async_work(env, addonData->asyncWork);delete addonData;
}static napi_value addAsync(napi_env env, napi_callback_info info) {// 获取3个参数，值的类型是js类型（napi_value）size_t argc = 3;napi_value args[3];napi_value thisArg = nullptr;NAPI_CALL(env, napi_get_cb_info(env, info, &argc, args, &thisArg, nullptr));// 获取并判断js参数类型napi_valuetype valuetype0;NAPI_CALL(env, napi_typeof(env, args[0], &valuetype0));napi_valuetype valuetype1;NAPI_CALL(env, napi_typeof(env, args[1], &valuetype1));if (valuetype0 != napi_number || valuetype1 != napi_number) {napi_throw_type_error(env, nullptr, "Wrong arguments. 2 numbers expected.");return NULL;}// 异步工作项上下文用户数据，传递到异步工作项的execute、complete中传递数据auto addonData = new AddonData{.asyncWork = nullptr,};if (argc == 2) {// 创建promisenapi_value promise = nullptr;napi_deferred deferred = nullptr;NAPI_CALL(env, napi_create_promise(env, &deferred, &promise));addonData->deferred = deferred;// 将接收到的参数传入NAPI_CALL(env, napi_get_value_double(env, args[0], &addonData->args[0]));NAPI_CALL(env, napi_get_value_double(env, args[1], &addonData->args[1]));// 创建async work，创建成功后通过最后一个参数(addonData->asyncWork)返回async work的handlenapi_value resourceName = nullptr;napi_create_string_utf8(env, "addPromise", NAPI_AUTO_LENGTH, &resourceName);napi_create_async_work(env, nullptr, resourceName, addExecuteCB, addPromiseCompleteCB, (void *)addonData,&addonData->asyncWork);// 将刚创建的async work加到队列，由底层去调度执行napi_queue_async_work(env, addonData->asyncWork);// 返回promisereturn promise;} else {napi_valuetype valuetype2;NAPI_CALL(env, napi_typeof(env, args[2], &valuetype2));if (valuetype2 != napi_function) {napi_throw_type_error(env, nullptr, "Callback function expected.");return NULL;}// 将接收到的参数传入用户自定义上下文数据NAPI_CALL(env, napi_get_value_double(env, args[0], &addonData->args[0]));NAPI_CALL(env, napi_get_value_double(env, args[1], &addonData->args[1]));NAPI_CALL(env, napi_create_reference(env, args[2], 1, &addonData->callback));// 创建async work，创建成功后通过最后一个参数接收async work的handlenapi_value resourceName = nullptr;napi_create_string_utf8(env, "addCallback", NAPI_AUTO_LENGTH, &resourceName);napi_create_async_work(env, nullptr, resourceName, addExecuteCB, addCallbackCompleteCB, (void *)addonData,&addonData->asyncWork);// 将刚创建的async work加到队列，由底层去调度执行napi_queue_async_work(env, addonData->asyncWork);// 原生方法返回空对象napi_value result = 0;NAPI_CALL(env, napi_get_null(env, &result));return result;}
}// napi_addon_register_func
static napi_value registerFunc(napi_env env, napi_value exports) {static napi_property_descriptor desc[] = {DECLARE_NAPI_FUNCTION("addAsync", addAsync),};NAPI_CALL(env, napi_define_properties(env, exports, sizeof(desc) / sizeof(desc[0]), desc));return exports;
}// 1.先定义napi_module，指定当前NAPI模块对应的模块名
//以及模块注册对外接口的处理函数，具体扩展的接口在该函数中声明
// nm_modname: 模块名称，对应eTS代码为import nm_modname from '@ohos.ohos_shared_library_name'
//示例对应eTS代码为：import hellonapi from '@ohos.hellonapi'
static napi_module hellonapiModule = {.nm_version = 1,.nm_flags = 0,.nm_filename = nullptr,.nm_register_func = registerFunc, // 模块对外接口注册函数.nm_modname = "hellonapi", // 自定义模块名.nm_priv = ((void*)0),.reserved = { 0 },
};//3.模块定义好后，调用NAPI提供的模块注册函数napi_module_register(napi_module* mod)函数注册到系统中。
// register module，设备启动时自动调用此constructor函数，把模块定义的模块注册到系统中
extern "C" __attribute__((constructor)) void hellonapiModuleRegister()
{napi_module_register(&hellonapiModule);
}
index.ets
import prompt from '@system.prompt';
import hellonapi from '@ohos.hellonapi'@Entry
@Component
struct TestAdd {build() {Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {Button("hellonapi.addAsync(x, y, callback)").margin(10).fontSize(20).onClick(() => {let num1 = 123, num2 = 456hellonapi.addAsync(num1, num2, (result) => {prompt.showToast({ message: `hellonapi.addAsync(${num1}, ${num2}) = ${result}` })})})Button("hellonapi.addAsync(x, y).then(...)").margin(10).fontSize(20).onClick(() => {let num1 = 123, num2 = 456hellonapi.addAsync(num1, num2).then((result) => {prompt.showToast({ message: `hellonapi.addAsync(${num1}, ${num2}) = ${result}` })})})}.width('100%').height('100%')}
}
@ohos.hellonapi.d.ts
declare namespace hellonapi {function addAsync(num1: number, num2: number, callback:(result: number) => void): void;function addAsync(num1: number, num2: number): Promise<number>;/*** ** @since 9* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore*/}
export default hellonapi;
异步方法和同步方法.ts接口文件
同步方法
-
同步方法调用之后，将阻塞住JS线程直至获取到返回值。
-
命名：动词+Sync或动词+名词+Sync
-
格式：
- 无参：方法名()
- 有参：方法名Sync(必填参数[, 可选参数])
-
返回值：有
-
声明文件模板
declare namespace 模块名
{/**
* 方法描述
* @note 特殊说明
* @since （可选，方法支持版本与模块不一致时需标明）
* @sysCap 系统能力
* @devices 支持设备 (可选，支持设备类型与模块不一致时需标明)
* @param 参数 参数说明（可选，没有参数或参数用interface包含时不需要标明）
* @return 返回值说明（可选，没有返回值或返回值用interface包含时不需要标明）
*/// 无参
function 方法名Sync(): 返回值类型;// 有参
function 方法名Sync(必填参数: 参数类型, options?: 可选参数类型): 返回值类型;interface 可选参数类型 {
参数名: 参数类型;
}
}export default 模块名;
- 示例
declare namespace hellonapi {function add(num1: number, num2: number): number;/*** ** @since 9* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore*/}
export default hellonapi;
异步方法
-
异步方法调用整个过程不会阻碍调用者的工作。
-
命名：动词或动词+名词
-
格式：
- 无参：方法名([回调函数])
- 有参：方法名(必填参数[, 可选参数][, 回调函数])
-
返回值
- 若回调函数非空，则返回void
- 若回调函数为空，则返回Promise实例对象
-
声明文件模板
declare namespace 模块名 {/*** 方法描述* @note 特殊说明* @since （可选，方法支持版本与模块不一致时需标明）* @sysCap 系统能力* @devices 支持设备 (可选，支持设备类型与模块不一致时需标明)* @param 参数 参数说明（可选，没有参数或参数用interface包含时不需要标明）*/// 无参
function 方法名(callback: AsyncCallback<结果数据类型>): void;
function 方法名(): Promise<结果数据类型>;// 有参
function 方法名(必填参数: 参数类型, callback: AsyncCallback<结果数据类型>): void;
function 方法名(必填参数: 参数类型, options: 可选参数类型, callback: AsyncCallback<结果数据类型>): void;
function 方法名(必填参数: 参数类型, options?: 可选参数类型): Promise<结果数据类型>;interface 可选参数类型 {参数名: 参数类型;
}
}export default 模块名;
- 示例
declare namespace hellonapi {function addAsync(num1: number, num2: number, callback:(result: number) => void): void;function addAsync(num1: number, num2: number): Promise<number>;/*** ** @since 9* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore*/}
export default hellonapi;
NAPI中的数据类型
- NAPI使用的数据类型和Node.js N-API保持一致。OpenHarmony的NAPI（Native API）组件是一套对外接口基于Node.js N-API规范开发的原生模块扩展开发框架。
通过查看foundation/arkui/napi/interfaces/inner_api/napi/native_node_api.h（编写NAPI拓展模块hellonapi.cpp需要包含的头文件）可以知道OpenHarmony基本的NAPI数据类型。
#include <js_native_api.h>中的js_native_api.h在ohos3.2beta3版本源码目录下路径为prebuilts/build-tools/common/nodejs/node-v12.18.4-linux-x64/include/node/js_native_api_types.h。
然后再分析prebuilts/build-tools/common/nodejs/node-v12.18.4-linux-x64/include/node/js_native_api_types.h和third_party/node/src/js_native_api_types.h内容的差别。
两者内容一致，可以推测OpenHarmony中基本的NAPI数据类型和Node.js N-API中的保持一致。而接口名方面，napi提供的接口名与三方Node.js一致，目前支持部分接口，详情见libnapi.ndk.json文件
// JSVM API types are all opaque pointers for ABI stability
// typedef undefined structs instead of void* for compile time type safety
typedef struct napi_env__* napi_env;
typedef struct napi_value__* napi_value;
typedef struct napi_ref__* napi_ref;
typedef struct napi_handle_scope__* napi_handle_scope;
typedef struct napi_escapable_handle_scope__* napi_escapable_handle_scope;
typedef struct napi_callback_info__* napi_callback_info;
typedef struct napi_deferred__* napi_deferred;
预处理器发现 #include 指令后，就会寻找指令后面<>中的文件名，并把这个文件的内容包含到当前文件中。被包含文件中的文本将替换源代码文件中的#include 指令
- 以typedef struct napi_env__* napi_env为例，搜遍Node.js的源码都找不到napi_value__定义，那这个定义是什么意思呢？c语言中，允许定义一个没有定义的结构体的指针。所以napi_value其实就是一个一级指针。他不需要类型信息。
typedef作用就是定义类型别名
关于NAPI标准库中导出的符号列表
-
NAPI它基于Node.js N-API规范开发，因此可参考Node.js N-API了解NAPI标准库中符号列表。本文以3.2beta3源码中的node三方库为例，从third_party/node/README.OpenSource中可得知3.2beta3移植的node版本为14.19.1，因此可参考的Node.js N-API链接为14.19.1版本，如下：https://nodejs.org/docs/latest-v14.x/api/n-api.html
-
标准库中导出的符号列表
| 符号类型 | 符号名 | 备注 |
|---|---|---|
| FUNC | napi_module_register | |
| FUNC | napi_get_last_error_info | |
| FUNC | napi_throw | |
| FUNC | napi_throw_error | |
| FUNC | napi_throw_type_error | |
| FUNC | napi_throw_range_error | |
| FUNC | napi_is_error | |
| FUNC | napi_create_error | |
| FUNC | napi_create_type_error | |
| FUNC | napi_create_range_error | |
| FUNC | napi_get_and_clear_last_exception | |
| FUNC | napi_is_exception_pending | |
| FUNC | napi_fatal_error | |
| FUNC | napi_open_handle_scope | |
| FUNC | napi_close_handle_scope | |
| FUNC | napi_open_escapable_handle_scope | |
| FUNC | napi_close_escapable_handle_scope | |
| FUNC | napi_escape_handle | |
| FUNC | napi_create_reference | |
| FUNC | napi_delete_reference | |
| FUNC | napi_reference_ref | |
| FUNC | napi_reference_unref | |
| FUNC | napi_get_reference_value | |
| FUNC | napi_create_array | |
| FUNC | napi_create_array_with_length | |
| FUNC | napi_create_arraybuffer | |
| FUNC | napi_create_external | |
| FUNC | napi_create_external_arraybuffer | |
| FUNC | napi_create_object | |
| FUNC | napi_create_symbol | |
| FUNC | napi_create_typedarray | |
| FUNC | napi_create_dataview | |
| FUNC | napi_create_int32 | |
| FUNC | napi_create_uint32 | |
| FUNC | napi_create_int64 | |
| FUNC | napi_create_double | |
| FUNC | napi_create_string_latin1 | |
| FUNC | napi_create_string_utf8 | |
| FUNC | napi_get_array_length | |
| FUNC | napi_get_arraybuffer_info | |
| FUNC | napi_get_prototype | |
| FUNC | napi_get_typedarray_info | |
| FUNC | napi_get_dataview_info | |
| FUNC | napi_get_value_bool | |
| FUNC | napi_get_value_double | |
| FUNC | napi_get_value_external | |
| FUNC | napi_get_value_int32 | |
| FUNC | napi_get_value_int64 | |
| FUNC | napi_get_value_string_latin1 | |
| FUNC | napi_get_value_string_utf8 | |
| FUNC | napi_get_value_uint32 | |
| FUNC | napi_get_boolean | |
| FUNC | napi_get_global | |
| FUNC | napi_get_null | |
| FUNC | napi_get_undefined | |
| FUNC | napi_coerce_to_bool | |
| FUNC | napi_coerce_to_number | |
| FUNC | napi_coerce_to_object | |
| FUNC | napi_coerce_to_string | |
| FUNC | napi_typeof | |
| FUNC | napi_instanceof | |
| FUNC | napi_is_array | |
| FUNC | napi_is_arraybuffer | |
| FUNC | napi_is_typedarray | |
| FUNC | napi_is_dataview | |
| FUNC | napi_is_date | |
| FUNC | napi_strict_equals | |
| FUNC | napi_get_property_names | |
| FUNC | napi_set_property | |
| FUNC | napi_get_property | |
| FUNC | napi_has_property | |
| FUNC | napi_delete_property | |
| FUNC | napi_has_own_property | |
| FUNC | napi_set_named_property | |
| FUNC | napi_get_named_property | |
| FUNC | napi_has_named_property | |
| FUNC | napi_set_element | |
| FUNC | napi_get_element | |
| FUNC | napi_has_element | |
| FUNC | napi_delete_element | |
| FUNC | napi_define_properties | |
| FUNC | napi_call_function | |
| FUNC | napi_create_function | |
| FUNC | napi_get_cb_info | |
| FUNC | napi_get_new_target | |
| FUNC | napi_new_instance | |
| FUNC | napi_define_class | |
| FUNC | napi_wrap | |
| FUNC | napi_unwrap | |
| FUNC | napi_remove_wrap | |
| FUNC | napi_create_async_work | |
| FUNC | napi_delete_async_work | |
| FUNC | napi_queue_async_work | |
| FUNC | napi_cancel_async_work | |
| FUNC | napi_get_node_version | |
| FUNC | napi_get_version | |
| FUNC | napi_create_promise | |
| FUNC | napi_resolve_deferred | |
| FUNC | napi_reject_deferred | |
| FUNC | napi_is_promise | |
| FUNC | napi_run_script | |
| FUNC | napi_get_uv_event_loop |
Native API接口说明
| 符号类型 | 符号名 | 备注 |
|---|---|---|
| FUNC | napi_run_script_path | 运行JavaScript文件 |
关于镜像文件的编译
- 初次编译OpenHarmony标准系统镜像时，会完整的编译出
boot_linux.img、config.cfg、MiniLoaderAll.bin、parameter.txt、ramdisk.img、resource.img、system.img、uboot.img、updater.img、userdata.img、vendor.img文件 - 后面自己修改源码（不涉及内核源码）后编译，可以烧录自己编译的
system.img、vendor.img、updater.img、userdata.img、ramdisk.img
为了帮助到大家能够更有效的学习OpenHarmony 开发的内容，下面特别准备了一些相关的参考学习资料：
OpenHarmony 开发环境搭建：https://qr18.cn/CgxrRy
《OpenHarmony源码解析》：https://qr18.cn/CgxrRy
- 搭建开发环境
- Windows 开发环境的搭建
- Ubuntu 开发环境搭建
- Linux 与 Windows 之间的文件共享
- ……
系统架构分析：https://qr18.cn/CgxrRy
- 构建子系统
- 启动流程
- 子系统
- 分布式任务调度子系统
- 分布式通信子系统
- 驱动子系统
- ……
OpenHarmony 设备开发学习手册：https://qr18.cn/CgxrRy
OpenHarmony面试题（内含参考答案）：https://qr18.cn/CgxrRy
![[数据结构]红黑树的原理及其实现](https://img-blog.csdnimg.cn/direct/970d169df6f34dc8b365d544fd78d418.png)
