鸿蒙5.0开发进阶:NDK开发-使用Node-API接口进行函数创建和调用

JS调用C++模块中的函数 此API允许从C++侧调用 JavaScript 函数对象,例如本文的napi_call_function(env, global, cb, 0 , nullptr, &result);值得注意的是,本文JS侧传递给C++的回调函数是匿名函数,C++侧先将JS回调函数先在C++侧注册,即使用napi_create_reference将JS函数创建为ref,ref最终会作为napi_call_function的第三个参数,可以放心并没有在global对象里面直接去取函数引用。例如Add方法的代码, 阅读详情

往期鸿蒙全套实战文章必看:


简介

函数调用允许开发者从Node-API模块中调用ArkTS函数,并传递参数进行调用,或者直接在Node-API模块中创建一个ArkTS方法。

基本概念

函数是一种非常重要的编程概念,可以执行特定的任务或操作、提高代码的可读性、把复杂任务简化、提高代码复用性以及支持代码的组织与管理。每个函数可以负责不同的功能,提供一种将代码模块化和组织结构化的方式,使其更易于理解、维护和重用。

场景和功能介绍

接口描述
napi_get_cb_info当需要从给定的callback info中获取有关调用的参数信息和this指针时,可使用此接口。
napi_call_function当需要在Node-API模块中对ArkTS侧函数进行调用时,可使用此接口。
napi_create_function当需要将C/C++函数创建一个ArkTS函数时,可以使用此接口。

使用示例

本文仅对接口对应C++及ArkTS相关代码进行展示。napi_create_function方法除外,具体使用见示例。

napi_get_cb_info

获取有关函数调用的详细信息。

cpp部分代码

#include "napi/native_api.h"
// 获取ArkTS侧入参的的参数信息
static napi_value GetCbArgs(napi_env env, napi_callback_info info)
{
    size_t argc = 1;
    napi_value args[1] = {nullptr};
    napi_get_cb_info(env, info, &argc, args , nullptr, nullptr);
    return args[0];
}
// 获取ArkTS侧入参的参数个数
static napi_value GetCbArgQuantity(napi_env env, napi_callback_info info)
{
    size_t argc = 0;
    napi_value result = nullptr;
    napi_get_cb_info(env, info, &argc, nullptr, nullptr, nullptr);
    napi_create_int32(env, argc, &result);
    return result;
}
// 获取ArkTS侧this参数
static napi_value GetCbContext(napi_env env, napi_callback_info info)
{
    napi_value thisArg = nullptr;
    napi_get_cb_info(env, info, nullptr, nullptr, &thisArg, nullptr);
    return thisArg;
}

接口声明

// index.d.ts
export const getCbArgs: <T>(arg: T) => T;
// getCbArgQuantity的入参由用户自定义,在此用例中,我们用两个入参,一个是string,一个是number
export const getCbArgQuantity: (str: string, num: number) => number;
export const getCbContext: () => Object;

ArkTS 侧示例代码

import hilog from '@ohos.hilog'
import testNapi from 'libentry.so'
function summation(arr: Array<number>) {
  let sum: number = 0;
  for (let i = 0; i < arr.length; i++) {
    sum += arr[i];
  }
  return sum;
}
const str = 'message';
const arr = [0, 1, 2, 3, 4, 5];
const num = 526;
class Student {
  name: string;
  age: number;
  score: number;
  constructor(name: string, age: number, score: number) {
    this.name = name;
    this.age = age;
    this.score = score;
  }
}
let student = new Student('Alice', 18, 100);
// 获取参数
hilog.info(0x0000, 'testTag', 'Test Node-API napi_get_cb_info get string arg:%{public}s', testNapi.getCbArgs(str));
hilog.info(0x0000, 'testTag', 'Test Node-API napi_get_cb_info get array arg:%{public}s ', testNapi.getCbArgs(arr).toString());
hilog.info(0x0000, 'testTag', 'Test Node-API napi_get_cb_info get num arg:%{public}d ', testNapi.getCbArgs(num));
hilog.info(0x0000, 'testTag', 'Test Node-API napi_get_cb_info get undefined arg:%{public}s ', testNapi.getCbArgs(undefined));
hilog.info(0x0000, 'testTag', 'Test Node-API napi_get_cb_info get object arg:%{public}s ', JSON.stringify(testNapi.getCbArgs(student)));
hilog.info(0x0000, 'testTag', 'Test Node-API napi_get_cb_info get function arg:%{public}d ', testNapi.getCbArgs(summation(arr)));
// 获取参数个数
hilog.info(0x0000, 'testTag', 'Test Node-API napi_get_cb_info get arg quantity:%{public}d ', testNapi.getCbArgQuantity(str, num));
// 获取上下文
hilog.info(0x0000, 'testTag', 'Test Node-API napi_get_cb_info get thisArg:%{public}s ', testNapi.getCbContext().toString());

