NAPI 类对象导出及其生命周期管理 (上)
写在开头：
OpenHarmony 中的 N-API组件定义了由 ArkTS (JS/ETS)语言编写的代码和 native 代码（使用 C/C++ 编写）交互的方式，由 Node.js Node-API 框架扩展而来。
什么是 Node.js Node-API 框架 Node.js Node-API 为开发者提供了一套 C/C++ API 用于开发 Node.js 的 Native 扩展模块。从 Node.js 8.0.0 开始，Node-API 以实验性特性作为 Node.js 本身的一部分被引入，并且从 Node.js 10.0.0 开始正式全面支持 Node-API。
本文以 OpenHarmony 3.2beta3 源码中的 node.js 三方库为例，从 third_party/node/README.OpenSource 中可得知 3.2beta3 移植的 node 版本为 14.19.1，因此可参考的 Node.js N-API 链接为 14.19.1 版本，如下：https://nodejs.org/docs/latest-v14.x/api/n-api.html
接口名方面，OpenHarmony 中的 N-API 组件提供的接口名与三方库 Node.js 一致，目前支持部分接口，详情见libnapi.ndk.json文件。
本篇是该系列文章的第 5 篇上半部分。有离北况归的地方就一定会有样例源码，本文提供了一个 IDE 开发的 NAPI 工程用来学习本篇知识点，下半部分将对源码进行解析。通过本文您将熟悉：
NAPI 导出类对象
NAPI 对象生命周期管理
往期回顾：三方库移植之NAPI开发[1]—Hello OpenHarmony NAPI
三方库移植之NAPI开发[2]C/C++与JS的数据类型转换
三方库移植之NAPI开发[4]异步调用:Callback&Promise
@toc
1.NAPI 类对象导出
OpenHarmony NAPI 提供了一种“包装”C ++类和实例的方法，以便 JS 应用可以调用类的构造函数和方法。
Node.js Node-API 中关于导出
类对象的内容，参考链接 : https://nodejs.org/docs/latest-v14.x/api/n-api.html#n_api_object_wrap
1.1. NAPI 导出类对象流程
通过
napi_define_class定义一个 JS 类它包含了与 C++ 类对应的构造函数、静态属性、方法、实例属性和方法。
通过
napi_wrap将 C++ 实例绑定在 JS 对象中当 JS 代码调用构造函数时，构造函数回调会使用 napi_wrap 将一个新的 C++ 实例绑定在 JS 对象中，然后返回绑定的 C++ 实例。
通过
napi_unwrap获取作为调用目标的 C++ 实例当 JS 调用 C++ 类 的方法或属性时，会调用相应的 napi_callback C++ 函数。对于实例回调，
napi_unwrap获取作为调用目标的 C++ 实例 。
这里的 napi_callback C++ 函数是指被 Node.js Node-API 调用的 C++ 函数
2. NAPI 对象生命周期
程序的生命周期是指程序从启动，运行到结束的整个过程。
NAPI 对象的生命周期代表着从对象创建到释放的整个过程，如下图所示：
在 ArkTS 应用启动时会加载 NAPI 模块，而在 NAPI 模块加载过程中会创建一个对象 A 提供给应用使用，在应用退出或者主动释放 A 对象前，A 对象必须一直保持"活跃"状态。从 A 对象创建到释放的整个过程也代表着 A 对象的生命周期。
以下是 Node-API 中关于对象生命周期的解释：
当调用 Node-API 时，底层虚拟机在堆中对象的句柄可能以 napi_values 的形式返回。这些句柄必须保持对象“活动”，直到本地代码不再需要它们。参考链接:https://nodejs.org/docs/latest-v14.x/api/n-api.html#n_api_object_lifetime_management
句柄是一个标识符，是用来标识对象的。
NAPI 环境生命周期 API 的内容参考链接如下：https://nodejs.org/docs/latest-v14.x/api/n-api.html#n_api_environment_life_cycle_apis
3. 关于本文提供的样例工程
本文提供了一个 IDE 开发的 NAPI 工程用来学习 NAPI
类对象导出和对象生命周期管理。笔者运行环境：
触觉智能 IDO-EVB3568-V1 开发板
OpenHarmony 3.2Beta2
DevEco Studio 3.1.0.100
3.1 触觉智能 IDO-EVB3568-V1 开发板
触觉智能的这个 rk3568 开发板是笔者去年 8 月份网上冲浪购买的，4GB+32GB 开发板 + 一块 10.1 英寸的 MIPI 屏幕 + 电源适配器 ＋ usb 调试器（搞开源鸿蒙用不上） 一共 739 米 。笔者认为是性价比无敌的开源鸿蒙标准系统开发板。
触觉智能一直在给 IDO-EVB3568-V1 开发板适配最新的 OpenHarmony 版本。例如 2 月 1 号发布 Beta5，作为消费者的笔者立马收到了适配了 IDO-EVB3568-V1 的 Beta5 镜像包，有 MIPI 版本的和 HDMI 版本。购买后的体验是非常不错的。购买链接如下：https://item.taobao.com/item.htm?spm=4645b.1.14.1.5c4a4a7dv1soeZ&id=658789039056&ns=1&abbucket=5#detail
3.2. 样例工程运行
1、样例安装运行后，触觉智能 IDO-EVB3568-V1 开发板显示如下
以下图片通过 OpenHarmony 预置的屏幕截图功能获取。截图文件放在下面这四个文件夹下/data/service/el2/100/hmdfs/account/files/Pictures/Screenshots//storage/media/100/local/files/Pictures/Screenshots//mnt/hmdfs/100/account/device_view/local/files/Pictures/Screenshots//mnt/hmdfs/100/account/merge_view/files/Pictures/Screenshots/然后通过 hdc 工具导出到 PC 端。
2、再点击中间的"导出对象"后，PC 端 DevEco Studio 工具的 Log 窗口查看到对应的调试信息。
系统的调试信息也在 Hilog 窗口显示，且信息量大，不方便查看自己的调试信息，可以在 log 窗口设置过滤信息，让窗口只显示我们过滤关键字
NapiTest的信息。
调试信息如下：
以上 HiLog 窗口打印信息中的 com.example.objectwraptest 是样例工程的包名,在样例应用工程 AppScope\app.json5 文件中定义。AppScope\app.json5 中还可以定义样例应用 hap 的其他属性。
entry\src\main\module.json5 中 startWindowBackground 字段可以查看应用开启时过渡动画的颜色，但是在指向的同级目录下具体的文件中设置
在样例应用工程 entry\src\main\resources\base\element\string.json 中可以查看 应用名称
样例图标修改 entry\src\main\resources\base\media\icon.png，大小是 114*114 像素
知识点附送
OpenHarmony 截屏命令：
版权声明: 本文为 InfoQ 作者【离北况归】的原创文章。
原文链接:【http://xie.infoq.cn/article/e9629fc554be8c0c8f2b2d5ce】。文章转载请联系作者。
还未添加个人签名 2022-03-26 加入
OpenHarmony啃论文俱乐部PIMF团队。 位于南京一学生，可私信。
评论