OpenHarmony NAPI 使用Cmake 编译C++ .so 并ets调用

news2024/7/4 6:36:10

一、前言

这两年多随着国产化兴起，国内越来越多的项目都要求支持国产化系统，并且随着OpenHarmony 开源，更多的人都想分一杯羹。因此，我们公司也要求，所有产品的都需要支持开源鸿蒙OpenHarmony。对于我们这边的设备，很多代码都是需要保密，在Android 中都是通过jni 方法将不能公开的代码编译成.so 文件提供给客户调用。同理，在OpenHarmony 也是一样，将代码封装成 .so 通过 napi 提供给客户调用，于是有下面文章。

二、基本概念

2.1 关于napi

NAPI (Native API) 组件是一套对外接口基于Node.js N-API规范开发的原生模块扩展开发框架，也就是源于Node JS，为了实现 javascript 脚本与 C++ 库之间的相互调用。可以在 Node js 官网查看到关于 napi 更多资料。

2.2 在 OpenHarmony 中napi

无论是在OpenHarmony 还是 HarmonyOS 中，目前官方主要是提倡，应用层使用基于 javascript （Ark TS）语言开发应用。当有些特殊场景（访问操作系统底层api），或则高效、高性能的算法执行等，需要使用 c/c++ 有更高执行效率。因此，在Js 与 c/c++ 之间需要互相调用，进行交互传递数据，它们之间需要一个桥梁来实现两种语言代码之间的相互调用，这个桥梁就是 NAPI。

OpenHarmony 提供了 NAPI 框架用于实现 JS 和 C/C++ 互相调用的能力。

在DevEco Studio 默认支持创建 NAPI 工程，支持原生应用访问.

三、创建一个 NAPI 工程生成 xxx.so

3.1 打开DevEco Studio, 创建一个 native 工程

3.2 napi 工程目录

3.2.1 创建工程之后，编译整个工程，默认会有一个cpp 文件，并且生成一个默认 libentry.so 文件，文件在build -> intermediates->cmake->default->obj->arm-v8a->libentry.so

在cpp 目录中，CMakeLists.txt 保存生成 so 规则，修改 Cmake 规则，可以生成自定义.so库。

其中，types 包含NAPI 接口文件定义，

index.d.ts：对 napi 接口的 ts 提供的方法声明。
package.json：打包的配置文件
xxx.cpp 就是c++ 实现源码

CMakeLists.txt 文件还会在 build-profile.json5 里做配置。

在 oh-package.json5 文件中，配置xxx.so 与接口 .index.d.ts 配对的。

{
  "name": "libcomm_napi.so",
  "types": "./index.d.ts",
  "version": "",
  "description": "Please describe the basic information."
}

设置 libentry.so 库和 index.d.ts 相关联，便于在其他 TS 文件中引入 libentry.so 时调用库中的相关方法，可以跳转到 .ts 接口的声明。

3.3 关于 CMakeLists.txt

使用CMakeLists.txt 时，注意不能使用以下代码

#目标机使用的操作系统名称，支持Linux，QNX，WindowsCE，Android
#set(CMAKE_SYSTEM_NAME Linux)

指定cmake 的目标平台，虽然 openharmony 底层是 linux , 这样子使用在DevEco Studio编译 .so 时，会报错。

要想在 xxx.cpp 文件中，打印 hilog 日志，则需要在 CMakeLists.txt 编译选择中，输出的 xxx.so 需要增加链接选项，如：

#增加链接选项
target_link_libraries(comm_napi PUBLIC
    dl
    libace_napi.z.so
    libhilog_ndk.z.so
)

3.4 关于 napi 变量类型，可以参考node.js 官方的文档。

3.5 应用开发的 NAPI 库会随着应用工程一起编译打包到 hap 文件中，最终部署到 /data 目录每个应用自己的文件夹下。

参考文章：

[经验分享] NAPI入门

OpenHarmony 之 NAPI 框架介绍 - 知乎 (zhihu.com)

/**
* 　　　　　　　　┏┓　　　┏┓+ +
* 　　　　　　　┏┛┻━━━┛┻┓ + +
* 　　　　　　　┃　　　　　　　┃
* 　　　　　　　┃　　　━　　　┃ ++ + + +
* 　　　　　　 ████━████ ┃+
* 　　　　　　　┃　　　　　　　┃ +
* 　　　　　　　┃　　　┻　　　┃
* 　　　　　　　┃　　　　　　　┃ + +
* 　　　　　　　┗━┓　　　┏━┛
* 　　　　　　　　　┃　　　┃
* 　　　　　　　　　┃　　　┃ + + + +
* 　　　　　　　　　┃　　　┃　　　　Code is far away from bug with the animal protecting
* 　　　　　　　　　┃　　　┃ + 　　　　神兽保佑,代码无bug
* 　　　　　　　　　┃　　　┃
* 　　　　　　　　　┃　　　┃　　+
* 　　　　　　　　　┃　　　┗━━━┓ + +
* 　　　　　　　　　┃ 　　　　　　　┣┓
* 　　　　　　　　　┃ 　　　　　　　┏┛
* 　　　　　　　　　┗┓┓┏━┳┓┏┛ + + + +
* 　　　　　　　　　　┃┫┫　┃┫┫
* 　　　　　　　　　　┗┻┛　┗┻┛+ + + +
*
* @author chenxi
* @date 2024年5月8日21:16:27
*/