napi_call_function

在C/C++侧对ArkTS函数进行调用。

注意事项:napi_call_function传入的argv的长度必须大于等于argc声明的数量,且被初始化成nullptr。

cpp部分代码

#include "napi/native_api.h"

static napi_value CallFunction(napi_env env, napi_callback_info info)
{
    size_t argc = 1;
    napi_value argv[1] = {nullptr};
    // 获取ArkTS侧入参
    napi_get_cb_info(env, info, &argc, argv, nullptr, nullptr);
    // 获取全局对象,这里用global是因为napi_call_function的第二个参数是JS函数的this入参。
    napi_value global = nullptr;
    napi_get_global(env, &global);
    // 调用ArkTS方法
    napi_value result = nullptr;
    // 调用napi_call_function时传入的argv的长度必须大于等于argc声明的数量,且被初始化成nullptr
    napi_call_function(env, global, argv[0], argc, argv, &result);
    return result;
}

static napi_value ObjCallFunction(napi_env env, napi_callback_info info)
{
    // 获取ArkTS侧传递的两个参数
    size_t argc = 2;
    napi_value argv[2] = {nullptr};
    // 获取ArkTS侧入参
    napi_get_cb_info(env, info, &argc, argv, nullptr, nullptr);
    // 调用ArkTS方法
    napi_value result = nullptr;
    // 调用napi_call_function时传入的argv的长度必须大于等于argc声明的数量,且被初始化成nullptr
    napi_call_function(env, argv[0], argv[1], argc, argv, &result);
    return result;
}

接口声明

// index.d.ts
export const callFunction: (func: Function) => number;
export const objCallFunction: (obj: Object, func: Function) => number;

ArkTS 侧示例代码

import hilog from '@ohos.hilog'
import testNapi from 'libentry.so'

function returnNumber() {
  return 10;
}
class Person {
  age(): number {
    return 11;
  }
}
const person = new Person();
hilog.info(0x0000, 'testTag', 'Test Node-API call_function:%{public}d', testNapi.callFunction(returnNumber));
hilog.info(0x0000, 'testTag', 'Test Node-API call_function:%{public}d', testNapi.objCallFunction(person,person.age));

napi_create_function

将一个C/C++函数包装为可在ArkTS中调用的函数,并返回一个表示该函数的napi_value。

cpp部分代码

#include "napi/native_api.h"

static napi_value CalculateArea(napi_env env, napi_callback_info info)
{
    // 获取ArkTS侧传递的两个参数
    size_t argc = 2;
    napi_value args[2] = {nullptr};
    napi_get_cb_info(env, info, &argc, args, nullptr, nullptr);
    double width = 0;
    napi_get_value_double(env, args[0], &width);
    double height = 0;
    napi_get_value_double(env, args[1], &height);
    napi_value area = nullptr;
    napi_create_double(env, width * height, &area);
    return area;
}

EXTERN_C_START
static napi_value Init(napi_env env, napi_value exports) {
    napi_value fn = nullptr;
    napi_create_function(env, nullptr, 0, CalculateArea, nullptr, &fn);
    napi_set_named_property(env, exports, "calculateArea", fn);
    return exports;
}
EXTERN_C_END

接口声明

// index.d.ts
export const calculateArea: (width: number, height: number) => number;

ArkTS 侧示例代码

import hilog from '@ohos.hilog'
import testNapi from 'libentry.so'

