新手入門ArkTS調(diào)用NATIVE庫的學(xué)習(xí)筆記
想了解更多關(guān)于開源的內(nèi)容，請(qǐng)?jiān)L問：
前言
本來想這周跟著HarmonyOS官網(wǎng)的codelabs學(xué)習(xí)一下ArkTS下對(duì)Native庫的調(diào)用，不料harmonyos官網(wǎng)直接把這個(gè)Codelabs課程下線了，不知以后還會(huì)不會(huì)上線。上周五還看的挺正常的，自己還加入了瀏覽器的收藏夾，結(jié)果兩天之后的今天就下線了，印象中那個(gè)課程講的還挺詳細(xì)的，想嘗試在網(wǎng)上搜索一下同樣的課程，看看有沒有副本，結(jié)果也沒找到。沒法跟著官方學(xué)的太詳細(xì)了，就自己盲學(xué)一下吧。原來的課程是基于Native C++模板，實(shí)現(xiàn)通過Native API調(diào)用C標(biāo)準(zhǔn)庫的功能，我計(jì)劃也按照這個(gè)步驟學(xué)習(xí)一下，首先了解一下新建Native工程的框架，然后在這個(gè)基礎(chǔ)上增加對(duì)調(diào)用C標(biāo)準(zhǔn)庫的支持。
框架介紹
新建Native C++工程，選中Stage模型。
項(xiàng)目創(chuàng)建完成后，工程目錄結(jié)構(gòu)如下。
很明顯，在entry/src/main目錄下，與ets目錄同級(jí)有一個(gè)cpp目錄，這個(gè)目錄就包含了native部分的代碼，包括功能實(shí)現(xiàn)和編譯腳本。這個(gè)工程是可以直接運(yùn)行的，不過運(yùn)行效果只是一個(gè)HelloWorld，需要點(diǎn)擊這個(gè)組件才會(huì)執(zhí)行native調(diào)用，結(jié)果顯示在標(biāo)簽log中。
預(yù)覽器不支持native調(diào)用的預(yù)覽，會(huì)報(bào)錯(cuò)。
09-11 11:32:40.806 12536-15828 E C03900/Ace: [Engine Log]Lifetime: 0.000000s
09-11 11:32:40.806 12536-15828 E C03900/Ace: [Engine Log]Js-Engine: ark
09-11 11:32:40.806 12536-15828 E C03900/Ace: [Engine Log]page: pages
09-11 11:32:40.806 12536-15828 E C03900/Ace: [Engine Log]Error message: Cannot read property add of undefined
09-11 11:32:40.806 12536-15828 E C03900/Ace: [Engine Log]Cannot get SourceMap info, dump raw stack:
09-11 11:32:40.806 12536-15828 E C03900/Ace: [Engine Log]Stacktrace:
09-11 11:32:40.806 12536-15828 E C03900/Ace: [Engine Log] at anonymous (entry我們通過模擬器運(yùn)行一下。
點(diǎn)擊這個(gè)文本標(biāo)簽，會(huì)在log窗口打印如下日志。
演示不夠直觀，操作繁瑣，看log也不方便，我們改一下，讓調(diào)用結(jié)果直接顯示在界面上。
Index.ets：
import hilog from '@ohos.hilog';
import testNapi from 'libentry.so'
@Entry
@Component
struct Index {
@State message: string = 'Result of Native call:'
build() {
Row() {
Column() {
Text(this.message)
.fontSize(30)
.fontWeight(FontWeight.Bold)
.onClick(() => {
hilog.info(0x0000, 'testTag', 'Test NAPI 2 + 3 = %{public}d', testNapi.add(2, 3));
})
Text(testNapi.add(2, 3).toString())
.fontSize(50)
.fontColor(Color.Red)
}
.width('100%')
.height('100%')
.justifyContent(FlexAlign.Center)
}
.height('100%')
}
}現(xiàn)在的運(yùn)行結(jié)果是這樣的。
現(xiàn)在已經(jīng)證實(shí)了項(xiàng)目是完整的可以正常運(yùn)行，下面分析一下具體的項(xiàng)目結(jié)構(gòu)。
基本項(xiàng)目結(jié)構(gòu)：
1、Entry/src/main/cpp/types/libentry/index.d.ts
export const add: (a: number, b: number) => number;接口描述文件，描述C++接口的方法名、入?yún)?、返回參?shù)等信息，用來暴露lib庫相關(guān)的聲明。
2、Entry/src/main/cpp/types/libentry/oh-package.json5
{
"name": "libentry.so",
"types": "./index.d.ts",
"version": "",
"description": "Please describe the basic information."
}native庫的配置文件。
3、Entry/src/main/cpp/types/CMakeLists.txt
# the minimum version of CMake.
cmake_minimum_required(VERSION 3.4.1)
project(MyNativeApp)
set(NATIVERENDER_ROOT_PATH ${CMAKE_CURRENT_SOURCE_DIR})
include_directories(${NATIVERENDER_ROOT_PATH}
${NATIVERENDER_ROOT_PATH}/include)
add_library(entry SHARED hello.cpp)
target_link_libraries(entry PUBLIC libace_napi.z.so)編譯腳本。
cmake_minimum_required用于設(shè)定需要的最低版本的CMakeproject指定工程名為MyNativeAppSet 設(shè)置變量，指定NATIVERENDER_ROOT_PATH的位置include_directories命令用于在構(gòu)建(build)中添加包含目錄add_library 使用指定的代碼向項(xiàng)目中增加一個(gè)庫。
target_link_libraries指定鏈接給定目標(biāo)和/或其依賴項(xiàng)時(shí)要使用的庫或標(biāo)志。將傳播鏈接庫目標(biāo)的使用要求。目標(biāo)依賴項(xiàng)的使用要求會(huì)影響其自身源的編譯。
4、Entry/src/main/cpp/types/hello.cpp
#include "napi/native_api.h"
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
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);
}功能具體實(shí)現(xiàn)的源文件。
napi_module_register進(jìn)行模塊注冊(cè)，nm_modname指的是模塊名稱，nm_register_func是模塊對(duì)外接口注冊(cè)函數(shù)。
5、Entry/build-profile.json5
{
"apiType": 'stageMode',
"buildOption": {
"externalNativeOptions": {
"path": "./src/main/cpp/CMakeLists.txt",
"arguments": "",
"cppFlags": "",
}
},
"targets": [
{
"name": "default",
"runtimeOS": "HarmonyOS"
},
{
"name": "ohosTest",
}
]
}當(dāng)前的模塊信息、編譯信息配置項(xiàng)，包括buildOption、targets配置等。
buildOption中的externalNativeOptions代表cpp相關(guān)編譯的一些配置信息，里面的參數(shù)簡介如下：
- Path：CMake配置文件，提供CMake構(gòu)建腳本
- Arguments：傳遞給CMake的可選編譯參數(shù)
- cppFlags：設(shè)置C++編譯器的可選參數(shù)
6、Entry/oh-package.json5
{
"name": "entry",
"version": "1.0.0",
"description": "Please describe the basic information.",
"main": "",
"author": "",
"license": "",
"dependencies": {},
"devDependencies": {
"@types/libentry.so": "file:./src/main/cpp/types/libentry"
}
}應(yīng)用/服務(wù)支持通過ohpm來安裝、共享、分發(fā)代碼，管理項(xiàng)目的依賴關(guān)系，這里的devDependencies參數(shù)指的是開發(fā)時(shí)的需要依賴，用于本地環(huán)境開發(fā)時(shí)候所需要的依賴包。
新增功能
新增一個(gè)計(jì)算平方根的功能，輸入數(shù)字，實(shí)時(shí)計(jì)算該數(shù)的平方根。
修改頁面布局文件entry/src/ets/pages/Index.ets
import hilog from '@ohos.hilog';
import testNapi from 'libentry.so'
@Entry
@Component
struct Index {
@State message: string = 'Test NAPI 2 + 3 = '
@State numX: number = 0.0;
private textInputControllerX: TextInputController = new TextInputController();
build() {
Column() {
Row() {
Text(this.message)
.fontSize(30)
.fontWeight(FontWeight.Bold)
.onClick(() => {
hilog.info(0x0000, 'testTag', 'Test NAPI 2 + 3 = %{public}d', testNapi.add(2, 3));
})
Text(testNapi.add(2, 3).toString())
.fontSize(40)
.fontColor(Color.Red)
}
.width('100%')
.justifyContent(FlexAlign.Center)
Column() {
Row() {
TextInput({ controller: this.textInputControllerX })
.width(100)
.type(InputType.Number)
.onChange(value => {
let temp = parseFloat(value);
this.numX = testNapi.sqrt(temp);
})
Text("的平方根=")
.fontSize(40)
Text(this.numX.toString())
.fontSize(40)
.fontColor(Color.Green)
}
.width('100%')
.justifyContent(FlexAlign.Center)
}
.width('100%')
.justifyContent(FlexAlign.Center)
.margin({ top: 100 })
}
.height('100%')
.justifyContent(FlexAlign.Center)
}
}修改底層庫實(shí)現(xiàn)文件Entry/src/main/cpp/types/hello.cpp
#include "napi/native_api.h"
#include "math.h"
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;
}
static napi_value Sqrt(napi_env env, napi_callback_info info)
{
size_t requireArgc = 1;
size_t argc = 1;
napi_value args[1] = {nullptr};
napi_get_cb_info(env, info, &argc, args , nullptr, nullptr);
napi_valuetype valuetype0;
napi_typeof(env, args[0], &valuetype0);
double value0;
napi_get_value_double(env, args[0], &value0);
napi_value result;
napi_create_double(env, sqrt(value0), &result);
return result;
}
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 },
{ "sqrt", nullptr, Sqrt, nullptr, nullptr, nullptr, napi_default, nullptr }
};
napi_define_properties(env, exports, sizeof(desc) / sizeof(desc[0]), desc);
return exports;
}
EXTERN_C_END
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);
}在模擬器上查看一下效果：
學(xué)習(xí)總結(jié)
通過這次學(xué)習(xí)，簡單了解了ArkTS調(diào)用native函數(shù)的方法，雖然了解的不是很深入，但對(duì)大體框架有了一定的掌握，為以后更復(fù)雜的native調(diào)用開發(fā)奠定了基礎(chǔ)。
