鸿蒙5.0&next开发【利用Node-API扩展能力接口】NDK开发 ...

利用Node-API扩展能力接口

简介

[扩展能力]接口进一步扩展了Node-API的功能，提供了一些额外的接口，用于在Node-API模块中与ArkTS进行更灵活的交互和定制，这些接口可以用于创建自界说ArkTS对象等场景。
模块加载

接口描述

接口描述napi_load_module用于在Node-API模块中将abc文件作为模块加载，返回模块的命名空间，适用于需要在运行时动态加载模块或资源的应用程序，从而实现灵活的扩展和定制。napi_load_module_with_info用于在Node-API中进行模块的加载，当模块加载出来之后，可以利用函数napi_get_property获取模块导出的变量，也可以利用napi_get_named_property获取模块导出的函数，该函数可以在[新创建的ArkTs基础运行时情况]中利用。napi_module_register有些功能大概需要通过Node-API模块来实现以获得更好的性能，通过将这些功能实现为自界说模块并注册到ArkTS情况中，可以在肯定程度上提高团体的性能。 利用示例

napi_load_module

napi_load_module_with_info

napi_module_register

在ArkTS代码情况中利用Node-API模块编写的代码来实现特定的功能，可以将这部分功能封装成自界说模块，然后通过napi_module_register将其注册到ArkTS代码情况中，以实现功能的扩展和复用。
cpp部分代码

1. #include "napi/native_api.h"
3. // 此模块是一个Node-API的回调函数
4. static napi_value Add(napi_env env, napi_callback_info info)
5. {
6.     // 接受传入两个参数
7.     size_t requireArgc = 2;
8.     size_t argc = 2;
9.     napi_value args[2] = {nullptr};
10.     napi_get_cb_info(env, info, &argc, args , nullptr, nullptr);
12.     // 将传入的napi_value类型的参数转化为double类型
13.     double valueLeft;
14.     double valueRight;
15.     napi_get_value_double(env, args[0], &valueLeft);
16.     napi_get_value_double(env, args[1], &valueRight);
18.     // 将转化后的double值相加并转成napi_value返回给ArkTS代码使用
19.     napi_value sum;
20.     napi_create_double(env, valueLeft + valueRight, &sum);
22.     return sum;
23. }
25. // C++函数Init用于初始化插件，用于将ArkTS层的函数或属性与C++层的函数进行关联
26. EXTERN_C_START
27. static napi_value Init(napi_env env, napi_value exports)
28. {
29.     // 通过napi_property_descriptor结构体，可以定义需要导出的属性，并在Node-API模块中使用。napi_define_properties将属性与实际的C++函数进行关联，使其可以被ArkTS层访问和调用
30.     napi_property_descriptor desc[] = {
31.         { "add", nullptr, Add, nullptr, nullptr, nullptr, napi_default, nullptr }
32.     };
33.     napi_define_properties(env, exports, sizeof(desc) / sizeof(desc[0]), desc);
34.     return exports;
35. }
36. EXTERN_C_END
38. // 插件的初始化被定义在一个名为demoModule的结构体中，其中包含了模块的基本信息，比如模块的版本号、注册函数等
39. static napi_module demoModule = {
40.     .nm_version =1,
41.     .nm_flags = 0,
42.     .nm_filename = nullptr,
43.     .nm_register_func = Init,
44.     .nm_modname = "entry",
45.     .nm_priv = ((void*)0),
46.     .reserved = { 0 },
47. };
49. // 在RegisterEntryModule函数中，使用napi_module_register函数注册并导出了这个插件
50. extern "C" __attribute__((constructor)) void RegisterEntryModule(void)
51. {
52.     napi_module_register(&demoModule);
53. }
54. cpp

复制代码

接口声明

1. // index.d.ts
2. export const add: (a: number, b: number) => number;
3. ts

复制代码

ArkTS侧示例代码

1. import hilog from '@ohos.hilog'
2. import testNapi from 'libentry.so'
4. hilog.info(0x0000, 'testTag', 'Test Node-API 2 + 3 = %{public}d', testNapi.add(2, 3));
5. ts

复制代码

ArkTS Object相干

接口描述

接口描述napi_create_object_with_properties用于在Node-API模块中利用给定的napi_property_descriptor创建ArkTS Object。descriptor的键名必须为string，且不可转为number。napi_create_object_with_named_properties用于在Node-API模块中利用给定的napi_value和键名创建ArkTS Object。键名必须为string，且不可转为number。 利用示例

napi_create_object_with_properties

用给定的napi_property_descriptor作为属性去创建一个ArkTS对象，而且descriptor的键名必须为string，且不可转为number。
cpp部分代码

1. #include "napi/native_api.h"
3. static napi_value CreateObjectWithProperties(napi_env env, napi_callback_info info)
4. {
5.     size_t argc = 1;
6.     napi_value argv[1] = {nullptr};
7.     // 获取解析传递的参数
8.     napi_get_cb_info(env, info, &argc, argv, nullptr, nullptr);
9.     // 声明了一个napi_property_descriptor数组desc，其中包含了一个名为"name"的属性，其值为传入的第一个参数argv[0]。
10.     napi_property_descriptor desc[] = {
11.         {"name", nullptr, nullptr, nullptr, nullptr, argv[0], napi_default_jsproperty, nullptr}};
12.     napi_value object = nullptr;
13.     // 调用napi_create_object_with_properties来创建一个新的ArkTS对象，并将属性值添加到该对象中。
14.     napi_create_object_with_properties(env, &object, sizeof(desc) / sizeof(desc[0]), desc);
15.     napi_valuetype valueType;
16.     napi_typeof(env, object, &valueType);
17.     if (valueType == napi_object) {
18.         return object;
19.     }
20. }
21. cpp

