Open Harmony 之 NAPI

前言

此文代码版本为 code-v3.1-Beta。

2022/05/22 更新:oh 官方提供了一个插件用来一键生成 NAPI 框架代码、业务代码框架、GN 文件等。因此你也许没有必要看本文。

https://gitee.com/openharmony/napi_generator#https://gitee.com/openharmony/napi_generator/blob/master/docs/INSTRUCTION_ZH.md
“本文主要介绍NAPI框架代码生成工具,它可以根据用户指定路径下的ts(typescript)接口文件一键生成NAPI框架代码、业务代码框架、GN文件等。在开发JS应用与NAPI间接口时,底层框架开发者无需关注Nodejs语法、C++与JS之间的数据类型转换等上层应用转换逻辑,只关注底层业务逻辑即可,专业的人做专业的事,从而可以大大提高开发效率。”

NAPI 是什么

类似于 Android 中使用的 JNI,OH 中的 N-API 定义了的由 JS/ETS 语言编写的代码编绎出的字节码和 native 代码(使用 C/C++ 编写)交互的方式,由 Node.js N-API 框架扩展而来。
简单来说,OH 系统中的 NAPI 定义了 JS 代码和 C++ 代码的交互方式。

JNI:Java Native Interface;
N-API:Native Application Programming Interface;


NAPI 作用

Android 中使用的 JNI(Java Native Interface):定义了由 Java 或 Kotlin 语言编写的代码编译出的字节码和 native 代码(使用 C/C++ 编写)交互的方式。

NAPI 设计思想

1. 方舟编译器(ArkCompiler)将 JS 代码编绎成 abc 文件,并执行

方舟编译器(ArkCompiler)中的 ArkCompiler JS Runtime 模块中的 JS 编译工具链会将 JS 代码转换成方舟字节码即 abc 文件。然后方舟编译器中的 JS Runtime 会直接运动字节码文件,实现对应的语义逻辑。其中的 JS-NAPI 模块将实现 JSNAPI 接口和 C++ 的交互。


JS code 通过方舟编译器中的 JS Runtime 转换成 NAPI code
2. ArkCompiler 中的 JS-NAPI 模块调用 Native 代码注册的 JS 接口实现代码(callback method handle)
JS 方法调用 C++ 方法的流程
3. Native 代码以 property 的形式注册 callback method handle, 并且在 callback method 中有一个参数用于存放 JS 方法传入的参数值

如一个 js 对象对应的 native 对象 object,native 代码将把 object 中的方法、变量、常量构成 [key:methodname,value:callback method handle] 的 property 形式注册。


Native 代码通过 property 的形式注册 method callback handle

如:JS 的 call 接口 @ohos.telephony.call.d.ts 中对应的方法 dial()、变量 callstate、常量 CALL_STATE_IDLE,native 代码将为其注册 call 的 properties:["dial",callback method]、["callstate",getter/setter callback method]、["CALL_STATE_IDLE", callback value]


js object 方法对应的 native callback
4. native 代码调用 napi 创建 JS 的 Promise,当 callback method 执行完成后,通过 napi 调用 Promise.resolve(value) 方法向 JS 代码返回结果。

NAPI 数据类型和封装函数

napi 数据类型作为 js 数据类型和 c++ 数据类型之间的桥梁,可以和 ArkComplier 中翻译的 js 数据类型,及 c++ 数据类型相互转换。napi 框架提供方法实现它们之间的互相转换。


napi 提供数据类型的转换

可参考 Node.js v8.x 中文文档 ,oh 中的具体实现在 native_api.cpp。

其中基本的数据类型,如 :

  • napi_env 对应 NativeEngine 在 oh 中指 ArkComplier 中 JSNAPI 的相关上下文环境,任何 napi 数据类型和 js 数据类型的转换都需要用到它。
  • napi_value 对应 NativeValue 在 oh 中指所有 ArkComplier 可识别的 js 数据类型,它有子类 ArkNativeNumber、ArkNativeString、ArkNativeFunction 等,对应 js 中的 number、string、function 等数据类型。
  • napi_callback_info 对应 NativeCallbackInfo ,指注册 callback handle 时用来存放 js 传入参数信息的数据类型。它是一个 struct。
  • napi_property_descriptor 是用来存放单个 property 的数据类型。
  • napi_callback 对应 NativeCallback,即前面的 callback handle,native 代码将其注册为对应 js 接口的回调函数。
typedef napi_value (*napi_callback)(napi_env env, napi_callback_info info)

其中基本的转换函数,如:

  • 将 c++ 转换成 napi 的函数: napi_create_string_utf8 等;
  • 将 napi 转换成 c++ 的函数: napi_get_value_string_utf8 等;
  • 创建编译器中的 js 对象: napi_create_function 等;
  • 回调 js 函数:napi_call_function

使用 NAPI

使用 napi 时只要完成以下几个步骤:

1. 向系统注册我们要实现的 js 接口对象(在 oh 中指要新增的子系统)

分为以下几步:
首先:

BUILD.gn 中声明 js 接口对象 object :ohos_shared_libarary("object")

其次:

通过 napi_module_register 注册 module

最后:

定义 napi_module ,注册 module 中 object 的 properties
2. 注册我们要提供的子系统接口的 properties

首先,定义所有的常量、变量、方法 property:

DECLARE_NAPI_FUNCTION("methodName", NativeMethod);

然后,注册所有 properties

通过 napi_define_properties 注册 object 的 properties
3. 实现所有 property 中的回调方法:
从 napi_callback_info 中取出 JS 调用时传入的所有参数,
并调用 napi 方法将其从 napi 数据类型的值 napi_value 转换成 native 数据类型的值

参考

Node.js v8.x 中文文档
oh 官网:napi

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,546评论 6 507
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,224评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,911评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,737评论 1 294
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,753评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,598评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,338评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,249评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,696评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,888评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,013评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,731评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,348评论 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,929评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,048评论 1 270
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,203评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,960评论 2 355

推荐阅读更多精彩内容