Node.js与C++:napi调用JavaScript回调函数

前情提要 : 前段时间想要为一个基于 Electron 框架开发的应用编写一个原生模块,以便它能够调用 Win32 API。在这个过程中,需要处理涉及到 JavaScript 函数回调的问题,由于接触 Node.js 的时间比较少,还无法理解其中的精髓,因此被这个问题困扰了很久。

介绍

NAPI(Node-API)是用于构建 Node.js 原生插件的一种API,旨在提供一个稳定的、跨 Node.js 版本的应用程序二进制接口(ABI),使得开发人员可以编写一次插件代码,并且能够在不同版本的 Node.js 上运行而无需重新编译。它的目标是提供一致的接口,使得编写 Node.js 扩展更加容易。

node-addon-api 是一个仅包含头文件的 C++ 包装类,它简化了基于 C 的 Node-API 的使用。

(如何开发node模块网上已经有很多教程啦,这里就不多赘述啦orz)

尝试1:Function 类

    
    // 检查参数是否正确
    if(!info[0].IsFunction()){
        // ……
    }

    // 获取传入的 JavaScript 回调函数
    Napi::Function callback = info[0].As<Napi::Function>();

    // ……

    // 在某些条件下调用 JavaScript 回调函数
    callback[i].Call({});
    

开始的时候直接尝试使用Function类,Napi::Function 类提供了一些方法,可用于调用在 JavaScript 中创建并传递给插件的函数。

但是在我的代码中,获取传入回调函数的位置和调用回调函数的位置不在同一个函数中,并且这样写在调用的时候,程序闪退,错误信息为

Fatal error in V8: v8::HandleScope::CreateHandle() Cannot create a handle without a HandleScope

看了一些文档也没有搞明白该怎么解决,尝试1大失败😭😭(流泪猫猫头.jpg)

尝试2:线程安全函数

由于回调的问题一直解决不了,之后想做的很多东西就都被搁置了。在一天摸鱼🐟的时候突然看到:异步线程安全函数调用 和 调用线程安全的函数

1. napi_create_threadsafe_function

    NAPI_EXTERN napi_status
    napi_create_threadsafe_function(napi_env env,
                                    napi_value func,
                                    napi_value async_resource,
                                    napi_value async_resource_name,
                                    size_t max_queue_size,
                                    size_t initial_thread_count,
                                    void* thread_finalize_data,
                                    napi_finalize thread_finalize_cb,
                                    void* context,
                                    napi_threadsafe_function_call_js call_js_cb,
                                    napi_threadsafe_function* result);
  • [in] env:调用 API 的环境。

  • [in] func:调用的 JavaScript 函数。

  • [in] async_resource:与将传递给可能的 async_hooks init 钩子 的异步工作关联的可选对象。

  • [in] async_resource_name:一个 JavaScript 字符串,用于为 async_hooks API 公开的诊断信息提供的资源类型提供标识符。

  • [in] max_queue_size:队列的最大大小。0 为无限制。

  • [in] initial_thread_count:初始获取数,即初始线程数,包括将使用此函数的主线程。

  • [in] thread_finalize_data:要传递给 thread_finalize_cb 的可选数据。

  • [in] thread_finalize_cb:napi_threadsafe_function 被销毁时调用的可选函数。

  • [in] context:附加到生成的 napi_threadsafe_function 的可选数据。

  • [in] call_js_cb:可选回调调用 JavaScript 函数以响应不同线程上的调用。详情查看napi_threadsafe_function_call_js

  • [out] result:异步线程安全的 JavaScript 函数。

(内心OS:顾名思义,创建一个线程安全的函数,虽然目前对这些参数还不是很清楚,但是现在可以先顺着 napi_threadsafe_function_call_js 这条线索走下去~)

2. napi_threadsafe_function_call_js

与异步线程安全函数调用一起使用的函数指针。通过调用 napi_call_function,然后调用 JS 函数。

具体函数必须满足:

    typedef void (*napi_threadsafe_function_call_js)(napi_env env,
                                                    // 用于 API 调用的环境,或者 NULL。
                                                    napi_value js_callback,
                                                    // 要调用的 JavaScript 函数,或者 NULL。
                                                    void* context,
                                                    // 用于创建线程安全函数的可选数据。
                                                    void* data);
                                                    // 由辅助线程创建的数据。回调负责将此原生数据转换为 JavaScript 值(使用 Node-API 函数),这些值可以在调用 js_callback 时作为参数传递。

(内心OS:感觉这个函数像是具体JS回调函数的执行者,那怎么调用回调函数捏🤔🤔)

3. napi_call_threadsafe_function

可以在任何调用JS回调函数的地方调用这个函数。

    NAPI_EXTERN napi_status
    napi_call_threadsafe_function(napi_threadsafe_function func,
                                // 要调用的异步线程安全 JavaScript 函数。
                                void* data,
                                // 通过创建线程安全 JavaScript 函数期间提供的回调 call_js_cb 发送到 JavaScript 的数据。
                                napi_threadsafe_function_call_mode is_blocking);
                                // 标志,其值可以是 napi_tsfn_blocking 或 napi_tsfn_nonblocking。

4. 照猫画虎

大概看了一下文档,就开始照猫画虎写自己的代码啦!!

  • 创建JS回调函数。(在我的代码中,我的CallbackInfo是一组Object。)
    // ……
    // 判断参数类型
    if(obj.Get("click").IsFunction()){
                    //创建回调JS函数
                    //callback_map_[i] = obj.Get("click").As<Function>();(这里是原本使用 Function 类的写法)
                    napi_value js_callback;
                    napi_status status;
                    napi_value srcCbName;

                    js_callback = obj.Get("click");
                    status = napi_create_threadsafe_function(env,
                        js_callback, // napi_value 回调函数
                        nullptr,
                        srcCbName,
                        0,
                        1,
                        nullptr,
                        nullptr,
                        nullptr,
                        ThreadSafe_Func_CallJs, 
                        // 实际的执行单元, 在内部调用napi_call_function
                        &callback_map_[i]);  
                        // 全局threadsafe函数,存在 using CallbackMap = std::map<int, napi_threadsafe_function> 中

                    if (status == napi_ok) {
                        // 成功
                    }
                }
  • 创建napi_threadsafe_function_call_js
void ThreadSafe_Func_CallJs(napi_env env, napi_value js_callback, void* context, void* data) {
	napi_status status;
	napi_value undefined;
	status = napi_get_undefined(env, &undefined);
	status = napi_call_function(env, undefined, js_callback, 0, nullptr, nullptr); 
	if (status != napi_ok) {
		// ……
	}
}
  • 调用JS回调函数
    napi_call_threadsafe_function(callback_map_[wmId], nullptr, napi_tsfn_nonblocking);
  • 在JS中调用原生模块
    TaskbarThumbnailManager.setThumbarButtons([
      {
        icon: "Cursor_Laser_Pointer.ico",
        tooltip: "上一首",
        click() {
          console.log('shangyishou\n');
        }
      }
      // ……
    ]);

Node.js与C++:napi调用JavaScript回调函数

总结

回调成功的时候简直忍不住在房间里旋转跳跃不停歇hhh🎉🎉

但是这次成功是有点运气在的,因为还是有很多没有解决的问题orz

仅作个人纪录,感谢所有写过相关文章的其他作者!!

参考:

原文链接:https://juejin.cn/post/7344260655757230117 作者:Matsuko

(0)
上一篇 2024年3月11日 上午10:51
下一篇 2024年3月11日 上午11:02

相关推荐

发表评论

登录后才能评论