NAPI 类对象导出及其生命周期管理(上)

2024-08-14 15:54:57 浏览数 (1)

1.NAPI 类对象导出

  • OpenHarmony NAPI提供了一种“包装”C 类和实例的方法，以便JS应用可以调用类的构造函数和方法。
  • Node.js Node-API中关于导出类对象的内容，

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的形式返回。这些句柄必须保持对象“活动”，直到本地代码不再需要它们。

句柄是一个标识符，是用来标识对象的。 NAPI 环境生命周期API的内容参考链接如下： https://nodejs.org/docs/lates...

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版本。

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的信息。

调试信息如下：

代码语言：shell复制
08-05 11:09:03.413 1802-1802/com.example.objectwraptest I A0fefe/JsApp: [NapiTest] Test NAPI 2   3 = 5
08-05 11:09:03.414 1802-1802/com.example.objectwraptest I A0fefe/JsApp: [NapiTest] Test NAPI add(2, 3) 1
08-05 11:09:03.414 1802-1802/com.example.objectwraptest I A0fefe/JsApp: [NapiTest] Test NAPI add(2, 3) 2
08-05 11:09:03.415 1802-1802/com.example.objectwraptest I A0fefe/JsApp: [NapiTest] Test NAPI add(2, 3) 3
08-05 11:09:03.415 1802-1802/com.example.objectwraptest I A0fefe/JsApp: [NapiTest]Test NAPI 2 3 = 5
08-05 11:09:52.123 1802-1802/com.example.objectwraptest I A0fefe/JsApp: [NapiTest] Test NAPI 2   3 = 5
08-05 11:09:52.123 1802-1802/com.example.objectwraptest I A0fefe/JsApp: [NapiTest] Test NAPI add(0, 0) 1
08-05 11:09:52.123 1802-1802/com.example.objectwraptest I A0fefe/JsApp: [NapiTest] Test NAPI add(0, 0) 2
08-05 11:09:52.124 1802-1802/com.example.objectwraptest I A0fefe/JsApp: [NapiTest] Test NAPI add(0, 0) 3
08-05 11:09:52.124 1802-1802/com.example.objectwraptest I A0fefe/JsApp: [NapiTest]Test NAPI 4 5 = 0
  • 3、再在index.ets中取消下面这四行代码的注释。

Hilog窗口打印调试信息如下：

代码语言：shell复制
08-05 09:03:38.156 1911-1911/com.example.objectwraptest I A0fefe/JsApp: [NapiTest] Test NAPI 2   3 = 5
08-05 09:03:38.157 1911-1911/com.example.objectwraptest I A0fefe/JsApp: [NapiTest]Test NAPI error{}
08-05 09:03:38.157 1911-1911/com.example.objectwraptest I A0fefe/JsApp: [NapiTest]Test NAPI hello NapiTest = undefined

以上HiLog窗口打印信息中的com.example.objectwraptest是样例工程的包名,在样例应用工程AppScopeapp.json5文件中定义。AppScopeapp.json5中还可以定义样例应用hap的其他属性。 entrysrcmainmodule.json5中startWindowBackground字段可以查看应用开启时过渡动画的颜色，但是在指向的同级目录下具体的文件中设置

  • 在样例应用工程entrysrcmainresourcesbaseelementstring.json中可以查看 应用名称
  • 样例图标修改entrysrcmainresourcesbasemediaicon.png，大小是114*114像素

知识点附送

  • OpenHarmony截屏命令：
代码语言：shell复制
# 进入sdk版本号toolchain输入cmd打开命令行
hdc_std shell
snapshot_display
# 截图默认保存在/data/目录下
exit
hdc_std file recv OpenHarmony设备端截图文件路径 PC端路径

写在最后

如果你觉得这篇内容对你还蛮有帮助，我想邀请你帮我三个小忙：