复制代码

接口声明

1. // index.d.ts
2. export const createObjectWithProperties: (data: string) => Object;
3. ts

复制代码

ArkTS侧示例代码

1. import hilog from '@ohos.hilog'
2. import testNapi from 'libentry.so'
4. let value = testNapi.createObjectWithProperties('createObject');
5. hilog.info(0x0000, 'testTag', 'Node-API napi_create_object_with_properties:%{public}s', JSON.stringify(value));
6. ts

复制代码

napi_create_object_with_named_properties

用于利用给定的napi_value和键名创建一个ArkTS对象，而且给定的键名必须为string，且不可转为number。
cpp部分代码

1. #include "napi/native_api.h"
3. static napi_value CreateObjectWithNameProperties(napi_env env, napi_callback_info info)
4. {
5.     size_t argc = 1;
6.     napi_value argv[1] = {nullptr};
7.     // 获取解析传递的参数
8.     napi_get_cb_info(env, info, &argc, argv, nullptr, nullptr);
9.     napi_value obj = nullptr;
10.     const char *key[] = {
11.         "name",
12.     };
13.     const napi_value values[] = {
14.         argv[0],
15.     };
16.     napi_property_descriptor desc[] = {{"name", nullptr, nullptr,
17.                                         nullptr, nullptr, nullptr, napi_default, nullptr}};
18.     napi_status status;
19.     status = napi_create_object_with_named_properties(env, &obj, sizeof(desc) / sizeof(desc[0]), key, values);
20.     if (status != napi_ok) {
21.         return argv[0];
22.     }
23.     return obj;
24. }
25. cpp

复制代码

接口声明

1. // index.d.ts
2. export const createObjectWithNameProperties: (data: string) => string | { name: string };
3. ts

复制代码

ArkTS侧示例代码

1. import hilog from '@ohos.hilog'
2. import testNapi from 'libentry.so'
4. let value = testNapi.createObjectWithNameProperties('ls');
5. hilog.info(0x0000, 'testTag', 'Node-API napi_create_object_with_named_properties:%{public}s', JSON.stringify(value));
6. ts

复制代码

运行指定abc文件

接口描述

接口描述napi_run_script_path用于在Node-API模块中运行指定abc文件。 利用示例

napi_run_script_path

在Node-API模块中运行abc文件。
cpp部分代码

1. #include "napi/native_api.h"
3. static napi_value RunScriptPath(napi_env env, napi_callback_info info)
4. {
5.     napi_value value = nullptr;
6.     // 注意：记得在应用rawfile目录下放置.abc文件
7.     const char *scriptPath = "/entry/resources/rawfile/test.abc";
8.     // 使用napi_run_script_path函数执行指定路径中的文件
9.     napi_status status = napi_run_script_path(env, scriptPath, &value);
10.     // 检查是否执行成功，如果失败，返回false
11.     napi_value returnValue = nullptr;
12.     if (value == nullptr || status != napi_ok) {
13.         napi_get_boolean(env, false, &returnValue);
14.     } else {
15.         napi_get_boolean(env, true, &returnValue);
16.     }
17.     return returnValue;
18. }
19. cpp

复制代码

接口声明

1. // index.d.ts
2. export const runScriptPath: () => boolean;
3. ts

复制代码

ArkTS侧示例代码

1. import hilog from '@ohos.hilog'
2. import testNapi from 'libentry.so'
4. try {
5.   // 在此处执行错误返回false，成功就返回true
6.   hilog.info(0x0000, 'testTag', 'Test Node-API napi_run_script_path: %{public}s', testNapi.runScriptPath());
7. } catch (error) {
8.   hilog.error(0x0000, 'testTag', 'Test Node-API napi_run_script_path errorMessage: %{public}s', error.message);
9. }
10. ts

复制代码

test.js代码，将js代码编成.abc文件，步骤如下：

• 在SDK的ets/build-tools/ets-loader/bin/ark/build-win/bin目次下放置test.js文件
  
• 执行命令如es2abc.exe test.js --output test.abc后便可生成test.abc文件
  

放入指定路径中：/entry/resources/rawfile

1. function add(a, b) {
2.   return a+b;
3. }
4. add(1, 2);
5. js

复制代码

异步工尴尬刁难象加入队列并指定优先级

接口描述

接口描述napi_queue_async_work_with_qos用于将异步工尴尬刁难象加入队列，让开发者可以大概根据QoS优先级来管理和调理异步工作的执行，从而更好地满意程序的性能和相应需求。 利用示例

napi_queue_async_work_with_qos

将异步工尴尬刁难象加到队列，由底层根据传入的qos优先级去调理执行。
给ArkTS对象绑定回调和回调所需的参数

接口描述

接口描述napi_coerce_to_native_binding_object用于给ArkTS对象绑定回调和回调所需的参数，其作用是为了给ArkTS对象携带Native信息。 利用示例

