Harmony--新手入门ArkTS调用NATIVE库的学习笔记--其乐融融的IT技术小站

想了解更多关于开源的内容，请访问：

51CTO 开源基础软件社区

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

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

学习总结

通过这次学习，简单了解了ArkTS调用native函数的方法，虽然了解的不是很深入，但对大体框架有了一定的掌握，为以后更复杂的native调用开发奠定了基础。