1# Node-API常见问题
2
3## ArkTS/JS侧import xxx from libxxx.so后，使用xxx报错显示undefined/not callable或明确的Error message
4
51. 排查.cpp文件在注册模块时的模块名称与so的名称匹配一致。
6   如模块名为entry，则so的名字为libentry.so，napi_module中nm_modname字段应为entry，大小写与模块名保持一致。
7
82. 排查so是否加载成功。
9   应用启动时过滤模块加载相关日志，重点搜索"dlopen"关键字，确认是否有相关报错信息；常见加载失败原因有权限不足、so文件不存在以及so已拉入黑名单等，可根据以下关键错误日志确认问题。其中，多线程场景(worker、taskpool等)下优先检查模块实现中nm_modname是否与模块名一致，区分大小写。
10
113. 排查依赖的so是否加载成功。
12   确定所依赖的其它so是否打包到应用中以及是否有权限打开。常见加载失败原因有权限不足、so文件不存在等，可根据以下关键错误日志确认问题。
13
144. 排查模块导入方式与so路径是否对应。
15   若JS侧导入模块的形式为： import xxx from '\@ohos.yyy.zzz'，则该so将在/system/lib/module/yyy中找libzzz.z.so或libzzz_napi.z.so，若so不存在或名称无法对应，则报错日志中会出现dlopen相关日志。
16
17   注意，32位系统路径为/system/lib，64位系统路径为/system/lib64。
18
19| **已知关键错误日志** | **修改建议** |
20| -------- | -------- |
21| module $SO is not allowed to load in restricted runtime | $SO表示模块名。该模块不在受限worker线程的so加载白名单，不允许加载，建议用户删除该模块。 |
22| module $SO is in blocklist, loading prohibited | $SO表示模块名。受卡片或者Extension管控，该模块在黑名单内，不允许加载，建议用户删除该模块。 |
23| load module failed. $ERRMSG | 动态库加载失败。$ERRMSG表示加载失败原因，一般常见原因是so文件不存在、依赖的so文件不存在或者符号未定义，需根据加载失败原因具体分析。 |
24| try to load abc file from $FILEPATH failed. | 通常加载动态库和abc文件为二选一：如果是要加载动态库并且加载失败，该告警可以忽略；如果是要加载abc文件，则该错误打印的原因是abc文件不存在，$FILEPATH表示模块路径。 |
25
265. 如果有明确的Error message，可以通过Error message判断当前问题。
27
28| **Error message** | **修改建议** |
29| -------- | -------- |
30| First attempt: $ERRMSG | 首先加载后缀不拼接'_napi'的模块名为'xxx'的so，如果加载失败会有该错误信息，$ERRMSG表示具体加载时的错误信息。 |
31| Second attempt: $ERRMSG | 第二次加载后缀拼接'_napi'的模块名为'xxx_napi'的so，如果加载失败会有该错误信息，$ERRMSG表示具体加载时的错误信息。 |
32| try to load abc file from xxx failed | 第三次加载名字为'xxx'的abc文件，如果加载失败会有该错误信息。 |
33| module xxx is not allowed to load in restricted runtime. | 该模块不允许在受限运行时中使用，xxx表示模块名，建议用户删除该模块。 |
34| module xxx is in blocklist, loading prohibited. | 该模块不允许在当前extension下使用，xxx表示模块名，建议用户删除该模块。 |
35
36## 接口执行结果非预期，日志显示occur exception need return
37
38部分Node-API接口在调用结束前会进行检查，检查虚拟机中是否存在JS异常。如果存在异常，则会打印出occur exception need return日志，并打印出检查点所在的行号，以及对应的Node-API接口名称。
39
40解决此类问题有以下两种思路：
41
42- 若该异常开发者不关心，可以选择直接清除。
43  可直接使用napi接口napi_get_and_clear_last_exception，清理异常。调用时机：在打印occur exception need return日志的接口之前调用。
44
45- 将该异常继续向上抛到ArkTS层，在ArkTS层进行捕获。
46  发生异常时，可以选择走异常分支， 确保不再走多余的Native逻辑 ，直接返回到ArkTS层。
47
48## napi_value和napi_ref的生命周期有何区别
49
50- native_value由HandleScope管理，一般开发者不需要自己加HandleScope（uv_queue_work的complete callback除外）。
51
52- napi_ref由开发者自己管理，需要手动delete。
53
54## Node-API接口返回值不是napi_ok时，如何排查定位
55
56Node-API接口正常执行后，会返回一个napi_ok的状态枚举值，若napi接口返回值不为napi_ok，可从以下几个方面进行排查。
57
58- Node-API接口执行前一般会进行入参校验，首先进行的是判空校验。在代码中体现为：
59
60  ```cpp
61  CHECK_ENV： env判空校验
62  CHECK_ARG：其它入参判空校验
63  ```
64
65- 某些Node-API接口还有入参类型校验。比如napi_get_value_double接口是获取JS number对应的C double值，首先就要保证的是：JS value类型为number，因此可以看到相关校验。
66
67  ```cpp
68  RETURN_STATUS_IF_FALSE(env, nativeValue->TypeOf() == NATIVE_NUMBER, napi_number_expected);
69  ```
70
71- 还有一些接口会对其执行结果进行校验。比如napi_call_function这个接口，其功能是执行一个JS function，当JS function中出现异常时，Node-API将会返回napi_pending_exception的状态值。
72
73  ```cpp
74  auto resultValue = engine->CallFunction(nativeRecv, nativeFunc, nativeArgv, argc);
75  RETURN_STATUS_IF_FALSE(env, resultValue != nullptr, napi_pending_exception)
76  ```
77
78- 还有一些状态值需要根据相应Node-API接口具体分析：确认具体的状态值，分析这个状态值在什么情况下会返回，再排查具体出错原因。
79
80## napi_threadsafe_function内存泄漏，应该如何处理
81
82`napi_threadsafe_function`（下文简称tsfn）在使用时，常常会调用 `napi_acquire_threadsafe_function` 来更改tsfn的引用计数，确保tsfn不会意外被释放。但在使用完成后，应该及时使用 `napi_tsfn_release` 模式调用 `napi_release_threadsafe_function` 方法，以确保在所有调用回调都执行完成后，其引用计数能回归到调用 `napi_acquire_threadsafe_function` 方法之前的水平。当其引用计数归位0时，tsfn才能正确的被释放。
83
84当在env即将退出，但tsfn的引用计数未被归零时，应该使用 `napi_tsfn_abort` 模式调用 `napi_release_threadsafe_function` 方法，确保在env释放后不再对tsfn进行持有及使用。在env退出后，继续持有tsfn进行使用，是一种未定义的行为，可能会触发崩溃。
85
86如下代码将展示通过注册 `env_cleanup` 钩子函数的方式，以确保在env退出后不再继续持有tsfn。
87
88```cpp
89#include <hilog/log.h> // hilog, 输出日志, 需链接 libhilog_ndk.z.so
90#include <thread> // 创建线程
91#include <unistd.h> // 线程休眠
92
93// 定义输出日志的标签和域
94#undef LOG_DOMAIN
95#undef LOG_TAG
96#define LOG_DOMAIN 0x2342
97#define LOG_TAG "MY_TSFN_DEMO"
98
99/*
100  为构造一个env生命周期小于native生命周期的场景,
101  本文需要使用worker, taskpool 或 napi_create_ark_runtime 等方法,
102  创建非主线程的ArkTS运行环境，并人为的提前结束掉该线程
103*/
104
105
106// 定义一个数据结构，模拟存储tsfn的场景
107class MyTsfnContext {
108public:
109// 因使用了napi方法, MyTsfnContext 应当只在js线程被构造
110MyTsfnContext(napi_env env, napi_value workName) {
111    // 注册env销毁钩子函数
112    napi_add_env_cleanup_hook(env, Cleanup, this);
113    // 创建线程安全函数
114    if (napi_create_threadsafe_function(env, nullptr, nullptr, workName, 1, 1, this,
115            TsfnFinalize, this, TsfnCallJs, &tsfn_) != napi_ok) {
116        OH_LOG_INFO(LOG_APP, "tsfn is created faild");
117        return;
118    };
119};
120
121~MyTsfnContext() { OH_LOG_INFO(LOG_APP, "MyTsfnContext is deconstructed"); };
122
123napi_threadsafe_function GetTsfn() {
124    std::unique_lock<std::mutex> lock(mutex_);
125    return tsfn_;
126}
127
128bool Acquire() {
129    if (GetTsfn() == nullptr) {
130        return false;
131    };
132    return (napi_acquire_threadsafe_function(GetTsfn()) == napi_ok);
133};
134
135bool Release() {
136    if (GetTsfn() == nullptr) {
137        return false;
138    };
139    return (napi_release_threadsafe_function(GetTsfn(), napi_tsfn_release) == napi_ok);
140};
141
142bool Call(void *data) {
143    if (GetTsfn() == nullptr) {
144        return false;
145    };
146    return (napi_call_threadsafe_function(GetTsfn(), data, napi_tsfn_blocking) == napi_ok);
147};
148
149private:
150// 保护多线程读写tsfn的准确性
151std::mutex mutex_;
152napi_threadsafe_function tsfn_ = nullptr;
153
154// napi_add_env_cleanup_hook 回调
155static void Cleanup(void *data) {
156    MyTsfnContext *that = reinterpret_cast<MyTsfnContext *>(data);
157    napi_threadsafe_function tsfn = that->GetTsfn();
158    std::unique_lock<std::mutex> lock(that->mutex_);
159    that->tsfn_ = nullptr;
160    lock.unlock();
161    OH_LOG_WARN(LOG_APP, "cleanup is called");
162    napi_release_threadsafe_function(tsfn, napi_tsfn_abort);
163};
164
165// tsfn 释放时的回调
166static void TsfnFinalize(napi_env env, void *data, void *hint) {
167    MyTsfnContext *ctx = reinterpret_cast<MyTsfnContext *>(data);
168    OH_LOG_INFO(LOG_APP, "tsfn is released");
169    napi_remove_env_cleanup_hook(env, MyTsfnContext::Cleanup, ctx);
170    // cleanup 提前释放线程安全函数, 为避免UAF, 将释放工作交给调用方
171    if (ctx->GetTsfn() != nullptr) {
172        OH_LOG_INFO(LOG_APP, "ctx is released");
173        delete ctx;
174    }
175};
176
177// tsfn 发送到 js 线程执行的回调
178static void TsfnCallJs(napi_env env, napi_value func, void *context, void *data) {
179    MyTsfnContext *ctx = reinterpret_cast<MyTsfnContext *>(context);
180    char *str = reinterpret_cast<char *>(data);
181    OH_LOG_INFO(LOG_APP, "tsfn is called, data is: \"%{public}s\"", str);
182    // 业务逻辑已省略
183};
184};
185
186// 该方法需注册到模块, 注册名为 myTsfnDemo, 接口描述如下
187// export const myTsfnDemo: () => void;
188napi_value MyTsfnDemo(napi_env env, napi_callback_info info) {
189    OH_LOG_ERROR(LOG_APP, "MyTsfnDemo is called");
190    napi_value workName = nullptr;
191    napi_create_string_utf8(env, "MyTsfnWork", NAPI_AUTO_LENGTH, &workName);
192    MyTsfnContext *myContext = new MyTsfnContext(env, workName);
193    if (myContext->GetTsfn() == nullptr) {
194        OH_LOG_ERROR(LOG_APP, "faild to create tsfn");
195        delete myContext;
196        return nullptr;
197    };
198    char *data0 = new char[]{"Im call in ArkTS Thread"};
199    if (!myContext->Call(data0)) {
200        OH_LOG_INFO(LOG_APP, "call tsfn failed");
201    };
202
203    // 创建一个线程，模拟异步场景
204    std::thread(
205        [](MyTsfnContext *myCtx) {
206            if (!myCtx->Acquire()) {
207                OH_LOG_ERROR(LOG_APP, "acquire tsfn faild");
208                return;
209            };
210            char *data1 = new char[]{"Im call in std::thread"};
211            // 非必要操作, 仅用于异步流程tsfn仍有效
212            if (!myCtx->Call(data1)) {
213                OH_LOG_ERROR(LOG_APP, "call tsfn failed");
214            };
215            // 休眠 5s, 模拟耗时场景, env退出后, 异步任务仍未执行完成
216            sleep(5);
217            // 此时异步任务已执行完成, 但tsfn已被释放并置为 nullptr
218            char *data2 = new char[]{"Im call after work"};
219            if (!myCtx->Call(data2) && !myCtx->Release()) {
220                OH_LOG_ERROR(LOG_APP, "call and release tsfn failed");
221                delete myCtx;
222            }
223        },
224        myContext)
225        .detach();
226    return nullptr;
227};
228```
229
230以下内容为主线程逻辑，主要用作创建worker线程和通知worker执行任务
231
232```ts
233// 主线程
234import worker, { MessageEvents } from '@ohos.worker';
235
236const mWorker = new worker.ThreadWorker('../workers/Worker');
237mWorker.onmessage = (e: MessageEvents) => {
238    const action: string | undefined = e.data?.action;
239    if (action === 'kill') {
240        mWorker.terminate();
241    }
242}
243
244// 触发方式的注册已省略
245mWorker.postMessage({action: 'tsfn-demo'})
246
247```
248
249以下内容为Worker线程逻辑，主要用以触发Native任务
250
251```ts
252// worker.ets
253import worker, { ThreadWorkerGlobalScope, MessageEvents, ErrorEvent } from '@ohos.worker';
254import napiModule from 'libentry.so'; // libentry.so: napi 库的模块名称
255
256const workerPort: ThreadWorkerGlobalScope = worker.workerPort;
257
258workerPort.onmessage = (e: MessageEvents) => {
259    const action: string | undefined = e.data?.action;
260    if (action === 'tsfn-demo') {
261        // 触发 c++ 层的 tsfn demo
262        napiModule.myTsfnDemo();
263        // 通知主线程结束 worker
264        workerPort.postMessage({action: 'kill'});
265    };
266}
267```
268