napi_coerce_to_native_binding_object

用于给ArkTS Object绑定回调和回调所需的参数，给ArkTS Object携带Native信息。
cpp部分代码

1. #include <bits/alltypes.h>
2. #include <hilog/log.h>
3. #include <mutex>
4. #include <unordered_set>
5. #include <uv.h>
6. #include "napi/native_api.h"
8. class Object {
9. public:
10.     Object() = default;
11.     ~Object() = default;
13.     static Object* GetInstance()
14.     {
15.         Object* instance = new Object();
16.         return instance;
17.     }
19.     static napi_value GetAddress(napi_env env, napi_callback_info info)
20.     {
21.         napi_value thisVar = nullptr;
22.         napi_get_cb_info(env, info, nullptr, nullptr, &thisVar, nullptr);
23.         if (thisVar == nullptr) {
24.             return nullptr;
25.         }
26.         void* object = nullptr;
27.         napi_unwrap(env, thisVar, &object);
28.         if (object == nullptr) {
29.             return nullptr;
30.         }
31.         uint64_t addressVal = reinterpret_cast<uint64_t>(object);
32.         napi_value address = nullptr;
33.         napi_create_bigint_uint64(env, addressVal, &address);
34.         return address;
35.     }
37.     // 获取数组大小
38.     static napi_value GetSetSize(napi_env env, napi_callback_info info)
39.     {
40.         napi_value thisVar = nullptr;
41.         napi_get_cb_info(env, info, nullptr, nullptr, &thisVar, nullptr);
42.         if (thisVar == nullptr) {
43.             return nullptr;
44.         }
45.         void* object = nullptr;
46.         napi_unwrap(env, thisVar, &object);
47.         if (object == nullptr) {
48.             return nullptr;
49.         }
50.         std::lock_guard<std::mutex> lock(reinterpret_cast<Object*>(object)->numberSetMutex_);
51.         uint32_t setSize = reinterpret_cast<Object*>(object)->numberSet_.size();
52.         napi_value napiSize = nullptr;
53.         napi_create_uint32(env, setSize, &napiSize);
54.         return napiSize;
55.     }
57.     // 往数组里插入元素
58.     static napi_value Store(napi_env env, napi_callback_info info)
59.     {
60.         size_t argc = 1;
61.         napi_value args[1] = {nullptr};
62.         napi_value thisVar = nullptr;
63.         napi_get_cb_info(env, info, &argc, args, &thisVar, nullptr);
64.         if (argc != 1) {
65.             napi_throw_error(env, nullptr, "Store args number must be one.");
66.             return nullptr;
67.         }
68.         napi_valuetype type = napi_undefined;
69.         napi_typeof(env, args[0], &type);
70.         if (type != napi_number) {
71.             napi_throw_error(env, nullptr, "Store args is not number.");
72.             return nullptr;
73.         }
74.         if (thisVar == nullptr) {
75.             return nullptr;
76.         }
77.         uint32_t value = 0;
78.         napi_get_value_uint32(env, args[0], &value);
79.         void* object = nullptr;
80.         napi_unwrap(env, thisVar, &object);
81.         if (object == nullptr) {
82.             return nullptr;
83.         }
84.         std::lock_guard<std::mutex> lock(reinterpret_cast<Object*>(object)->numberSetMutex_);
85.         reinterpret_cast<Object *>(object)-> numberSet_.insert(value);
86.         return nullptr;
87.     }
89.     // 删除数组元素
90.     static napi_value Erase(napi_env env, napi_callback_info info)
91.     {
92.         size_t argc = 1;
93.         napi_value args[1] = {nullptr};
94.         napi_value thisVar = nullptr;
95.         napi_get_cb_info(env, info, &argc, args, &thisVar, nullptr);
96.         if (argc != 1) {
97.             napi_throw_error(env, nullptr, "Erase args number must be one.");
98.             return nullptr;
99.         }
100.         napi_valuetype type = napi_undefined;
101.         napi_typeof(env, args[0], &type);
102.         if (type != napi_number) {
103.             napi_throw_error(env, nullptr, "Erase args is not number.");
104.             return nullptr;
105.         }
106.         if (thisVar == nullptr) {
107.             return nullptr;
108.         }
109.         uint32_t value = 0;
110.         napi_get_value_uint32(env, args[0], &value);
111.         void* object = nullptr;
112.         napi_unwrap(env, thisVar, &object);
113.         if (object == nullptr) {
114.             return nullptr;
115.         }
116.         std::lock_guard<std::mutex> lock(reinterpret_cast<Object*>(object)->numberSetMutex_);
117.         reinterpret_cast<Object *>(object)->numberSet_.erase(value);
118.         return nullptr;
119.     }
121.     // 清空数组
122.     static napi_value Clear(napi_env env, napi_callback_info info)
123.     {
124.         napi_value thisVar = nullptr;
125.         napi_get_cb_info(env, info, nullptr, nullptr, &thisVar, nullptr);
126.         if (thisVar == nullptr) {
127.             return nullptr;
128.         }
129.         void* object = nullptr;
130.         napi_unwrap(env, thisVar, &object);
131.         if (object == nullptr) {
132.             return nullptr;
133.         }
134.         std::lock_guard<std::mutex> lock(reinterpret_cast<Object*>(object)->numberSetMutex_);
135.         reinterpret_cast<Object *>(object)->numberSet_.clear();
136.         return nullptr;
137.     }
139. private:
140.     Object(const Object &) = delete;
141.     Object &operator=(const Object &) = delete;
143.     std::unordered_set<uint32_t> numberSet_{};
144.     std::mutex numberSetMutex_{};
145. };
147. void FinializerCallback(napi_env env, void *data, void *hint)
148. {
149.     return;
150. }
152. // 解绑回调，在序列化时调用，可在对象解绑时执行一些清理操作
153. void* DetachCallback(napi_env env, void *value, void *hint)
154. {
155.     return value;
156. }
158. // 绑定回调，在反序列化时调用
159. napi_value AttachCallback(napi_env env, void* value, void* hint)
160. {
161.     napi_value object = nullptr;
162.     napi_create_object(env, &object);
163.     napi_property_descriptor desc[] = {
164.         {"getAddress", nullptr, Object::GetAddress, nullptr, nullptr, nullptr, napi_default, nullptr},
165.         {"getSetSize", nullptr, Object::GetSetSize, nullptr, nullptr, nullptr, napi_default, nullptr},
166.         {"store", nullptr, Object::Store, nullptr, nullptr, nullptr, napi_default, nullptr},
167.         {"erase", nullptr, Object::Erase, nullptr, nullptr, nullptr, napi_default, nullptr},
168.         {"clear", nullptr, Object::Clear, nullptr, nullptr, nullptr, napi_default, nullptr}};
169.     napi_define_properties(env, object, sizeof(desc) / sizeof(desc[0]), desc);
170.     // 将JS对象object和native对象value生命周期进行绑定
171.     napi_status status = napi_wrap(env, object, value, FinializerCallback, nullptr, nullptr);
172.     if (status != napi_ok) {
173.         OH_LOG_INFO(LOG_APP, "Node-API attachCallback is failed.");
174.     }
175.     // JS对象携带native信息
176.     napi_coerce_to_native_binding_object(env, object, DetachCallback, AttachCallback, value, hint);
177.     return object;
178. }
180. EXTERN_C_START
181. static napi_value Init(napi_env env, napi_value exports)
182. {
183.     napi_property_descriptor desc[] = {
184.         {"getAddress", nullptr, Object::GetAddress, nullptr, nullptr, nullptr, napi_default, nullptr},
185.         {"getSetSize", nullptr, Object::GetSetSize, nullptr, nullptr, nullptr, napi_default, nullptr},
186.         {"store", nullptr, Object::Store, nullptr, nullptr, nullptr, napi_default, nullptr},
187.         {"erase", nullptr, Object::Erase, nullptr, nullptr, nullptr, napi_default, nullptr},
188.         {"clear", nullptr, Object::Clear, nullptr, nullptr, nullptr, napi_default, nullptr}};
189.     napi_define_properties(env, exports, sizeof(desc) / sizeof(desc[0]), desc);
190.     auto object = Object::GetInstance();
191.     napi_status status = napi_wrap(env, exports, reinterpret_cast<void*>(object), FinializerCallback, nullptr, nullptr);
192.     if (status != napi_ok) {
193.         delete object;
194.     }
195.     napi_coerce_to_native_binding_object(env, exports, DetachCallback, AttachCallback, reinterpret_cast<void*>(object),
196.                                          nullptr);
197.     return exports;
198. }
199. EXTERN_C_END
201. static napi_module demoModule = {
202.     .nm_version = 1,
203.     .nm_flags = 0,
204.     .nm_filename = nullptr,
205.     .nm_register_func = Init,
206.     .nm_modname = "entry",
207.     .nm_priv = ((void*)0),
208.     .reserved = { 0 },
209. };
211. extern "C" __attribute__((constructor)) void RegisterEntryModule(void)
212. {
213.     napi_module_register(&demoModule);
214. }
215. cpp

