淺談OpenHarmony的NDK開發
作者：左翼風發
Native API是OpenHarmony SDK上提供的一組native開發接口與工具集合（也稱為NDK），方便開發者使用C或者C++語言實現應用的關鍵功能。Native API只覆蓋了OHOS基礎的一些底層能力。
背景
Native API（NDK）入門
名詞概念
Native API構成介紹
Native API目錄結構
目錄 | 功能說明 |
build | 應用中編譯動態庫的toolchain cmake腳本；這個目錄下ohos.toolchain.cmake文件定義了給OHOS交叉編譯選項 |
build-tools | 放置編譯構建的工具，如cmake |
docs | Native API接口參考文檔，通過doxgen從頭文件中提取出來 |
llvm | 支持OHOS ABI的llvm交叉編譯器 |
sysroot | 放置編譯鏈接的依賴文件目錄，包含頭文件，動態庫等 |
寫在最后Native API接口（4.0 Release）
Native API相關資料
- Native API參考，介紹各個API參考手冊。
- Native API中支持的標準庫，介紹Native API支持的開源標準庫。
- Native API開發指南，結合具體的例子，場景介紹各類接口的使用。
- 如何在Cmake工程中使用NDK，介紹如何使用使用NDK開發一個CMake工程。
- Node-API在應用工程中的使用指導, 如何使用Node-API接口。
簡單應用
如何開發應用？
- DevEco IDE創建工程選擇“Native C++”模板：
編譯運行后，點擊helloworld打印輸出有：Test NAPI 2 + 3 = 5。
- ArkUI部分：
import hilog from '@ohos.hilog'; //導入hilog
import testNapi from 'libentry.so'; //導入nativeC++模塊
@Entry
@Component
struct Index {
@State message: string = 'Hello World';
build() {
Row() {
Column() {
Text(this.message)
.fontSize(50)
.fontWeight(FontWeight.Bold)
.onClick(() => {
//調用nativeC++代碼
hilog.info(0x0000, 'testTag', 'Test NAPI 2 + 3 = %{public}d', testNapi.add(2, 3));
})
}
.width('100%')
}
.height('100%')
}
}- nativeC++部分由 CMake 和 C++代碼兩部分組成：
- CMake：
# the minimum version of CMake.
cmake_minimum_required(VERSION 3.4.1)
project(MyNDKApplication)
# 編譯路徑
set(NATIVERENDER_ROOT_PATH ${CMAKE_CURRENT_SOURCE_DIR})
# 編譯頭文件路徑
include_directories(${NATIVERENDER_ROOT_PATH}
${NATIVERENDER_ROOT_PATH}/include)
# 編譯對象entry是對應用層可見的so，即import testNapi from 'libentry.so'
add_library(entry SHARED hello.cpp)
# 這是link命令，libace_napi 這個就是node-api需要用的so庫;
target_link_libraries(entry PUBLIC libace_napi.z.so)- C++：
#include "napi/native_api.h"
// 對外node-api方法，對應testNapi.add(2, 3)
static napi_value Add(napi_env env, napi_callback_info info)
{
size_t requireArgc = 2;
size_t argc = 2;
napi_value args[2] = {nullptr};
napi_get_cb_info(env, info, &argc, args , nullptr, nullptr);
napi_valuetype valuetype0;
napi_typeof(env, args[0], &valuetype0);
napi_valuetype valuetype1;
napi_typeof(env, args[1], &valuetype1);
double value0;
napi_get_value_double(env, args[0], &value0);
double value1;
napi_get_value_double(env, args[1], &value1);
napi_value sum;
napi_create_double(env, value0 + value1, &sum);
return sum;
}
// 模塊初始化方法，對應的方法在這加入對外描述隊列
EXTERN_C_START
static napi_value Init(napi_env env, napi_value exports)
{
napi_property_descriptor desc[] = {
{ "add", nullptr, Add, nullptr, nullptr, nullptr, napi_default, nullptr }
};
napi_define_properties(env, exports, sizeof(desc) / sizeof(desc[0]), desc);
return exports;
}
EXTERN_C_END
// 模塊聲明，import時候調用
static napi_module demoModule = {
.nm_version = 1,
.nm_flags = 0,
.nm_filename = nullptr,
.nm_register_func = Init,
.nm_modname = "entry",
.nm_priv = ((void*)0),
.reserved = { 0 },
};
// 模塊入口注冊
extern "C" __attribute__((constructor)) void RegisterEntryModule(void)
{
napi_module_register(&demoModule);
}如何使用系統NDK?
上面例子運行起來后，c++部分是沒有打印信息的，若想看到對應的打印信息，則需要調用hilog進行輸出，修改如下：
- cmake修改：
# the minimum version of CMake.
cmake_minimum_required(VERSION 3.4.1)
project(MyNDKApplication)
set(NATIVERENDER_ROOT_PATH ${CMAKE_CURRENT_SOURCE_DIR})
include_directories(${NATIVERENDER_ROOT_PATH}
${NATIVERENDER_ROOT_PATH}/include)
# 增加hiloglib庫引用
find_library(
# Sets the name of the path variable.
hilog-lib
# Specifies the name of the NDK library that
# you want CMake to locate.
hilog_ndk.z
)
add_library(entry SHARED hello.cpp)
# 增加hiloglib庫連接
target_link_libraries(entry PUBLIC ${hilog-lib} libace_napi.z.so)- c++文件修改：
// 增加hilog頭文件
#include <hilog/log.h>
#include "napi/native_api.h"
static napi_value Add(napi_env env, napi_callback_info info)
{
// 增加打印輸出
const unsigned int LOG_PRINT_DOMAIN = 0xFF00;
OH_LOG_Print(LOG_APP, LOG_INFO, LOG_PRINT_DOMAIN, "Init", "Init begins");
size_t requireArgc = 2;
size_t argc = 2;
napi_value args[2] = {nullptr};
...- 輸出：
08-07 05:40:25.079 15167-15167 A0ff00/Init com.example.myndkapplication I Init begins
08-07 05:40:25.079 15167-15167 A00000/testTag com.example.myndkapplication I Test NAPI 2 + 3 = 5具體原理是什么？
PC端OHOS SDK里包括了native對應的庫文件和頭文件。
OHOS源碼可以編譯出帶NDK的FullSDK，也可以從CI網址下載。
# Generate NDK library from NDK description file.
#
# Variables:
# ndk_description_file:
# min_compact_version: string specifies the minimal compactible version of NDK.
# set to major_version in default.
#
template("ohos_ndk_library") {
forward_variables_from(invoker, [ "testonly" ])
assert(defined(invoker.ndk_description_file),
"ndk description file is necessary ")
...
// 在GN里用ohos_ndk_library生成ndk庫和頭文件，如
ohos_ndk_library("libhilog_ndk") {
output_name = "hilog_ndk"
ndk_description_file = "./libhilog.ndk.json"
min_compact_version = "1"
system_capability = "SystemCapability.HiviewDFX.HiLog"
}
ohos_ndk_headers("hilog_header") {
dest_dir = "$ndk_headers_out_dir/hilog"
sources = [ "./include/hilog/log.h" ]
}
// ndk_description_file 對應的 libhilog.ndk.json 文件里聲明了導出的接口函數
[
{
"name": "OH_LOG_Print"
},
{
"name": "OH_LOG_IsLoggable"
}
]
// ohos 編譯fullsdk的命令：./build.sh --product-name ohos-sdkohos的ci網址如下：https://ci.openharmony.cn/workbench/cicd/dailybuild/dailylist。
使用建議
建議使用Native API的場景
主要有如下一些
- 應用性能敏感代碼，比如游戲，物理模擬等計算密集型場景。
- 需要復用已有的C或C++庫。
- 需要針對CPU特性進行專項定制的庫，如neon加速。
不建議使用Native API的場景
- 寫一個純native的的OHOS應用。
- 希望在盡可能多的OHOS設備上保持兼容的應用。
維測能力
- OHOS官方提供lldb remote方式代碼調試，詳細參看lldb參考手冊。
- musl庫的log維測能力，請參看libc庫維測章節。
總結
- NDK方式是應用層直接調用底層庫或者三方庫目前看最常規的方式；
- 4.0(API10)有ndk 46個，3.2(API9)有ndk 28個，實質代碼里有更多的ndk，RK的原因沒有編出更多，比如sensor部分就沒有編譯出來。
- 劃重點，NDK里有兩種api：node-api，用于arkts和c++調用和傳遞數據；c/c++ api，可以把動態庫打包成應用側c++直接調用的接口。
- 社區文檔：https://gitee.com/openharmony/docs/tree/master/zh-cn/application-dev/reference。
責任編輯：姜華
來源：
鴻蒙開發者社區
