1# 使用Node-API接口进行线程安全开发 2 3 4## 场景介绍 5 6napi_create_threadsafe_function是Node-API接口之一，用于创建一个线程安全的JavaScript函数。主要用于在多个线程之间共享和调用，而不会出现竞争条件或死锁。例如以下场景： 7 8 9- 异步计算：如果需要进行耗时的计算或IO操作，可以创建一个线程安全的函数，将计算或IO操作放在另一个线程中执行，避免阻塞主线程，提高程序的响应速度。 10 11- 数据共享：如果多个线程需要访问同一份数据，可以创建一个线程安全的函数，确保数据的读写操作不会发生竞争条件或死锁等问题。 12 13- 多线程编程：如果需要进行多线程编程，可以创建一个线程安全的函数，确保多个线程之间的通信和同步操作正确无误。 14 15 16## 使用示例 17 181. 在Native入口定义线程安全函数。 19 ```c++ 20 struct CallbackData { 21 napi_threadsafe_function tsfn; 22 napi_async_work work; 23 }; 24 25 static napi_value StartThread(napi_env env, napi_callback_info info) 26 { 27 size_t argc = 1; 28 napi_value jsCb = nullptr; 29 CallbackData *callbackData = nullptr; 30 napi_get_cb_info(env, info, &argc, &jsCb, nullptr, reinterpret_cast<void **>(&callbackData)); 31 32 // 创建一个线程安全函数 33 napi_value resourceName = nullptr; 34 napi_create_string_utf8(env, "Thread-safe Function Demo", NAPI_AUTO_LENGTH, &resourceName); 35 napi_create_threadsafe_function(env, jsCb, nullptr, resourceName, 0, 1, callbackData, nullptr, 36 callbackData, CallJs, &callbackData->tsfn); 37 38 // 创建一个异步任务 39 napi_create_async_work(env, nullptr, resourceName, ExecuteWork, WorkComplete, callbackData, 40 &callbackData->work); 41 42 // 将异步任务加入到异步队列中 43 napi_queue_async_work(env, callbackData->work); 44 return nullptr; 45 } 46 ``` 47 482. 在工作线程中调用ExecuteWork，并执行线程安全函数。 49 ```c++ 50 static void ExecuteWork(napi_env env, void *data) 51 { 52 CallbackData *callbackData = reinterpret_cast<CallbackData *>(data); 53 std::promise<std::string> promise; 54 auto future = promise.get_future(); 55 napi_call_threadsafe_function(callbackData->tsfn, &promise, napi_tsfn_nonblocking); 56 try { 57 auto result = future.get(); 58 // OH_LOG_INFO(LOG_APP, "XXX, Result from JS %{public}s", result.c_str()); 59 } catch (const std::exception &e) { 60 // OH_LOG_INFO(LOG_APP, "XXX, Result from JS %{public}s", e.what()); 61 } 62 } 63 ``` 64 653. 在JS线程执行异步回调函数。 66 ```c++ 67 static napi_value ResolvedCallback(napi_env env, napi_callback_info info) 68 { 69 void *data = nullptr; 70 size_t argc = 1; 71 napi_value argv[1]; 72 if (napi_get_cb_info(env, info, &argc, argv, nullptr, &data) != napi_ok) { 73 return nullptr; 74 } 75 size_t result = 0; 76 char buf[32] = {0}; 77 napi_get_value_string_utf8(env, argv[0], buf, 32, &result); 78 reinterpret_cast<std::promise<std::string> *>(data)->set_value(std::string(buf)); 79 return nullptr; 80 } 81 82 static napi_value RejectedCallback(napi_env env, napi_callback_info info) 83 { 84 void *data = nullptr; 85 if (napi_get_cb_info(env, info, nullptr, nullptr, nullptr, &data) != napi_ok) { 86 return nullptr; 87 } 88 reinterpret_cast<std::promise<std::string> *>(data)->set_exception( 89 std::make_exception_ptr(std::runtime_error("Error in jsCallback"))); 90 return nullptr; 91 } 92 93 static void CallJs(napi_env env, napi_value jsCb, void *context, void *data) 94 { 95 if (env == nullptr) { 96 return; 97 } 98 napi_value undefined = nullptr; 99 napi_value promise = nullptr; 100 napi_get_undefined(env, &undefined); 101 napi_call_function(env, undefined, jsCb, 0, nullptr, &promise); 102 napi_value thenFunc = nullptr; 103 if (napi_get_named_property(env, promise, "then", &thenFunc) != napi_ok) { 104 return; 105 } 106 napi_value resolvedCallback; 107 napi_value rejectedCallback; 108 napi_create_function(env, "resolvedCallback", NAPI_AUTO_LENGTH, ResolvedCallback, data, 109 &resolvedCallback); 110 napi_create_function(env, "rejectedCallback", NAPI_AUTO_LENGTH, RejectedCallback, data, 111 &rejectedCallback); 112 napi_value argv[2] = {resolvedCallback, rejectedCallback}; 113 napi_call_function(env, promise, thenFunc, 2, argv, nullptr); 114 } 115 ``` 116 1174. 任务执行完成后，进行资源清理回收。 118 ```c++ 119 static void WorkComplete(napi_env env, napi_status status, void *data) 120 { 121 CallbackData *callbackData = reinterpret_cast<CallbackData *>(data); 122 napi_release_threadsafe_function(callbackData->tsfn, napi_tsfn_release); 123 napi_delete_async_work(env, callbackData->work); 124 callbackData->tsfn = nullptr; 125 callbackData->work = nullptr; 126 } 127 ``` 128 1295. 模块初始化以及ArkTS侧调用接口。 130 ``` 131 // 模块初始化 132 static napi_value Init(napi_env env, napi_value exports) { 133 CallbackData *callbackData = new CallbackData(); // 可在线程退出时释放 134 napi_property_descriptor desc[] = { 135 {"startThread", nullptr, StartThread, nullptr, nullptr, nullptr, napi_default, callbackData}, 136 }; 137 napi_define_properties(env, exports, sizeof(desc) / sizeof(desc[0]), desc); 138 return exports; 139 } 140 141 // ArkTS侧调用接口 142 import nativeModule from 'libentry.so'; // 通过import的方式，引入Native能力 143 144 let callback = (): Promise<string> => { 145 return new Promise((resolve) => { 146 setTimeout(() => { 147 resolve("string from promise"); 148 }, 5000); 149 }); 150 } 151 nativeModule.startThread(callback); 152 ``` 153