复制代码

接口声明

1. // index.d.ts
2. export const getAddress: () => number;
3. export const getSetSize: () => number;
4. export const store: (a: number) => void;
5. export const erase: (a: number) => void;
6. export const clear: () => void;
7. ts

复制代码

ArkTS侧示例代码

1. // index.ets
2. import testNapi from 'libentry.so';
3. import taskpool from '@ohos.taskpool';
5. @Concurrent
6. function getAddress() {
7.   let address: number = testNapi.getAddress();
8.   console.info("taskpool:: address is " + address);
9. }
11. @Concurrent
12. function store(a:number, b:number, c:number) {
13.   let size:number = testNapi.getSetSize();
14.   console.info("set size is " + size + " before store");
15.   testNapi.store(a);
16.   testNapi.store(b);
17.   testNapi.store(c);
18.   size = testNapi.getSetSize();
19.   console.info("set size is " + size + " after store");
20. }
22. @Concurrent
23. function erase(a:number) {
24.   let size:number = testNapi.getSetSize();
25.   console.info("set size is " + size + " before erase");
26.   testNapi.erase(a);
27.   size = testNapi.getSetSize();
28.   console.info("set size is " + size + " after erase");
29. }
31. @Concurrent
32. function clear() {
33.   let size:number = testNapi.getSetSize();
34.   console.info("set size is " + size + " before clear");
35.   testNapi.clear();
36.   size = testNapi.getSetSize();
37.   console.info("set size is " + size + " after clear");
38. }
40. async function test01(): Promise<void> {
41.     let address:number = testNapi.getAddress();
42.     console.info("host thread address is " + address);
44.     let task1 = new taskpool.Task(getAddress);
45.     await taskpool.execute(task1);
47.     let task2 = new taskpool.Task(store, 1, 2, 3);
48.     await taskpool.execute(task2);
50.     let task3 = new taskpool.Task(store, 4, 5, 6);
51.     await taskpool.execute(task3);
53.     let task4 = new taskpool.Task(erase, 3);
54.     await taskpool.execute(task4);
56.     let task5 = new taskpool.Task(erase, 5);
57.     await taskpool.execute(task5);
59.     let task6 = new taskpool.Task(clear);
60.     await taskpool.execute(task6);
61. }
63. test01();
64. ts

