鸿蒙5.0开发进阶:NDK代码开发-Node-API使用指南(使用Node-API接口处理异步操作)

鸿蒙HarmonyOS应用开发之使用DevEco Studio模板构建NDK工程 在很多复杂应用工程中,C++代码工程是通过CMake等构建系统以命令行方式来编译构建的,接下来介绍如何把已有的CMake工程切换到OpenHarmony工具链中,从而使用命令行CMake构建该工程。 阅读详情

往期鸿蒙5.0全套实战文章必看:(文中附带全栈鸿蒙5.0学习资料)


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

简介

使用Node-API接口处理异步操作。异步操作是指需要一定时间才能完成的操作,例如从网络下载数据或读取大型文件。与同步操作不同,异步操作不会阻塞主线程,而是会在后台执行。当异步操作完成后,事件循环将把它放入任务队列中,等待主线程空闲时执行。

基本概念

Promise是ArkTS中用来处理异步操作的对象,Promise有pending(待定)、fulfilled(已兑现)和rejected(已拒绝)三种状态,Promise的初始状态是pending,resolve函数可以使其状态从pending变为fulfilled(已兑现),reject函数可以使其状态从pending变为rejected(已拒绝),一旦兑现或拒绝Promise的状态将不能更改。下面是一些基本概念:

  • 同步: 同步是指代码按照顺序一行一行地执行,每行代码的执行都会等待上一行代码执行完成后再继续执行。在同步执行中,如果某个操作需要花费较长时间,那么整个程序的执行就会被阻塞,直到该操作完成才能继续执行后续代码。
  • 异步:异步是指任务可以同时执行,不需要等待上一个任务结束。在ArkTS中,常见的异步操作包括定时器、事件监听、网络请求等。异步任务不会阻塞后续任务的执行,而是通过回调函数或Promise对象来处理任务的结果。
  • Promise:Promise是一个ArkTS对象,用于处理异步操作。Promise作用于外部,通常通过then、catch和finally方法暴露给外部以添加自定义逻辑。
  • deferred:deferred是延迟对象,它可以与Promise对象关联,设置Promise的回调函数resolve和reject。deferred作用于内部,维护异步模型的状态并设置回调函数resolve和reject。
  • resolve:此函数可以将Promise的状态从pending(待定)改为fulfilled(已兑现),向resolve中传入的参数可以在Promise对象的then方法中获取。
  • reject:此函数可以将Promise的状态从pending(待定)改为rejected(已拒绝),向reject中传入的参数可以在Promise对象的catch方法中获取。

这些基本概念在处理异步操作中非常重要,开发者需要通过适当的方法来处理异步操作,Promise可以链式调用多个异步操作,使代码清晰整洁,便于维护。Node-API提供的方法可以帮助开发者在C/C++应用中处理ArkTS中的异步操作。

场景和功能介绍

以下Node-API接口主要用于与ArkTS Promise对象进行交互。他们的使用场景如下:

接口描述
napi_is_promise检查一个napi_value是否代表一个Promise对象时,可以使用这个函数。
napi_create_promise需要创建一个Promise对象时,可以使用这个函数。
napi_resolve_deferred当你需要对promise关联的deferred对象进行resolve,将其从挂起状态转换为已解决状态时,可以使用这个函数。
napi_reject_deferred当你需要对promise关联的deferred对象进行reject,将其从挂起状态转换为已拒绝状态时,可以使用这个函数。

使用示例

Node-API接口开发流程参考使用Node-API实现跨语言交互开发流程,本文仅对接口对应C++及ArkTS相关代码进行展示。

napi_is_promise

判断给定的napi_value是否表示一个Promise对象。

cpp部分代码

#include "napi/native_api.h"

static napi_value IsPromise(napi_env env, napi_callback_info info)
{
    napi_value argv[1] = {nullptr};
    size_t argc = 1;
    napi_status status;
    // 获取传入的参数
    napi_get_cb_info(env, info, &argc, argv, nullptr, nullptr);
    bool isPromise = false;
    // 检查给定的入参是否为Promise对象,将结果保存在isPromise变量中
    status = napi_is_promise(env, argv[0], &isPromise);
    if (status != napi_ok) {
        napi_throw_error(env, nullptr, "Node-API napi_is_promise failed");
        return nullptr;
    }
    napi_value result = nullptr;
    // 将isPromise的值转换为napi_value中的类型返回
    napi_get_boolean(env, isPromise, &result);
    return result;
}

