OpenHarmony之NAPI框架介绍

OpenHarmony开发者
发布于 2023-11-24 09:32
浏览
1收藏

OpenHarmony之NAPI框架介绍

OpenHarmony之NAPI框架介绍-鸿蒙开发者社区

张志成

诚迈科技高级技术专家

NAPI是什么

NAPI的概念源自Nodejs,为了实现javascript脚本与C++库之间的相互调用,Nodejs对V8引擎的api做了一层封装,称为NAPI。可以在Nodejs官网(https://nodejs.org/dist/latest-v20.x/docs/api/n-api.html)上查看各种NAPI接口定义说明。

OpenHarmony之NAPI框架介绍-鸿蒙开发者社区

可以看到,NAPI接口本身是C++语言实现的,这些接口可以帮助C++代码创建JS变量,或访问JavaScript运行环境中的JS变量与方法。

OpenHarmony中的NAPI

OpenAtom OpenHarmony(以下简称“OpenHarmony”)应用层基于javascript语言开发,而系统框架层则基于C++语言。它们之间需要一个桥梁来实现两种语言代码之间的相互调用,这个桥梁就是NAPI。

OpenHarmony之NAPI框架介绍-鸿蒙开发者社区

这里可能有的小伙伴有疑问了:OpenHarmony的NAPI和NodeJs的NAPI是一回事吗?应该说,OpenHarmony系统沿用了NAPI的接口定义形式,但每个接口的内部实现都进行了重写。这是因为NAPI接口的本质是帮助C++程序去跟Javascript引擎交互,因此对于不同的引擎需要有不同的实现方式。当用户调用了NAPI接口 napi_create_int64(), 对于Nodejs而言,它会去访问V8引擎的api创建一个js的数字变量,而对于OpenHarmony,则是去访问ArkUI框架自己的js引擎(ArkNativeEngine)。在OpenHarmony源码中搜索 napi_create_int64() 方法,你会得到一份头文件定义:third_party\node\src\js_native_api.h以及两份不同的实现代码:third_party\node\src\js_native_api_v8.ccfoundation\arkui\napi\native_engine\native_api.cppnative_api.cpp是OpenHarmony版本的NAPI实现,想了解内部细节的可以从这里入手:

OpenHarmony之NAPI框架介绍-鸿蒙开发者社区

创建一个简单的NAPI工程

可以通过DevEco Studio的Native C++模板创建一个包含简单NAPI 实现的样例工程。

OpenHarmony之NAPI框架介绍-鸿蒙开发者社区

该工程自带一个hello.cpp,实现了一个能够被javascript代码调用的add()方法。

OpenHarmony之NAPI框架介绍-鸿蒙开发者社区

下面我们就基于这个简单的例子,探究一下NAPI框架的实现原理。

应用如何调用NAPI接口

应用代码导入对应的so库后,就可以调用该库实现的接口。

OpenHarmony之NAPI框架介绍-鸿蒙开发者社区

这里我们注意到,导入日志库时使用的名称是"@ohos.hilog",应用代码如果写成  import hilog from 'libhilog.z.so'  其实也是可以成功导入的。实际上,ArkUI在运行时会将@ohos.hilog转换为libhilog.z.so,然后到 /system/lib/module/ 目录下查找此库并加载。系统实现的NAPI库都放在/system/lib/module/目录下,类似的:@ohos.wifiManager对应的是 /system/lib/module/libwifimanager.z.so;@ohos.deviceInfo 对应的是 /system/lib//module/libdeviceinfo.z.so

除了系统自带的NAPI库,应用也可以用C++开发自己的NAPI库。上面例子中 import testNapi from 'libentry.so' 导入的就是应用自己实现的。应用开发的NAPI库会随着应用工程一起编译打包到hap文件中,最终部署到/data目录每个应用自己的文件夹下。

OpenHarmony之NAPI框架介绍-鸿蒙开发者社区

NAPI库的导入原理

我们知道,应用的javascript代码是由ArkUI的JS引擎解释执行的。当JS引擎解读 import hilog from '@ohos.hilog'; 这行代码时,会通过dlopen() 将对应的libhilog.z.so加载到应用进程中。这一切是怎么做到的呢?每个应用进程在初始化时,都会创建一个引擎实例 ArkNativeEngineImpl,我们来看一下它的构造函数foundation\arkui\napi\native_engine\impl\ark\ark_native_engine_impl.cpp

OpenHarmony之NAPI框架介绍-鸿蒙开发者社区

也就是说,每个应用进程的JS引擎中,都注册了一个"requireNapi"函数,当应用调用此方法时,JS引擎就会通过NAPI框架的moduleManager类去处理so库的加载。moduleManager内部最终是找到了/system/lib/module下对应的so文件,并通过dlopen()的方式加载到应用进程中。想了解细节的小伙伴可以读一下NativeModuleManager::LoadNativeModule()方法的内部实现。

这里可能会有个疑问:应用的javascript代码中并没有写什么"requireNapi"的代码,只有import xxx,怎么触发的导入处理函数?答案要到编译后的js代码中寻找。我们解开编译后的hap包,找到ets文件对应的js文件:

OpenHarmony之NAPI框架介绍-鸿蒙开发者社区

可以看到,index.ets被编译成index.js后,import关键字也被转为了"requireNapi",这样JS引擎在执行这行代码时,就会去调用注册的导入处理函数了。

OpenHarmony之NAPI框架介绍-鸿蒙开发者社区

C++库如何实现JS方法

前面解决了JS 导C++库的问题,下一步就是JS如何调用C++库里的方法了。先说结论:一个C++方法能否被应用调用,取决与C++代码有没有将这个方法注册到JS引擎。

我们来看看hello.cpp是如何注册add方法的:

OpenHarmony之NAPI框架介绍-鸿蒙开发者社区

我们可以从下往上看这段代码:首先是 RegisterEntryModule(void) 方法。这是C++向JS引擎进行NAPI模块与方法注册的起始代码。注意这个方法前面有个编译修饰符 "__attribute__((constructor))",它的作用是指导C++代码的编译,使得当so库被加载到应用进程中时,RegisterEntryModule(void) 方法就会被自动调用到。该方法通过NAPI接口napi_module_register() 向JS引擎注册了一个 napi_module。

然后是Init()方法。该方法实现了Add方法的注册。也就是告诉JS引擎,将JS符号"add" 与C++方法"Add" 进行关联映射。这样后续当JS引擎解释执行javascript代码 "testNapi.add(2, 3)"时,就会找到C++ Add()方法的函数地址并调用。如下图所示:

OpenHarmony之NAPI框架介绍-鸿蒙开发者社区

方法关联调用的问题也解决了,最后就是JS运行环境与C++运行环境的相互切换了。当C++的Add方法被JS引擎调用到后,引擎会将javascript下发的参数变量传递给C++。所有从JS运行环境传递过来的变量都是用napi_value类型来表示的。需要通过NAPI接口转为C++语言的变量类型。详见下图每行代码的注释:

OpenHarmony之NAPI框架介绍-鸿蒙开发者社区

napi_value不是一个具体的类型,它类似于void*,表示的是JS变量在JS引擎内部存储区内的地址。需要通过对应的NAPI方法实现,例如:napi_get_value_int32()  --- js变量转为c++整形napi_get_value_string_utf8() --- js变量转为c++字符串napi_get_value_bool() --- js变量转为c++布尔值

这些接口的具体用法和使用场景,可以参考NodeJs官方文档(https://nodejs.org/dist/latest-v20.x/docs/api/n-api.html)

C++程序链接NAPI库

OpenHarmony的NAPI接口实现都封装在libace_napi.z.so中,C++程序编译时需链接此库。对于DevEco Studio应用开发的cpp代码,在对应的CMakeLists.txt中链接。该库文件在SDK目录下可以找到。

OpenHarmony之NAPI框架介绍-鸿蒙开发者社区

对于设备侧开发,系统框架中的C++程序,则通过BUILD.gn文件定义依赖关系。

OpenHarmony之NAPI框架介绍-鸿蒙开发者社区

总结

NAPI是JavaScript与C++交互的桥梁。在OpenHarmony中,Javascript代码在运行时由ArkUI的JS引擎解释执行,C++代码则通过NAPI接口访问JS引擎中的Javascript上下文,从而实现与JS变量、方法之间的相互调用。

参考链接

以下是源码仓库地址

https://gitee.com/openharmony/arkui_napi

https://gitee.com/openharmony/third_party_node

收藏 1
回复
举报
回复
    相关推荐