复制代码

注意事项
对ArkTs对象A调用napi_coerce_to_native_binding_object将开发者实现的detach/attach回调和native对象信息加到A上，再将A跨线程传递。跨线程传递需要对A进行序列化和反序列化，在当火线程thread1序列化A得到数据data，序列化阶段执行detach回调。然后将data传给目标线程thread2，在thread2中反序列化data，执行attach回调，最终得到ArkTS对象A。

事件循环

接口描述

接口描述napi_run_event_loop触发底层的事件循环。napi_stop_event_loop停止底层的事件循环。 利用示例

napi_run_event_loop、napi_stop_event_loop

ArkTS基础运行时情况

接口描述

接口描述napi_create_ark_runtime创建基础运行时情况。napi_destroy_ark_runtime销毁基础运行时情况。 利用示例

napi_create_ark_runtime、napi_destroy_ark_runtime

序列化和反序列化

接口描述

接口描述napi_serialize将ArkTS对象转换为native数据。第一个参数env是接口执行的ArkTS情况；第二个参数object是待序列化的ArkTS对象；第三个参数transfer_list是存放需要以transfer传递的arrayBuffer的array，如不涉及可传undefined；第四个参数clone_list是存放需要克隆传递的Sendable对象的array，如不涉及可传undefined；第五个参数result是序列化结果。napi_deserialize将native数据转为ArkTS对象。第一个参数env是接口执行的ArkTS情况；第二个参数buffer是序列化数据；第三个参数object是反序列化得到的结果。napi_delete_serialization_data删除序列化数据。 利用示例

napi_serialize、napi_deserialize、napi_delete_serialization_data

用于将ArkTS对象转换为native数据、将native数据转为ArkTS对象、删除序列化数据等操作。
cpp部分代码

1. #include "napi/native_api.h"
3. static napi_value AboutSerialize(napi_env env, napi_callback_info info)
4. {
5.     // 获取传入的ts的一个对象作为参数
6.     size_t argc = 1;
7.     napi_value args[1] = {nullptr};
8.     napi_get_cb_info(env, info, &argc, args, nullptr, nullptr);
9.     napi_value undefined = nullptr;
10.     // 构造napi_serialize方法所需参数
11.     napi_get_undefined(env, &undefined);
12.     void *data = nullptr;
13.     // 调用napi_serialize方法将ts对象转化为native数据
14.     napi_status status = napi_serialize(env, args[0], undefined, undefined, &data);
15.     if (status != napi_ok ||data == nullptr) {
16.         napi_throw_error(env, nullptr, "Node-API napi_serialize fail");
17.         return nullptr;
18.     }
19.     // 构造napi_value类型的数据，用于接收将native数据转化为ts对象后的数据
20.     napi_value result = nullptr;
21.     napi_deserialize(env, data, &result);
22.     napi_value number = nullptr;
23.     // 获取native数据转化为ts对象后的数据中的numKey属性的值
24.     napi_get_named_property(env, result, "numKey", &number);
25.     // 判断获取到的属性值是否为number类型
26.     napi_valuetype valuetype;
27.     napi_typeof(env, number, &valuetype);
28.     if (valuetype != napi_number) {
29.         napi_throw_error(env, nullptr, "Node-API Wrong type of argument. Expects a number.");
30.         return nullptr;
31.     }
32.     // 调用napi_delete_serialization_data方法删除序列化数据
33.     napi_delete_serialization_data(env, data);
34.     // 返回获取到的属性值
35.     return number;
36. }
37. cpp

复制代码

接口声明

1. // index.d.ts
2. export const aboutSerialize: (obj: Object) => number;
3. ts

复制代码

ArkTS侧示例代码

1. import hilog from '@ohos.hilog'
2. import testNapi from 'libentry.so'
3. class Obj {
4.   numKey:number = 0;
5. }
6. let obj: Obj = { numKey: 500 };
7. hilog.info(0x0000, 'testTag', ' Node-API aboutSerialize: %{public}d', testNapi.aboutSerialize(obj));
8. ts

复制代码

根据使命指定的优先级和入队方式进行处理惩罚异步线程向ArkTS线程投递的使命

接口描述

接口描述napi_call_threadsafe_function_with_priority将指定优先级和入队方式的使命投递到ArkTS主线程。 利用示例

napi_call_threadsafe_function_with_priority

Sendable相干

接口描述

