新手入門ArkTS調用NATIVE庫的學習筆記

作者：droidzxy 2023-09-14 15:42:39

本篇簡單了解一下ArkTS調用Native函數的方法，雖然了解的不是很深入，但對大體框架有了一定的掌握，為以后更復雜的Native調用開發奠定了基礎。

https://ost.51cto.com

前言

本來想這周跟著HarmonyOS官網的codelabs學習一下ArkTS下對Native庫的調用，不料harmonyos官網直接把這個Codelabs課程下線了，不知以后還會不會上線。上周五還看的挺正常的，自己還加入了瀏覽器的收藏夾，結果兩天之后的今天就下線了，印象中那個課程講的還挺詳細的，想嘗試在網上搜索一下同樣的課程，看看有沒有副本，結果也沒找到。沒法跟著官方學的太詳細了，就自己盲學一下吧。原來的課程是基于Native C++模板，實現通過Native API調用C標準庫的功能，我計劃也按照這個步驟學習一下，首先了解一下新建Native工程的框架，然后在這個基礎上增加對調用C標準庫的支持。

框架介紹

新建Native C++工程，選中Stage模型。

項目創建完成后，工程目錄結構如下。

很明顯，在entry/src/main目錄下，與ets目錄同級有一個cpp目錄，這個目錄就包含了native部分的代碼，包括功能實現和編譯腳本。這個工程是可以直接運行的，不過運行效果只是一個HelloWorld，需要點擊這個組件才會執行native調用，結果顯示在標簽log中。

預覽器不支持native調用的預覽，會報錯。

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

我們通過模擬器運行一下。

點擊這個文本標簽，會在log窗口打印如下日志。

演示不夠直觀，操作繁瑣，看log也不方便，我們改一下，讓調用結果直接顯示在界面上。

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%')
  }
}

現在的運行結果是這樣的。

現在已經證實了項目是完整的可以正常運行，下面分析一下具體的項目結構。

基本項目結構：

1、Entry/src/main/cpp/types/libentry/index.d.ts

export const add: (a: number, b: number) => number;

接口描述文件，描述C++接口的方法名、入參、返回參數等信息，用來暴露lib庫相關的聲明。

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用于設定需要的最低版本的CMakeproject指定工程名為MyNativeAppSet 設置變量，指定NATIVERENDER_ROOT_PATH的位置include_directories命令用于在構建(build)中添加包含目錄add_library 使用指定的代碼向項目中增加一個庫。
target_link_libraries指定鏈接給定目標和/或其依賴項時要使用的庫或標志。將傳播鏈接庫目標的使用要求。目標依賴項的使用要求會影響其自身源的編譯。

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);
}

功能具體實現的源文件。
napi_module_register進行模塊注冊，nm_modname指的是模塊名稱，nm_register_func是模塊對外接口注冊函數。

5、Entry/build-profile.json5

{
  "apiType": 'stageMode',
  "buildOption": {
    "externalNativeOptions": {
      "path": "./src/main/cpp/CMakeLists.txt",
      "arguments": "",
      "cppFlags": "",
    }
  },
  "targets": [
    {
      "name": "default",
      "runtimeOS": "HarmonyOS"
    },
    {
      "name": "ohosTest",
    }
  ]
}

當前的模塊信息、編譯信息配置項，包括buildOption、targets配置等。
buildOption中的externalNativeOptions代表cpp相關編譯的一些配置信息，里面的參數簡介如下：

Path：CMake配置文件，提供CMake構建腳本
Arguments：傳遞給CMake的可選編譯參數
cppFlags：設置C++編譯器的可選參數

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"
  }
}

應用/服務支持通過ohpm來安裝、共享、分發代碼，管理項目的依賴關系，這里的devDependencies參數指的是開發時的需要依賴，用于本地環境開發時候所需要的依賴包。

新增功能

新增一個計算平方根的功能，輸入數字，實時計算該數的平方根。

修改頁面布局文件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)
  }
}

修改底層庫實現文件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);
}

在模擬器上查看一下效果：