接口声明

// index.d.ts
export const isPromise: <T>(value: T) => boolean;

ArkTS侧示例代码

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

let value = Promise.resolve();
// 传入的对象为Promise时,返回true,否则返回false
hilog.info(0x0000, 'Node-API', 'napi_is_promise %{public}s', testNapi.isPromise(value));
hilog.info(0x0000, 'Node-API', 'napi_is_promise string %{public}s', testNapi.isPromise(''));

napi_create_promise

napi_create_promise用于创建一个Promise对象。

使用该接口时应注意:

  1. 当有异常未处理时调用napi_create_promise,会返回napi_pending_exception。
  2. 使用napi_create_promise后未判断返回值是否为napi_ok,之后使用了无效的deferred和promise导致应用崩溃。
napi_value NapiPromiseDemo(napi_env env, napi_callback_info)
{
    napi_deferred deferred = nullptr;
    napi_value promise = nullptr;
    napi_status status = napi_ok;

    napi_throw_error(env, "500", "common error");

    status = napi_create_promise(env, &deferred, &promise); // 有异常返回napi_pending_exception,且deferred、promise都为nullptr
    if (status == napi_ok) {
        // do something
    }

    return nullptr;
}

napi_resolve_deferred & napi_reject_deferred

用于对Promise关联的deferred对象进行解析,napi_resolve_deferred将其从挂起状态转换为已兑现状态,napi_reject_deferred将其从挂起状态转换为已拒绝状态。

为确保微任务能正确的被执行,ArkTS运行时在使用Node-API方法兑现Promise时,将会触发一次微任务的执行。

cpp部分代码

#include "napi/native_api.h"

static constexpr int INT_ARG_2 = 2; // 入参索引

static napi_value CreatePromise(napi_env env, napi_callback_info info)
{
    // deferred是一个延迟对象,作用是将函数延迟一定时间再执行
    napi_deferred deferred = nullptr;
    napi_value promise = nullptr;
    // 调用接口创建Promise对象
    napi_status status = napi_create_promise(env, &deferred, &promise);
    if (status != napi_ok) {
        napi_throw_error(env, nullptr, "Create promise failed");
        return nullptr;
    }
    // 调用napi_is_promise判断napi_create_promise接口创建的是不是Promise对象
    bool isPromise = false;
    napi_value returnIsPromise = nullptr;
    napi_is_promise(env, promise, &isPromise);
    // 将布尔值转为可以返回的napi_value
    napi_get_boolean(env, isPromise, &returnIsPromise);
    return returnIsPromise;
}

static napi_value ResolveRejectDeferred(napi_env env, napi_callback_info info)
{
    // 获得并解析参数
    size_t argc = 3;
    napi_value args[3] = {nullptr};
    napi_get_cb_info(env, info, &argc, args, nullptr, nullptr);
    // 第一个参数为向resolve传入的信息,第二个参数为向reject传入的信息,第三个参数为Promise的状态
    bool status;
    napi_get_value_bool(env, args[INT_ARG_2], &status);
    // 创建Promise对象
    napi_deferred deferred = nullptr;
    napi_value promise = nullptr;
    napi_status createStatus = napi_create_promise(env, &deferred, &promise);
    if (createStatus != napi_ok) {
        napi_throw_error(env, nullptr, "Create promise failed");
        return nullptr;
    }
    // 根据第三个参数设置resolve或reject
    if (status) {
        napi_resolve_deferred(env, deferred, args[0]);
    } else {
        napi_reject_deferred(env, deferred, args[1]);
    }
    // 返回设置了resolve或reject的Promise对象
    return promise;
}

接口声明

// index.d.ts
export const createPromise: () => boolean | void;
export const resolveRejectDeferred: (resolve: string, reject: string, status: boolean) => Promise<string> | void;

ArkTS侧示例代码

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

// 创建promise如果创建成功返回true,创建失败返回false
hilog.info(0x0000, 'Node-API', 'napi_create_promise %{public}s', testNapi.createPromise());
// 调用resolveRejectDeferred函数设置resolve和reject的返回结果以及Promise状态
// Promise状态为true时设置resolve,返回结果在then函数中获得
let promiseSuccess: Promise<string> = testNapi.resolveRejectDeferred('success', 'fail', true) as Promise<string>;
promiseSuccess.then((res) => {
  hilog.info(0x0000, 'Node-API', 'get_resolve_deferred resolve %{public}s', res)
}).catch((err: Error) => {
  hilog.info(0x0000, 'Node-API', 'get_resolve_deferred reject %{public}s', err)
})
// Promise状态为false时设置reject,返回结果在catch函数中获得
let promiseFail: Promise<string> = testNapi.resolveRejectDeferred('success', 'fail', false) as Promise<string>;
promiseFail.then((res) => {
  hilog.info(0x0000, 'Node-API', 'get_resolve_deferred resolve %{public}s', res)
}).catch((err: Error) => {
  hilog.info(0x0000, 'Node-API', 'get_resolve_deferred reject %{public}s', err)
})