接口描述napi_is_sendable判定给定ArkTS value是否是Sendable的。napi_define_sendable_class创建一个sendable类。napi_create_sendable_object_with_properties利用给定的napi_property_descriptor创建一个sendable对象。napi_create_sendable_array创建一个sendable数组。napi_create_sendable_array_with_length创建一个指定长度的sendable数组。napi_create_sendable_arraybuffer创建一个sendable ArrayBuffer。napi_create_sendable_typedarray创建一个sendable TypedArray。napi_wrap_sendable包裹一个native实例到ArkTS对象中。napi_wrap_sendable_with_size包裹一个native实例到ArkTS对象中并指定大小。napi_unwrap_sendable获取ArkTS对象包裹的native实例。napi_remove_wrap_sendable移除并获取ArkTS对象包裹的native实例。 利用示例

napi_is_sendable

判定给定ArkTS value是否是Sendable的。
cpp部分代码

1. #include "napi/native_api.h"
3. static napi_value IsSendable(napi_env env, napi_callback_info info) {
4.     size_t argc = 1;
5.     napi_value args[1] = {nullptr};
6.     napi_get_cb_info(env, info, &argc, args, nullptr, nullptr);
7.     bool isSendable = false;
8.     napi_is_sendable(env, args[0], &isSendable);
9.     napi_value result;
10.     napi_get_boolean(env, isSendable, &result);
11.     return result;
12. }
13. cpp

复制代码

接口声明

1. // index.d.ts
2. export const isSendable: <T>(a: T) => boolean;
3. ts

复制代码

ArkTS侧示例代码

1. import hilog from '@ohos.hilog'
2. import testNapi from 'libentry.so'
4. let value = testNapi.isSendable('createObject');
5. hilog.info(0x0000, 'testTag', 'Node-API napi_is_sendable: %{public}s', JSON.stringify(value));
6. ts

复制代码

napi_define_sendable_class

创建一个sendable类。
cpp部分代码

1. #include "napi/native_api.h"
3. static napi_value func(napi_env env, napi_callback_info info) {
4.     napi_value val;
5.     napi_create_string_utf8(env, "func result", NAPI_AUTO_LENGTH, &val);
6.     return val;
7. }
9. static napi_value DefineSendableClass(napi_env env) {
10.     napi_value str;
11.     napi_create_string_utf8(env, "str", NAPI_AUTO_LENGTH, &str);
13.     napi_property_descriptor props[] = {
14.         {"staticStr", nullptr, nullptr, nullptr, nullptr, str,
15.          static_cast<napi_property_attributes>(napi_static | napi_writable), nullptr},
16.         {"staticFunc", nullptr, func, nullptr, nullptr, nullptr, napi_static, nullptr},
17.         {"str", nullptr, nullptr, nullptr, nullptr, str, static_cast<napi_property_attributes>(1 << 9 | napi_writable),
18.          nullptr},
19.         {"func", nullptr, nullptr, nullptr, nullptr, nullptr,
20.          static_cast<napi_property_attributes>(1 << 11 | napi_writable), nullptr},
21.     };
23.     napi_value sendableClass = nullptr;
24.     napi_define_sendable_class(
25.         env, "SendableClass", NAPI_AUTO_LENGTH,
26.         [](napi_env env, napi_callback_info info) -> napi_value {
27.             napi_value thisVar = nullptr;
28.             napi_get_cb_info(env, info, nullptr, nullptr, &thisVar, nullptr);
29.             napi_value str;
30.             napi_create_string_utf8(env, "instance str", NAPI_AUTO_LENGTH, &str);
31.             napi_property_descriptor props[] = {
32.                 {"str", nullptr, nullptr, nullptr, nullptr, str, napi_default, nullptr},
33.                 {"func", nullptr, func, nullptr, nullptr, nullptr, napi_default, nullptr},
34.             };
35.             napi_define_properties(env, thisVar, sizeof(props) / sizeof(props[0]), props);
36.             return thisVar;
37.         },
38.         nullptr, sizeof(props) / sizeof(props[0]), props, nullptr, &sendableClass);
40.     return sendableClass;
41. }
43. EXTERN_C_START
44. static napi_value Init(napi_env env, napi_value exports)
45. {
46.     napi_property_descriptor desc[] = {};
47.     napi_define_properties(env, exports, sizeof(desc) / sizeof(desc[0]), desc);
48.     napi_value cons = DefineSendableClass(env);
49.     napi_set_named_property(env, exports, "SendableClass", cons);
50.     return exports;
51. }
52. EXTERN_C_END
54. static napi_module demoModule = {
55.     .nm_version = 1,
56.     .nm_flags = 0,
57.     .nm_filename = nullptr,
58.     .nm_register_func = Init,
59.     .nm_modname = "entry",
60.     .nm_priv = ((void*)0),
61.     .reserved = { 0 },
62. };
64. extern "C" __attribute__((constructor)) void RegisterEntryModule(void)
65. {
66.     napi_module_register(&demoModule);
67. }
68. cpp

复制代码

接口声明

1. // index.d.ts
2. @Sendable
3. export class SendableClass {
4.   static staticStr: string;
5.   static staticFunc(): string;
6.   str: string;
7.   func(): string;
8. }
9. ts

复制代码

ArkTS侧示例代码

