场景介绍
napi_create_threadsafe_function是Node-API接口之一,用于创建一个线程安全的JavaScript函数。主要用于在多个线程之间共享和调用,而不会出现竞争条件或死锁。例如以下场景:
-
异步计算:如果需要进行耗时的计算或IO操作,可以创建一个线程安全的函数,将计算或IO操作放在另一个线程中执行,避免阻塞主线程,提高程序的响应速度。
-
数据共享:如果多个线程需要访问同一份数据,可以创建一个线程安全的函数,确保数据的读写操作不会发生竞争条件或死锁等问题。
-
多线程编程:如果需要进行多线程编程,可以创建一个线程安全的函数,确保多个线程之间的通信和同步操作正确无误。
使用示例
- 在Native入口定义线程安全函数。
struct CallbackData {
napi_threadsafe_function tsfn;
napi_async_work work;
};
static napi_value StartThread(napi_env env, napi_callback_info info)
{
size_t argc = 1;
napi_value jsCb = nullptr;
CallbackData *callbackData = nullptr;
napi_get_cb_info(env, info, &argc, &jsCb, nullptr, reinterpret_cast<void **>(&callbackData));
// 创建一个线程安全函数
napi_value resourceName = nullptr;
napi_create_string_utf8(env, "Thread-safe Function Demo", NAPI_AUTO_LENGTH, &resourceName);
napi_create_threadsafe_function(env, jsCb, nullptr, resourceName, 0, 1, callbackData, nullptr,
callbackData, CallJs, &callbackData->tsfn);
// 创建一个异步任务
napi_create_async_work(env, nullptr, resourceName, ExecuteWork, WorkComplete, callbackData,
&callbackData->work);
// 将异步任务加入到异步队列中
napi_queue_async_work(env, callbackData->work);
return nullptr;
}
- 在工作线程中调用ExecuteWork,并执行线程安全函数。
static void ExecuteWork(napi_env env, void *data)
{
CallbackData *callbackData = reinterpret_cast<CallbackData *>(data);
std::promise<std::string> promise;
auto future = promise.get_future();
napi_call_threadsafe_function(callbackData->tsfn, &promise, napi_tsfn_nonblocking);
try {
auto result = future.get();
// OH_LOG_INFO(LOG_APP, "XXX, Result from JS %{public}s", result.c_str());
} catch (const std::exception &e) {
// OH_LOG_INFO(LOG_APP, "XXX, Result from JS %{public}s", e.what());
}
}
- 在JS线程执行异步回调函数。
static napi_value ResolvedCallback(napi_env env, napi_callback_info info)
{
void *data = nullptr;
size_t argc = 1;
napi_value argv[1];
if (napi_get_cb_info(env, info, &argc, argv, nullptr, &data) != napi_ok) {
return nullptr;
}
size_t result = 0;
char buf[32] = {0};
napi_get_value_string_utf8(env, argv[0], buf, 32, &result);
reinterpret_cast<std::promise<std::string> *>(data)->set_value(std::string(buf));
return nullptr;
}
static napi_value RejectedCallback(napi_env env, napi_callback_info info)
{
void *data = nullptr;
if (napi_get_cb_info(env, info, nullptr, nullptr, nullptr, &data) != napi_ok) {
return nullptr;
}
reinterpret_cast<std::promise<std::string> *>(data)->set_exception(
std::make_exception_ptr(std::runtime_error("Error in jsCallback")));
return nullptr;
}
static void CallJs(napi_env env, napi_value jsCb, void *context, void *data)
{
if (env == nullptr) {
return;
}
napi_value undefined = nullptr;
napi_value promise = nullptr;
napi_get_undefined(env, &undefined);
napi_call_function(env, undefined, jsCb, 0, nullptr, &promise);
napi_value thenFunc = nullptr;
if (napi_get_named_property(env, promise, "then", &thenFunc) != napi_ok) {
return;
}
napi_value resolvedCallback;
napi_value rejectedCallback;
napi_create_function(env, "resolvedCallback", NAPI_AUTO_LENGTH, ResolvedCallback, data,
&resolvedCallback);
napi_create_function(env, "rejectedCallback", NAPI_AUTO_LENGTH, RejectedCallback, data,
&rejectedCallback);
napi_value argv[2] = {resolvedCallback, rejectedCallback};
napi_call_function(env, promise, thenFunc, 2, argv, nullptr);
}
- 任务执行完成后,进行资源清理回收。
static void WorkComplete(napi_env env, napi_status status, void *data)
{
CallbackData *callbackData = reinterpret_cast<CallbackData *>(data);
napi_release_threadsafe_function(callbackData->tsfn, napi_tsfn_release);
napi_delete_async_work(env, callbackData->work);
callbackData->tsfn = nullptr;
callbackData->work = nullptr;
}
- 模块初始化以及ArkTS侧调用接口。
// 模块初始化
static napi_value Init(napi_env env, napi_value exports) {
CallbackData *callbackData = new CallbackData(); // 可在线程退出时释放
napi_property_descriptor desc[] = {
{"startThread", nullptr, StartThread, nullptr, nullptr, nullptr, napi_default, callbackData},
};
napi_define_properties(env, exports, sizeof(desc) / sizeof(desc[0]), desc);
return exports;
}
// ArkTS侧调用接口
import nativeModule from 'libentry.so'; // 通过import的方式,引入Native能力
let callback = (): Promise<string> => {
return new Promise((resolve) => {
setTimeout(() => {
resolve("string from promise");
}, 5000);
});
}
nativeModule.startThread(callback);
总是有很多小伙伴反馈说:鸿蒙开发不知道学习哪些技术?不知道需要重点掌握哪些鸿蒙应用开发知识点? 为了解决大家这些学习烦恼。在这准备了一份很实用的鸿蒙(HarmonyOS NEXT)学习路线与学习文档给大家用来跟着学习。
针对一些列因素,整理了一套纯血版鸿蒙(HarmonyOS Next)全栈开发技术的学习路线,包含了鸿蒙开发必掌握的核心知识要点,内容有(ArkTS、ArkUI开发组件、Stage模型、多端部署、分布式应用开发、WebGL、元服务、OpenHarmony多媒体技术、Napi组件、OpenHarmony内核、OpenHarmony驱动开发、系统定制移植等等)鸿蒙(HarmonyOS NEXT)技术知识点。
《鸿蒙 (Harmony OS)开发学习手册》(共计892页):https://gitcode.com/HarmonyOS_MN
如何快速入门?
1.基本概念
2.构建第一个ArkTS应用
3.……
开发基础知识
1.应用基础知识
2.配置文件
3.应用数据管理
4.应用安全管理
5.应用隐私保护
6.三方应用调用管控机制
7.资源分类与访问
8.学习ArkTS语言
9.……
基于ArkTS 开发
1.Ability开发
2.UI开发
3.公共事件与通知
4.窗口管理
5.媒体
6.安全
7.网络与链接
8.电话服务
9.数据管理
10.后台任务(Background Task)管理
11.设备管理
12.设备使用信息统计
13.DFX
14.国际化开发
15.折叠屏系列
16.……
鸿蒙开发面试真题(含参考答案):https://gitcode.com/HarmonyOS_MN
OpenHarmony 开发环境搭建:https://gitcode.com/HarmonyOS_MN
《OpenHarmony源码解析》:https://gitcode.com/HarmonyOS_MN
搭建开发环境
系统架构分析
- 构建子系统
- 启动流程
- 子系统
- 分布式任务调度子系统
- 分布式通信子系统
- 驱动子系统
- ……