以上代码如果要在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)

鸿蒙HarmonyOS开发实战:网络组件API使用规范总结 该工具类提供统一简化各种请求方式,入参为json格式内部进行转换为所需对象 阅读详情

相关推荐

【Docker】Docker安装Hadoop分布式集群

hadoop目录安装在:/usr/local/hadoop-2.7.0/etc/hadoop。访问Hadoop102:9870,查看是否能够看到hdfs界面。访问hadoop103:8088,查看能够看到yarn界面。在yarn上可以看到执行情况。

weixin_46429290的博客 3462

基于原生能力的设备唯一ID方案

hongxiaomeng的博客 794

深信服桌面云实战:从零部署到高效运维的关键配置指南

本文提供了一份深信服桌面云从零部署到高效运维的实战指南。内容涵盖项目启动阶段的资源、网络与存储规划,详细演示了VMP与VDC平台的安装与对接,并深入讲解了制作虚拟机模板、配置用户体系、优化终端策略等核心步骤。最后,分享了包括CPU公平分配、智能调度在内的关键性能调优与高阶运维技巧,旨在帮助管理员构建稳定、高效的云桌面环境。

blockchain9miner的博客 452

鸿蒙开发HarmonyOS3.1 API8-》API9​

转自华为开发者联盟。

FIEforever的博客 6303

Matlab实战:12种优化算法在CEC2014测试集上的性能对比(附完整代码)

本文详细对比了12种优化算法在CEC2014测试集上的性能表现,包括PSO、DE、GA等主流算法。通过Matlab实现完整的实验流程,涵盖算法实现、参数设置、结果分析与可视化,为工程优化问题提供实用解决方案。特别关注收敛曲线和评价指标,帮助读者选择最适合特定场景的优化算法。

wine的专栏 683

【速通版!语义通信基础与前沿学习计划】

🧠语义通信基础与前沿学习计划

dally2的博客 1415

鸿蒙5.0开发进阶:NDK代码开发-JSVM-API调优&高性能使用(JSVM 通用调优实践)

使用 JSVM 的过程中....

Androidbye的博客 833

BCIC IV 2a数据集实战:从MATLAB导入到EEG信号分析全流程

本文提供了BCIC IV 2a数据集从MATLAB导入到EEG信号分析的完整实战流程。详细解析了数据集结构,区分了EEG与EOG信号,并演示了信号可视化、基础预处理(滤波、分段、基线校正)等关键步骤,帮助脑机接口研究者快速上手处理这一经典运动想象数据集。

weixin_29047919的博客 473

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

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

Androidbye的博客 716

AWR1642+DCA1000EVM 不使用mmWave Studio软件采集原始ADC数据 Timeout问题汇总

DCA1000 EVM Timeout问题汇总

Jesy_Hsu的博客 1476

量子化学仿真软件:VASP_(7).表面与界面性质模拟

在量子化学仿真软件领域,表面与界面性质的模拟是研究多相催化、表面反应、材料科学等领域的关键工具。VASP(Vienna Ab Initio Simulation Package)作为一种广泛使用的密度泛函理论(DFT)计算软件,提供了强大的功能来模拟表面与界面的性质。本节将详细介绍如何使用VASP进行表面与界面性质的模拟,包括模型构建、输入文件准备、计算设置、结果分析等步骤。

kkchenjj的博客 951

鸿蒙5.0开发进阶:NDK代码开发-Node-API典型使用场景(使用Node-API接口进行异步任务开发)

napi_create_async_work是Node-API接口之一,用于创建一个异步工作对象。

Androidbye的博客 1052

zabbix系列:内存VM.MEMORY.SIZE监控之total、free、pused、available 参数说明

free -m buffer是即将要被写入磁盘的,而cache是被从磁盘中读出来的. zabbix Web total:1046/1024=1.02G Available:216/1046=20.65% zabbix参数 total- 总物理内存. free- 可用内存. active- 内存当前使用或最近使用,所以它在RAM中。 inactive- 未使用内存. wired- 被标记为始终驻留在RAM中的内...