1. import hilog from '@ohos.hilog'
2. import testNapi from 'libentry.so'
4. let value = new testNapi.SendableClass();
5. hilog.info(0x0000, 'testTag', 'Node-API napi_define_sendable_class: %{public}s', value.str);
6. ts

复制代码

napi_create_sendable_object_with_properties

利用给定的napi_property_descriptor创建一个sendable对象。
cpp部分代码

1. #include "napi/native_api.h"
3. static napi_value GetSendableObject(napi_env env, napi_callback_info info) {
4.     napi_value val_true;
5.     napi_get_boolean(env, true, &val_true);
6.     napi_property_descriptor desc1[] = {
7.         {"x", nullptr, nullptr, nullptr, nullptr, val_true, napi_default_jsproperty, nullptr},
8.     };
9.     napi_value obj;
10.     napi_create_sendable_object_with_properties(env, 1, desc1, &obj);
11.     return obj;
12. }
13. cpp

复制代码

接口声明

1. // index.d.ts
2. export const getSendableObject: () => { x: true };
3. ts

复制代码

ArkTS侧示例代码

1. import hilog from '@ohos.hilog'
2. import testNapi from 'libentry.so'
4. let value = testNapi.getSendableObject();
5. hilog.info(0x0000, 'testTag', 'Node-API napi_create_sendable_object_with_properties: %{public}s', JSON.stringify(value));
6. ts

复制代码

napi_create_sendable_array

创建一个sendable数组。
cpp部分代码

1. #include "napi/native_api.h"
3. static napi_value GetSendableArray(napi_env env, napi_callback_info info) {
4.     napi_value result = nullptr;
5.     napi_create_sendable_array(env, &result);
6.     return result;
7. }
8. cpp

复制代码

接口声明

1. // index.d.ts
2. export const getSendableArray: () => [];
3. ts

复制代码

ArkTS侧示例代码

1. import hilog from '@ohos.hilog'
2. import testNapi from 'libentry.so'
4. let value = testNapi.getSendableArray();
5. hilog.info(0x0000, 'testTag', 'Node-API napi_create_sendable_array: %{public}s', JSON.stringify(value));
6. ts

复制代码

napi_create_sendable_array_with_length

创建一个指定长度的sendable数组。
cpp部分代码

1. static napi_value GetSendableArrayWithLength(napi_env env, napi_callback_info info) {
2.     napi_value result = nullptr;
3.     napi_create_sendable_array_with_length(env, 1, &result);
4.     return result;
5. }
6. cpp

复制代码

接口声明

1. // index.d.ts
2. export const getSendableArrayWithLength: () => [];
3. ts

复制代码

ArkTS侧示例代码

1. import hilog from '@ohos.hilog'
2. import testNapi from 'libentry.so'
4. let value = testNapi.getSendableArrayWithLength();
5. hilog.info(0x0000, 'testTag', 'Node-API napi_create_sendable_array_with_length: %{public}s', JSON.stringify(value.length));
6. ts

复制代码

napi_create_sendable_arraybuffer

创建一个sendable ArrayBuffer。
cpp部分代码

1. #include "napi/native_api.h"
2. #include "hilog/log.h"
4. static napi_value GetSendableArrayBuffer(napi_env env, napi_callback_info info) {
5.     static size_t LENGTH = 1024;
6.     void *data;
7.     napi_value result = nullptr;
8.     napi_create_sendable_arraybuffer(env, LENGTH, &data, &result);
9.     bool isArrayBuffer = false;
10.     napi_is_arraybuffer(env, result, &isArrayBuffer);
11.     OH_LOG_INFO(LOG_APP, "isArrayBuffer: %{public}d", isArrayBuffer);
12.     return result;
13. }
14. cpp

复制代码

接口声明

1. // index.d.ts
2. export const getSendableArrayBuffer: () => void;
3. ts

复制代码

ArkTS侧示例代码

1. import hilog from '@ohos.hilog'
2. import testNapi from 'libentry.so'
4. testNapi.getSendableArrayBuffer();
5. ts

复制代码

napi_create_sendable_typedarray

创建一个sendable TypedArray。
cpp部分代码

1. #include "napi/native_api.h"
2. #include "hilog/log.h"
4. static napi_value GetSendableTypedArray(napi_env env, napi_callback_info info) {
5.     static size_t LENGTH = 1024;
6.     static size_t OFFSET = 0;
7.     void *data;
8.     napi_value arraybuffer = nullptr;
9.     napi_create_sendable_arraybuffer(env, LENGTH, &data, &arraybuffer);
11.     napi_value result = nullptr;
12.     napi_create_sendable_typedarray(env, napi_uint8_array, LENGTH, arraybuffer, OFFSET, &result);
13.     bool isTypedArray = false;
14.     napi_is_typedarray(env, result, &isTypedArray);
15.     OH_LOG_INFO(LOG_APP, "isTypedArray: %{public}d", isTypedArray);
16.     return result;
17. }
18. cpp

复制代码

接口声明

1. // index.d.ts
2. export const getSendableTypedArray: () => void;
3. ts

复制代码

ArkTS侧示例代码

1. import hilog from '@ohos.hilog'
2. import testNapi from 'libentry.so'
4. testNapi.getSendableTypedArray();
5. ts

复制代码

napi_wrap_sendable

包裹一个native实例到ArkTS对象中。
cpp部分代码

