首页 > 其他分享 >新手入门ArkTS调用NATIVE库的学习笔记

新手入门ArkTS调用NATIVE库的学习笔记

时间：2023-09-18 12:01:57浏览次数：43  
标签：info ArkTS args nullptr value 新手入门 env napi NATIVE

【本文正在参加 2023「盲盒」+码有奖征文活动】，活动链接 https://ost.51cto.com/posts/25284

前言

本来想这周跟着HarmonyOS官网的codelabs学习一下ArkTS下对Native库的调用，不料harmonyos官网直接把这个Codelabs课程下线了，不知以后还会不会上线。上周五还看的挺正常的，自己还加入了浏览器的收藏夹，结果两天之后的今天就下线了，印象中那个课程讲的还挺详细的，想尝试在网上搜索一下同样的课程，看看有没有副本，结果也没找到。没法跟着官方学的太详细了，就自己盲学一下吧。原来的课程是基于Native C++模板，实现通过Native API调用C标准库的功能，我计划也按照这个步骤学习一下，首先了解一下新建Native工程的框架，然后在这个基础上增加对调用C标准库的支持。 1.png

框架介绍

1.新建Native C++工程，选中Stage模型， 2.png 3.png 项目创建完成后，工程目录结构如下， 4.png 很明显，在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

我们通过模拟器运行一下， 5.png 点击这个文本标签，会在log窗口打印如下日志， 6.png 演示不够直观，操作繁琐，看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%')
  }
}

现在的运行结果是这样的， 7.png 现在已经证实了项目是完整的可以正常运行，下面分析一下具体的项目结构。 8.png

基本项目结构：

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用于设定需要的最低版本的CMake project指定工程名为MyNativeApp Set 设置变量，指定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);
}

在模拟器上查看一下效果， anim.gif

学习总结

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

附件链接：https://ost.51cto.com/resource/3027

本文作者：droidzxy

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

​​51CTO 开源基础软件社区​​

​​https://ost.51cto.com/#bkwz​​

标签：info,ArkTS,args,nullptr,value,新手入门,env,napi,NATIVE
From： https://blog.51cto.com/harmonyos/7508759

相关文章

  • .net native aot dll 库函数导出和调用
    .net程序aot后，就是原生程序了，如果是aot的dll，是可以导出为等价于c语言的native的dll的。导出函数声明如下：[UnmanagedCallersOnly(EntryPoint="OutPut")]publicstaticintOutPut(){return1;}导出后，可以作为原生的dll调用了，在.net程序中，也可以通过pinvoke的方式调......
  • Knative 基础
    Knative项目简介读音为“kay-nay-tiv”，由Google于2018年7月正式发布Kubernetes平台的原生扩展组件，让其能够轻松地部署、运行和管理Serverless类型的云原生应用由RedHat、Google和IBM等公司，以及各种初创公司组成的开源社区共同维护目标在于Serverless技术标准化Knative是什......
  • Knative Serving v1.11.0 部署
    先决条件如果集群中只有一个节点，则至少需要6个CPU、6GB内存和30GB磁盘存储。如果集群中有多个节点，则每个节点至少需要2个CPU、4GB内存和20GB磁盘存储。您有一个使用Kubernetesv1.24或更高版本的集群。部署KnativeServing流程1.部署Service自定义资源......
  • Flipper 调试 react native 项目
    一、安装：1.在官网下载桌面应用Flipper官网地址FlipperGitHub首页2.打开程序，执行setupdoctor检测环境是否缺失参考官方文档二、使用全部安装完以后启动reactnative项目，flipper会检测到运行中的项目模拟器以expo构建的项目为例：1.安装expo-dev-client构建开......
  • native2ascii用法
    [b]1、native2ascii简介：[/b]native2ascii是sunjavasdk提供的一个工具。用来将别的文本类文件（比如*.txt,*.ini,*.properties,*.java等等）编码转为Unicode编码。为什么要进行转码，原因在于程序的国际化。Unicode编码的定义：Unicode（统一码、万国码、单一码）是一种在计算机上使用的字......
  • SpringBoot项目启动报错：An incompatible version [1.1.22] of the Apache Tomcat Nati
    问题解释：“安装了不兼容的ApacheTomcat原生库版本[1.1.22]，而Tomcat需要版本[1.2.14]”解决方法：①打开网页 http://archive.apache.org/dist/tomcat/tomcat-connectors/native/②        ③        ④     ......
  • react native项目安装需求
    1.创建RN项目2.安装路由依赖3.redux需求安装redux依赖4.第三方组件库5.打包及各种其他操作 安装指定依赖注意：**link**链接库已在RN(reactnative)0.60版本开始支持自动链接，不需要再手动link！！！ ###2.安装路由依赖#####安装所需包npminstall@react-navigation/native##......
  • delphi FireDAC 调用 Execute 提示 `[FireDAC][SQL Server Native Client 10.0]字符串
    FireDAC调用Execute提示[FireDAC][SQLServerNativeClient10.0]字符串数据，长度不匹配错误问题调用Execute向SQLServer数据库中批量插入数据时，参数中有BLOB数据类型（ftBlob、ftMemo等）时，出现[FireDAC][Phys][ODBC][Microsoft][SQLServerNativeClient10.0]字符串......
  • .Net native aot简单体验（一）
    .netnativeaot可以在发布时将IL代码编译为本地代码，从而提高应用程序的性能和效的发布方式，其主要优点有：缩小磁盘占用降低启动时间减少内存需求如果用于个人发布的小程序来说，还有如下两个优点：不用安装防止反编译虽然.net7就已经支持nativeaot了，但只能用......
  • [Bread.Mvc] 开源一款自用 MVC 框架，支持 Native AOT
    Bread.MvcBread.Mvc是一款完全支持NativeAOT的MVC框架，搭配同样支持AOT的Avalonia，让你的开发事半功倍。项目开源在Gitee，欢迎Star。1.Ioc容器IoC容器是MVC框架的核心，为了支持AOT，Bread.Mvc框架选择使用ZeroIoC作为IoC容器。ZeroIoC是一款摒弃了反射的IoC......

赞助商

阅读排行

网站主页关于我们联系我们网站地图

本网站内容转载自其他媒体，侵权联系[admin##ips99.com]。

Copyright © 2020-2023 IPS99 版权所有 IPS99