NIO4444 5670

鸿蒙5.0开发进阶:NDK开发-使用Node-API接口进行异步任务开发

napi_create_async_work是Node-API接口之一,用于创建一个异步工作对象。

Androidbye的博客 1126

lwip-2.0.3

lwip是瑞典计算机科学院(SICS)的Adam Dunkels 开发的一个小型开源的TCP/IP协议栈。实现的重点是在保持TCP协议主要功能的基础上减少对RAM 的占用。

VC中sqlite的使用

在VC中对sqlite的使用,实现数据库大批数据的快速插入,读取数据库中的数据在ListCtrl中显示

鸿蒙5.0&next开发【使用Node-API接口进行异步任务开发】NDK开发

napi_create_async_work是Node-API接口之一,用于创建一个异步工作对象。可以在需要执行耗时操作的场景中使用,以避免阻塞主线程,确保应用程序的性能和响应性能。

bbq的博客 1090

ssm框架搭建

这个是一个在idea上成功跑起来的ssm框架项目,保存在这里方便以后使用直接下载

鸿蒙5.0开发进阶:NDK开发-使用Node-API进行自定义异步操作相关开发

使用Node-API的自定义异步操作功能...........

Androidbye的博客 727

jre9下载 jdk9

(Java SE Runtime Environment 9.0) 9.0u175 官方最新版 【x86|x64】

鸿蒙5.0开发进阶:NDK代码开发-Node-API使用指南(使用Node-API进行自定义异步操作相关开发)

使用Node-API的自定义异步操作功能.........

Androidbye的博客 912

鸿蒙5.0开发进阶:NDK代码开发-Node-API典型使用场景(使用扩展的Node-API接口在异步线程中运行和停止事件循环)

开发者在自己创建的ArkTS运行环境中调用异步的ArkTS接口时.....

Androidbye的博客 758

鸿蒙5.0开发进阶:NDK代码开发-Node-API典型使用场景(使用Node-API接口从异步线程向ArkTS线程投递指定优先级和入队方式的的任务)

Node-API中的napi_call_threadsafe_function_with_priority接口的功能是从异步线程向ArkTS线程投递任务......

Androidbye的博客 717

鸿蒙5.0开发进阶:NDK代码开发-Node-API使用指南(使用Node-API接口注册和使用环境清理钩子)

使用Node-API接口在进程退出时处理未释放资源.....

Androidbye的博客 730

鸿蒙5.0开发进阶:NDK开发-Node-API开发规范

Node-API开发规范.............

Androidbye的博客 773

鸿蒙5.0开发进阶:NDK开发-使用Node-API接口从异步线程向ArkTS线程投递指定优先级和入队方式的的任务

Node-API中的napi_call_threadsafe_function_with_priority接口的功能是从异步线程向ArkTS线程投递任务.....

Androidbye的博客 851

鸿蒙5.0开发进阶:NDK代码开发-Node-API使用指南(使用Node-API接口关于其他实用工具)

Node-API接口提供了一些实用接口,可以帮助开发者更好地进行Node-API相关开发。

Androidbye的博客 634

鸿蒙5.0&next开发【使用Node-API接口处理异步操作】NDK开发

使用Node-API接口处理异步操作。异步操作是指需要一定时间才能完成的操作,例如从网络下载数据或读取大型文件。与同步操作不同,异步操作不会阻塞主线程,而是会在后台执行。当异步操作完成后,事件循环将把它放入任务队列中,等待主线程空闲时执行。

bbq的博客 851

鸿蒙5.0开发进阶:NDK开发-使用扩展的Node-API接口在异步线程中运行和停止事件循环

开发者在自己创建的ArkTS运行环境中调用异步的ArkTS接口时......

Androidbye的博客 767

鸿蒙5.0开发进阶:NDK开发-使用Node-API接口注册和使用环境清理钩子

使用Node-API接口在进程退出时处理未释放资源............

Androidbye的博客 1000
上一篇: 鸿蒙5.0开发进阶:NDK代码开发-Node-API使用指南(使用Node-API接口进行primitive类相关开发)
下一篇: 鸿蒙5.0开发进阶:NDK代码开发-Node-API使用指南(使用Node-API接口设置ArkTS对象的属性)
懂你的大海
博客等级 码龄6年 9049粉丝 1381原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明:

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

余额充值