1. #include "napi/native_api.h"
3. static napi_value WrapSendable(napi_env env, napi_callback_info info) {
4.     napi_value val_true;
5.     napi_get_boolean(env, true, &val_true);
6.     napi_property_descriptor desc1[] = {
7.         {"x", nullptr, nullptr, nullptr, nullptr, val_true, napi_default_jsproperty, nullptr},
8.     };
9.     napi_value obj;
10.     napi_create_sendable_object_with_properties(env, 1, desc1, &obj);
12.     const char* testStr = "test";
13.     napi_wrap_sendable(env, obj, (void*)testStr, [](napi_env env, void* data, void* hint) {}, nullptr);
15.     return nullptr;
16. }
17. cpp

复制代码

接口声明

1. // index.d.ts
2. export const wrapSendable: () => void;
3. ts

复制代码

ArkTS侧示例代码

1. import hilog from '@ohos.hilog'
2. import testNapi from 'libentry.so'
4. testNapi.wrapSendable();
5. ts

复制代码

napi_wrap_sendable_with_size

包裹一个native实例到ArkTS对象中并指定大小。
cpp部分代码

1. #include "napi/native_api.h"
3. static napi_value WrapSendableWithSize(napi_env env, napi_callback_info info) {
4.     napi_value val_true;
5.     napi_get_boolean(env, true, &val_true);
6.     napi_property_descriptor desc1[] = {
7.         {"x", nullptr, nullptr, nullptr, nullptr, val_true, napi_default_jsproperty, nullptr},
8.     };
9.     napi_value obj;
10.     napi_create_sendable_object_with_properties(env, 1, desc1, &obj);
12.     const char* testStr = "test";
13.     napi_wrap_sendable_with_size(env, obj, (void*)testStr, [](napi_env env, void* data, void* hint) {}, nullptr, 100);
15.     return nullptr;
16. }
17. cpp

复制代码

接口声明

1. // index.d.ts
2. export const wrapSendableWithSize: () => void;
3. ts

复制代码

ArkTS侧示例代码

1. import hilog from '@ohos.hilog'
2. import testNapi from 'libentry.so'
4. testNapi.wrapSendableWithSize();
5. ts

复制代码

napi_unwrap_sendable

获取ArkTS对象包裹的native实例。
cpp部分代码

1. #include "napi/native_api.h"
3. static napi_value UnwrapSendable(napi_env env, napi_callback_info info) {
4.     napi_value val_true;
5.     napi_get_boolean(env, true, &val_true);
6.     napi_property_descriptor desc1[] = {
7.         {"x", nullptr, nullptr, nullptr, nullptr, val_true, napi_default_jsproperty, nullptr},
8.     };
9.     napi_value obj;
10.     napi_create_sendable_object_with_properties(env, 1, desc1, &obj);
12.     const char* testStr = "test";
13.     napi_wrap_sendable(env, obj, (void*)testStr, [](napi_env env, void* data, void* hint) {}, nullptr);
15.     char* tmpTestStr = nullptr;
16.     napi_unwrap_sendable(env, obj, (void**)&tmpTestStr);
17.     OH_LOG_INFO(LOG_APP, "native value is %{public}s", tmpTestStr);
19.     return nullptr;
20. }
21. cpp

复制代码

接口声明

1. // index.d.ts
2. export const unwrapSendable: () => void;
3. ts

复制代码

ArkTS侧示例代码

1. import hilog from '@ohos.hilog'
2. import testNapi from 'libentry.so'
4. testNapi.unwrapSendable();
5. ts

复制代码

napi_remove_wrap_sendable

移除并获取ArkTS对象包裹的native实例。
cpp部分代码

1. #include "napi/native_api.h"
3. static napi_value RemoveWrapSendable(napi_env env, napi_callback_info info) {
4.     napi_value val_true;
5.     napi_get_boolean(env, true, &val_true);
6.     napi_property_descriptor desc1[] = {
7.         {"x", nullptr, nullptr, nullptr, nullptr, val_true, napi_default_jsproperty, nullptr},
8.     };
9.     napi_value obj;
10.     napi_create_sendable_object_with_properties(env, 1, desc1, &obj);
12.     const char* testStr = "test";
13.     napi_wrap_sendable(env, obj, (void*)testStr, [](napi_env env, void* data, void* hint) {}, nullptr);
15.     char* tmpTestStr = nullptr;
16.     napi_remove_wrap_sendable(env, obj, (void**)&tmpTestStr);
17.     OH_LOG_INFO(LOG_APP, "native value is %{public}s", tmpTestStr);
19.     return nullptr;
20. }
21. cpp

复制代码

接口声明

1. // index.d.ts
2. export const removeWrapSendable: () => void;
3. ts

复制代码

ArkTS侧示例代码

1. import hilog from '@ohos.hilog'
2. import testNapi from 'libentry.so'
4. testNapi.removeWrapSendable();
5. ts

复制代码

以上代码假如要在native cpp中打印日志，需在CMakeLists.txt文件中添加以下设置信息（并添加头文件：#include “hilog/log.h”）：

1. // CMakeLists.txt
2. add_definitions( "-DLOG_DOMAIN=0xd0d0" )
3. add_definitions( "-DLOG_TAG="testTag"" )
4. target_link_libraries(entry PUBLIC libhilog_ndk.z.so)

复制代码

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。