hilog.info(0x0000, 'testTag', 'Test Node-API create_function:%{public}d ', testNapi.calculateArea(1.2, 4));

以上代码如果要在native cpp中打印日志,需在CMakeLists.txt文件中添加以下配置信息(并添加头文件:#include "hilog/log.h"):

// CMakeLists.txt
add_definitions( "-DLOG_DOMAIN=0xd0d0" )
add_definitions( "-DLOG_TAG=\"testTag\"" )
target_link_libraries(entry PUBLIC libhilog_ndk.z.so)

开源鸿蒙南向嵌入学习笔记——NAPI框架学习(一) NAPI其实是最早应该是来自node.js中的一个拓展库(也可以说是一整套API接口),叫Node-API,叫做N-API。是用来构建本地插件的API,将所有的nodejs底层数据结构黑盒化,封装成二进制接口,这样就可以实现不同版本的Node.js使用同样的接口,其目的是为了简化开发和维护。这是一条使用框架编写一些C/C++代码作为JS的接口的时需要注意的事情。黄同学在做一个板子的sample的时候发现,某个smaple的样例源码无法跑通,除了一些简单的语法错误,最主要的是函数定义时的参数类型。 阅读详情

相关推荐

【鸿蒙实在开发】HarmonyOS NEXT接口请求渲染

HTTP接口调用,即通过HTTP协议与服务器进行通信,常用于请求服务器数据或提交数据到服务器。在鸿蒙系统中,我们可以使用多种方法实现HTTP请求,包括@system.http模块、Axios(第三方库)等。下面将详细介绍这些方法的使用。本文详细介绍了在鸿蒙系统中如何实现HTTP接口调用,包括使用@system.http模块和第三方库的具体方法,并提供了错误处理与重试机制的实现方式。通过遵循最佳实践,开发者可以提高应用的健壮性和安全性,提升用户体验。

HarmonyOS007的博客 2965

N-API中的Promise功能的使用

本文介绍N-API中的Promise功能的使用。Promise相关的API一共有四个。在回调里,通过napi_resolve_deferred或napi_reject_deferred修改Promise(deferred)的状态,这时候,js层的回调就会被执行。以上就是N-API中关于Promise的使用。 本文介绍N-API中的Promise功能的使用。Promise相关的API一共有四个。 napi_create_promise // 创建一个Promise,类似new Promise n

Free雅轩的博客 978

鸿蒙HarmonyOS应用开发之NDK开发指南

build目录:放置预定义的toolchain脚本文件ohos.toolchain.cmakeCMake编译时需要读取该文件中的默认值,比如编译器架构、C++库链接方式等,因此在编译时会通过CMAKE_TOOLCHAIN_FILE指出该文件的路径,便于CMake在编译时定位到该文件。build-tools文件夹:放置NDK提供的编译工具# 键入下一行命令查看CMake的版本# 结果llvm文件夹:放置NDK提供的编译器。

YHDMYBY的博客 1939

基于C++的Node.js插件开发

1.c++类型到js类型的转换方式 c++与js的类型转换及函数调用有两种方式:NAPI和V8。 NAPI 1.模块接口导出 NAPI_MODULE_INIT() { napi_value fn = nullptr; NODE_API_CALL(env, napi_create_function(env, nullptr, 0, Init, nullptr, &fn)); NODE_API_CALL(env, napi_set_named_property(env, e

gb173652770的专栏 2556

鸿蒙HarmonyOS开发(5.0 Beta)NDK接口构建UI界面实践

NDK提供的UI组件能力如组件创建、树操作、属性设置、事件注册等是通过函数指针结构体(如ArkUI_NativeNodeAPI_1)进行暴露,该函数指针结构体可以通过模块查询接口获取。

yguyf1235的博客 1013

鸿蒙的NDK开发初级入门篇

鸿蒙的NDK开发之初级知识,什么的NDK 如何创建一个工程,创建工程以后他里面的文件都是做什么用的?

shayu8nian的博客 1532

鸿蒙5.0开发进阶:NDK代码开发-Node-API使用指南(使用Node-API接口进行函数创建和调用)

函数调用允许开发者从Node-API模块中调用ArkTS函数..........

Androidbye的博客 933

STM32 AFIO时钟开启时机与复用功能解析

在嵌入式系统开发中,GPIO复用是微控制器外设配置的核心技术之一。通过复用功能,单个物理引脚可以动态切换不同功能模式,如USART通信或普通IO。其实现原理依赖于芯片内部的时钟树架构和寄存器配置机制。AFIO(Alternate Function I/O)模块作为STM32的特色设计,专门处理引脚重映射、外部中断配置等高级功能。正确理解复用功能与AFIO时钟的关系,能显著提升嵌入式开发效率,避免资源浪费。本文以STM32为例,结合引脚重映射和USART配置等典型场景,详解AFIO时钟的实际应用规范与优化实践

weixin_42389113的博客 579

HarmonyOS中调用C/C++代码(NDK)的准备知识

HarmonyOS NDK开发指南摘要:NDK(Native Development Kit)是HarmonyOS提供的原生开发工具集,支持使用C/C++实现关键功能。它包含基础库(如libc、图形库)、跨语言Node-API接口等,适用于高性能计算、已有C/C++库复用等场景,但不推荐用于纯原生开发或需广泛兼容的应用。开发者需掌握Linux C编程、CMake构建、Node-API等知识,NDK目录包含预定义编译脚本和工具链。该工具链支持通过Clang/LLVM优化动态库编译,帮助开发者在游戏、物理模拟等

尽吾所能 分享永久免费知识 2589

MPN – 制造商物料编号(延伸)

此外,用户还可以在物料主数据中定义阻止MPN材料的原因,以及在采购订单创建时,是否可以将现有的MPN材料修改为其他MPN材料,从而实现对MPN材料的精细控制和管理。通过使用AMPL,用户可以指定每个MPN材料是否仅能为特定工厂或整个企业所有工厂采购、采购的时间段、是否必须属于特定修订级别、是否只能从特定制造商工厂采购以及是否被阻止及其原因。通过AMPL管理,企业可以规范采购流程,避免使用未经批准的材料,从而提高采购的透明度和效率,同时也为质量控制提供了保障‌。3、QM中的制造商物料。质量信息记录QI01。

yanzibing99的博客 2487

鸿蒙5.0开发进阶:NDK开发-使用Node-API扩展能力接口

本文仅对接口对应C++及ArkTS相关代码进行展示。

Androidbye的博客 965

Tomcat源码:Acceptor与Poller、PollerEvent

前文中我们介绍到NioEndpoint的start方法启动了Acceptor与Poller这两个异步线程来处理连接请求,本文我们就来接着介绍这两个组件。目录前言一、Acceptor1、构造方法2、run方法LimitLatchNioChannel二、Poller与PollerEvent2、pollerregisterruneventsprocessKey。

CRUD工程师 2068

鸿蒙5.0开发进阶:NDK开发-使用Node-API接口进行ArrayBuffer相关开发

本文仅对接口对应C++及ArkTS相关代码进行展示。

Androidbye的博客 1202

STM32 FOC半周期控制延时分析与硬件同步配置

在电机矢量控制(FOC)系统中,数字控制延时是影响电流环带宽、观测器收敛性与系统稳定性的核心瓶颈。其本质源于PWM更新、ADC采样与计算执行之间的时序错配,典型表现为1.5个PWM周期的相位滞后,导致滑模观测器(SMO)失效或高速振荡。通过零阶保持(ZOH)建模可量化该延时对系统相频特性的影响,并揭示其等效为0.5u(t)+0.5u(t−1)的平滑控制律。工程上突破的关键在于重构外设协同机制——以高级定时器重复计数器(RCR0)驱动中心对齐PWM的半周期更新事件,使控制量在0.5T_PWM内生效,同步触发多

flink9streamer的博客 1132

R语言中的summarise函数和mutate函数用于计算分组占比。下面是关于这两个函数的详细介绍以及相应的源代码示例:

R语言中的summarise函数和mutate函数用于计算分组占比。

CodeByte的博客 1183

鸿蒙5.0开发进阶:NDK开发-Node-API支持的数据类型和接口

是一个枚举数据类型,表示Node-API接口返回的状态信息

Androidbye的博客 1035

SAP项目中 Waterfall vs Agile 的深度对比分析背景:方法论的演进SAP项目实施方法论经历了显著的代际更替。早期以 ASAP(Accelerated SAP) 为代表,采用经典瀑

本文对比分析了SAP项目实施中瀑布模型(ASAP)与敏捷方法(SAP Activate)的核心差异。瀑布模型采用线性流程,需求固定但变更成本高;敏捷方法则通过迭代开发实现动态调整,强调最佳实践和用户持续参与。文章指出,SAP系统的复杂性使纯粹敏捷难以实施,需在标准化与定制化间取得平衡。最终建议根据项目特性选择方法论:稳定需求适用瀑布模型,变化频繁则推荐敏捷,而SAP Activate本质上是两者的结构化融合,代表未来趋势。关键在于匹配项目实际需求,而非盲目追随方法论潮流。

金牌架构师 346

鸿蒙5.0开发进阶:NDK开发-使用Node-API接口进行array相关开发

使用Node-API接口进行数组(array)相关开发时,涉及的基本概念主要包括数组的创建、访问、修改、遍历以及与数组相关的操作。

Androidbye的博客 1384

Matlab之机载雷达系统中的空时自适应处理(STAP)技术(附源码)

在第一个脉冲期间,天线 1 通过天线 N-1 接收的杂波返回与第二个脉冲期间天线 2 通过天线 N 接收的杂波返回相同。该算法可能需要搜索角度和多普勒的所有组合来定位目标,但对于示例,由于确切知道目标的位置,因此可以将处理器定向到该点。然而,接收到的信号不仅包含来自目标的反射回波,还包含来自被照亮地表的回波。然而,由于干扰器的白噪声性质,接收到的干扰信号占据了整个多普勒频段。在以下部分中,您将模拟来自目标、杂波和干扰器的返回,并说明 STAP 技术如何过滤来自接收信号的干扰。假设元件间距是波形波长的一半。

珞瑜的博客 7140

jdk-8u144-linux-x64.tar.gz.

该资源为搭建Linux系统Java环境用,资源的后缀为tar.gz格式的压缩包

鸿蒙5.0开发进阶:NDK开发-使用Node-API接口创建基本数据类型

本文仅对接口对应C++及ArkTS相关代码进行展示。

Androidbye的博客 1084

IEM模型,地表粗糙度模拟

利用微波反演土壤水分时候,利用IEM模型可以实现对随机地表的模拟

鸿蒙5.0开发进阶:NDK开发-使用Node-API接口操作bigint类型值

BigInt是ArkTS中用于表示任意精度整数的数据类型,它能够处理比Number类型更大范围的整数值。

Androidbye的博客 937

汉书HE8,好用的汇编代码编写工具

汉书HE8,好用的汇编代码编写工具早期编写汇编代码所用功能强大

NTscan扫描工具

ntscan是一个扫描器,可以扫描没有密码和弱密码的共享,先到配置文件中填写猜测的用户名和密码,扫描过程中右侧出现的是扫描日志。

鸿蒙5.0开发进阶:NDK开发-使用Node-API接口处理异步操作

使用Node-API接口处理异步操作。

Androidbye的博客 716

鸿蒙5.0开发进阶:NDK开发-使用Node-API接口进行模块加载

Node-API中的napi_load_module_with_info接口的功能是进行模块的加载.....

Androidbye的博客 761

鸿蒙5.0开发进阶:NDK开发-使用Node-API接口进行生命周期相关开发

napi_value的生命周期与其在ArkTS中的对应值的生命周期紧密相关。

Androidbye的博客 995

鸿蒙5.0开发进阶:NDK开发-使用Node-API接口设置ArkTS对象的属性

使用Node-API接口获取和设置ArkTS对象的属性。

Androidbye的博客 1218
上一篇: 鸿蒙5.0开发进阶:NDK开发-使用Node-API接口关联数据,使其生命周期与当前环境的生命周期相关联
下一篇: 鸿蒙5.0开发进阶:NDK开发-使用Node-API接口进行生命周期相关开发
懂你的大海
博客等级 码龄6年 9049粉丝 1381原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值