NAPI笔记

已于 2022-07-19 15:59:31 修改
阅读量3.4k 收藏 19
点赞数 3
分类专栏： C++ 文章标签： c++ node.js javascript 后端
于 2022-07-14 14:01:21 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/sunshine_xq/article/details/125780097
版权

NAPI使用笔记

NAPI简介

NAPI是什么

NAPI提供了一套C/C++接口，用于js和C/C++之间的转换调用，起到承上启下的作用。

NAPI官网链接

NAPI官网提供了详细的接口说明以及使用方法，链接如下，
http://nodejs.cn/api/n-api.html（中文）
https://nodejs.org/api/n-api.html (英文)

NAPI基本数据类型

基本数据类型简介

napi_status

NAPI中大多函数的返回值。枚举值，用于表示函数调用的结果。函数调用成功的时候返回napi_ok。

napi_env

表示上下文，一般使用的时候正常传递就行。

napi_value

对所有js的基本值的封装。

napi_async_work

用于管理异步工作线程。一般使用napi_create_async_work/napi_queue_async_work/napi_delete_async_work进行创建/排队/删除异步工作线程。

……

类型转换：C++ -> js

这里列举几个常见的数据类型，由C++转化成js数据的方法。

napi_env env;
napi_value value;

// int32_t -> number
int32_t int32Data = 1;
napi_create_int32(env, int32Data, &value)

// string
std::string stringData;
napi_create_string_utf8(env, stringData.c_str(), NAPI_AUTO_LENGTH, &value);

// bool -> boolean
bool boolData = false;
napi_get_boolean(env, boolData, &value);

// object: 这里举例的是包含point属性的一个object
napi_create_object(env, &value);
int32_t point = 0;
napi_value npoint;
napi_create_int32(env, point, &npoint);
napi_set_named_property(env, value, "point", npoint);

// vector<int32_t> -> array<number>
std::vector<int32_t> vecDatas;
vecDatas.push_back(1);
napi_create_array(env, &value);
size_t index = 0;
for (auto& vecData : vecDatas) {
    napi_value id;
    napi_create_int32(env, vecData, &id);
    napi_set_element(env, value, index, id);
    index++;
}

类型转换：js -> C++

这里列举几个常见的数据类型，由js转化成C++数据的方法。

napi_env env;
napi_value value;

// string
char outBuffer[1024 + 1] = {0};
size_t outSize = 0;
napi_get_value_string_utf8(env, value, outBuffer, 1024, &outSize);
std::string result = std::string(outBuffer);

// bool
bool result = false;
napi_get_value_bool(env, value, &result);

// number
int32_t result = 0;
napi_get_value_int32(env, args, &result);

NAPI实现

NAPI的实现应先进行模块注册。一般来说，每个js接口都应有一个绑定的C++接口进行底层逻辑的处理，所以模块注册的时候，也需要将对应的js接口和C++接口进行绑定。js接口有同步和异步两种模式，并且，异步模式中也有promise模式和callback模式。下文将对这三种类型的接口进行举例说明。

接口定义

这里列举几个接口示例，下文的NAPI接口实现也是在以下几个接口的基础上实现的。

// js接口
function helloWorld(key: string): string; // 同步调用接口
function helloWorld(key: string, callback: AsyncCallback<string>): void; // 异步调用接口，callback模式
function helloWorld(key: string): Promise<string>; // 异步调用接口，promise模式

// C++接口
static napi_value HelloWorld(napi_env env, napi_callback_info info);

模块注册

模块注册的时候应该将js接口和C++接口进行绑定并暴露出去。

#define DECLARE_NAPI_FUNCTION(name, func)                                         \
    {                                                                             \
        name, 0, func, 0, 0, 0, napi_default, 0                                   \
    }

// 模块初始化函数，用于绑定js和C++对应的接口
static napi_value Init(napi_env env, napi_value exports)
{
    napi_property_descriptor descriptor[] = {
        DECLARE_NAPI_FUNCTION("helloWorld", HelloWorld),
    };

    napi_define_properties(env, exports, sizeof(descriptor) / sizeof(descriptor[0]), descriptor);
    return exports;
}

NAPI_MODULE(hello, Init) // 注册hello模块

入参类型检查

当napi接口被调用时，最好对入参进行类型检查，以保障后续的逻辑处理。以下使用napi_typeof接口进行参数类型的判断，详细的接口参数说明可见NAPI官网。

bool CheckNumber(napi_env env, napi_value value)
	napi_valuetype type;
	napi_status status = napi_typeof(env, value, &type);
	if (status != napi_ok) {
	    return false;
	}

	if (type != napi_number) {
	    return false;
	}
	return true;
}

// napi_valuetype的枚举值如下
typedef enum {
  napi_undefined,
  napi_null,
  napi_boolean,
  napi_number,
  napi_string,
  napi_symbol,
  napi_object,
  napi_function,
  napi_external,
  napi_bigint,
} napi_valuetype;

同步回调

同步调用的接口，调用后会阻塞住js线程，直至接口的结果返回，一般逻辑处理简单且不耗时的接口会选择同步处理。

function helloWorld(key: string): string; // js接口
static napi_value HelloWorld(napi_env env, napi_callback_info info); // C++接口

NAPI的函数实现如下

static napi_value HelloWorld(napi_env env, napi_callback_info info)
{
    // 获取js的入参数据
    size_t argc = 1; // 参数个数
    napi_value argv = nullptr; // 参数的值
    napi_value thisVar = nullptr; // js对象的this指针
    void* data = nullptr; // 回调数据指针
    napi_get_cb_info(env, info, &argc, &argv, &thisVar, &data)
    NAPI_ASSERT(env, argc == 1, "requires 1 parameter");

    // 判断入参的类型是否正确
	napi_valuetype type = napi_undefined;
	napi_typeof(env, argv, &type);
    NAPI_ASSERT(env, type == napi_string, "the type of arg is not string");

    // 解析入参
    char outBuffer[1024 + 1] = {0};
    size_t outSize = 0;
    napi_get_value_string_utf8(env, argv, outBuffer, 1024, &outSize);
    std::string key = std::string(outBuffer);

    // 处理入参并向js返回结果
    napi_value result = nullptr;
    std::string value = key + "HelloWorld";
    napi_create_string_utf8(env, value.c_str(), NAPI_AUTO_LENGTH, &result);
    return result;
}

异步回调

由于js的单线程处理方式，为提高效率，使用异步回调的接口较多。为方便，以下NAPI的实现将promise模式和callback模式放到一起处理，也可分开实现。

// js接口
function helloWorld(key: string, callback: AsyncCallback<string>): void; // 异步调用接口，callback模式
function helloWorld(key: string): Promise<string>; // 异步调用接口，promise模式

// C++接口
static napi_value HelloWorld(napi_env env, napi_callback_info info);

NAPI的函数实现如下

struct HelloWorldCallBack {
    napi_async_work work;
    napi_ref callbackRef = nullptr; // 用于callback模式
    napi_deferred deferred; // 用于promise模式
    std::string key = "";
    std::string value = "";
    bool ret = false;
}

static napi_value HelloWorld(napi_env env, napi_callback_info info)
{
    // 获取js的入参数据
    size_t argc = 2; // 参数个数
    napi_value argv[2] = {0}; // 参数的值
    napi_value thisVar = nullptr; // js对象的this指针
    void* data = nullptr; // 回调数据指针
    napi_get_cb_info(env, info, &argc, argv, &thisVar, &data)
    NAPI_ASSERT(env, ((argc >= 1) && (argc <= 2)), "requires 1 parameter");

    // 判断入参的类型是否正确
	napi_valuetype type = napi_undefined;
	napi_typeof(env, argv[0], &type);
    NAPI_ASSERT(env, type == napi_string, "the type of argv[0] is not string");
    if (argc == 2) {
        napi_typeof(env, argv[1], &type);
        NAPI_ASSERT(env, type == napi_function, "the type of argv[1] is not function");
    }

    HelloWorldCallBack* callback = new HelloWorldCallBack();

    // 解析入参key
    char outBuffer[1024 + 1] = {0};
    size_t outSize = 0;
    napi_get_value_string_utf8(env, argv[0], outBuffer, 1024, &outSize);
    callback->key = std::string(outBuffer);

    // 解析入参callback
    if (argc == 2) {
        napi_create_reference(env, argv[1], 1, &callback->callbackRef);
    }

    napi_value promise = nullptr;
	// callback ref为空，说明是promise模式，反之是callback模式
    if (!callback->callbackRef) {
        napi_create_promise(env, &callback->deferred, &promise);
    } else {
        napi_get_undefined(env, &promise);
    }

    napi_value resource = nullptr;
    napi_create_string_utf8(env, "HelloWorld", NAPI_AUTO_LENGTH, &resource);
	// 创建异步工作
    napi_create_async_work(env, nullptr, resource,
        [](napi_env env, void* data) {
        	// napi_async_execute_callback方法，该方法会在新起的线程中运行，一般在此函数中调用C++接口进行异步处理操作。
            HelloWorldCallBack* callback = static_cast<HelloWorldCallBack*>(data);
            if (callback->key == "") {
                callback->ret = false;
            } else {
                callback->ret = true;
                callback->value = callback->key + "HelloWorld";
            }
        },
        [](napi_env env, napi_status status, void* data) {
        	// napi_async_complete_callback方法，该方法在js的主线程中运行，一般用于给js侧返回结果，此处最好不要进行耗时操作。
            HelloWorldCallBack* callback = static_cast<HelloWorldCallBack*>(data);
            napi_value result[2] = {0};

            if (callback->ret) {
                napi_create_string_utf8(env, callback->value.c_str(), NAPI_AUTO_LENGTH, &result[1]);
            } else {
                napi_get_undefined(env, &result[1]);
            }

            if (callback->callbackRef) {
                // callback模式
                // 根据execute函数的结果进行err code的赋值
                napi_value errCode = nullptr;
                napi_create_int32(env, callback->ret ? 0 : 1, &errCode);
                napi_create_object(env, &result[0]);
                napi_set_named_property(env, result[0], "code", errCode);

				// 调用对应的js的callback函数
                napi_value callback = nullptr;
                napi_get_reference_value(env, callback->callbackRef, &callback);
                napi_value returnValue;
                // 此函数的最后一个参数不可传nullptr，否则程序会崩溃
                napi_call_function(env, nullptr, callback, sizeof(result) / sizeof(result[0]), result, returnValue);
                napi_delete_reference(env, callback->callbackRef);
            } else {
                // promise模式
                if (callback->ret) {
                    napi_resolve_deferred(env, callback->deferred, result[1]);
                } else {
                    napi_reject_deferred(env, callback->deferred, result[1]);
                }
            }
            napi_delete_async_work(env, callback->work); // 异步任务完成之后删除任务
            delete callback;
        }, (void*)callback, &callback->work);
    napi_queue_async_work(env, callback->work); //异步任务入队列，排队执行
    return promise;
}

应用示例

以下对上文中提出的js接口进行应用举例。

同步接口的使用

var value = HelloWorld('key1');

异步接口的使用之promise模式

HelloWorld('key2').then((value) => {
    console.log('value is ' + value);
}).catch((error) => {
    console.log('error: ' + error);
});

异步接口的使用之callback模式

HelloWorld('key2', (err, value) => {
    console.log('err.code: ' + err.code + " value: " + value);
});

参考文献

https://ost.51cto.com/posts/8390

晒太阳的桔子
关注
  • 3
    点赞
  • 踩
  • 19
    收藏
    觉得还不错? 一键收藏
  • 2
    评论
专栏目录
鸿蒙HarmonyOS应用开发之Native与ArkTS对象绑定_鸿蒙@ohos
2401_84182073的博客
04-14 675
/ 通过napi_unwrap将jsThis之前绑定的C++对象取出，并对其进行操作。// 通过napi_unwrap将jsThis之前绑定的C++对象取出，并对其进行操作。// 通过napi_unwrap将jsThis之前绑定的C++对象取出，并对其进行操作。
NAPI
04-02
**NAPI：网络轮询接口** NAPI，全称为Network Polling Interface，是Linux内核中的一个机制，用于优化网络设备的数据包接收处理。在传统的中断驱动（Interrupt Driven）I/O模型中，网络适配器在接收到数据包时会...
napi系列学习基础篇——NAPI数据类型转换与同步调用
maniuT的博客
04-13 1324
napi的数据类型在的示例代码中，我们使用napi_create_string_utf8函数将C/C++ string转换成NAPI类型——napi_value。OpenHarmony NAPI将ECMAScript标准中定义的Boolean、Null、Undefined、Number、BigInt、String、Symbol和Object八种数据类型，以及函数对应的Function类型，统一封装成napi_value类型 (也称为JS类型)。该类型用于接收应用传递过来的数据以及返回数据给应用。
NAPI 类对象导出及其生命周期管理(上)
最新发布
m0_70748458的博客
05-15 330
触觉智能的这个rk3568开发板是笔者去年8月份网上冲浪购买的，4GB+32GB开发板 + 一块10.1英寸的MIPI屏幕 + 电源适配器　＋　usb调试器（搞开源鸿蒙用不上） 一共 739米。触觉智能一直在给 IDO-EVB3568-V1 开发板适配最新的OpenHarmony版本。例如2月1号发布Beta5，作为消费者的笔者立马收到了适配了IDO-EVB3568-V1的Beta5镜像包，有MIPI版本的和HDMI版本。程序的生命周期是指程序从启动，运行到结束的整个过程。
OpenHarmony NAPI 类对象导出及其生命周期管理(上)
weixin_58069108的博客
03-13 2498
OpenHarmony 中的 [N-API](https://gitee.com/openharmony/arkui_napi/tree/master)组件定义了由ArkTS (JS/ETS)语言编写的代码和 native 代码（使用 C/C++ 编写）交互的方式，由 Node.js Node-API 框架扩展而来。什么是Node.js Node-API 框架 Node.js Node-API为开发者提供了一套C/C++ API用于开发Node.js的Native扩展模块。从Node.js 8.0.
NAPI注册JS模块
11-07 385
4.3 BindNativeFunction 绑定一个类的接口，也就是公开给JS。4.2 napi_set_named_property 声明一个枚举类型给JS。4.1 napi_wrap用来创建一个js的类，注册给V8。对应d.ts的接口，C++侧需要注册相应的模块与之对应。1.需要 napi_module_register。2. moudule 参数。
对象包装object-wrap
Hens_Hello_Mr的博客
10-28 542
..// 调用napi_create_double方法把 C++类型转换成 napi_value 类型// 返回 napi_value 类型return sum;但是对于一些复杂的数据类型(如我们常用C++的类对象)，是不能直接返回一个napi_value数据的。这时我们需要对这些数据进行一系列操作后将其导出，这样JS才能使用导出后的对象。// JS侧对C++侧的类进行实例化// 调用类的实例对象上的操作方法。
鸿蒙HarmonyOS应用开发之Native与ArkTS对象绑定
maniuT的博客
03-27 673
通过napi_wrap将ArkTS对象与Native的C++对象绑定，后续操作时再通过将ArkTS对象绑定的C++对象取出，并对其进行操作。
napi.rar_V2 _linux napi
09-23
标题中的“napi.rar_V2_linux napi”表明这是一个与Linux内核网络接口相关的更新，具体是Network API（Network Application Programming Interface）的版本2。NAPI是一个用于优化Linux内核网络接收路径的机制，旨在...
Napi开发指导，用于指导在devco的native++模版中封装c++代码
03-13
Napi开发指导，用于指导在devco的native++模版中封装c++代码
网卡驱动带NAPI方式
12-26
在本文中，我们将深入探讨“网卡驱动带NAPI方式”，这是Linux内核中的一种高效网络数据包接收机制。 首先，我们来了解传统的中断驱动（Interrupt Driven）模式。在该模式下，每当网卡接收到一个数据包或发送完一个...
基于HarmonyOS ArkUI和napi的MQTT客户端实现
11-09
本资源提供了基于 HarmonyOS 的 ArkUI 和 napi 实现的 MQTT 客户端源码，帮助开发者更便捷地在 HarmonyOS 设备上构建 MQTT 相关功能。 首先，让我们深入了解 ArkUI 和 napi： 1. **ArkUI**：HarmonyOS 的应用框架...
C++对JS Object的操作
Hens_Hello_Mr的博客
10-28 791
N-API提供一些API来创建JavaScript所有类型值。
Openharmony应用NAPI详解--进阶篇1
流风的专栏
01-20 1万+
NAPI面向C++的异步接口 callback napi_create_async_work napi_queue_async_work
Openharmony应用NAPI详解--基础篇
热门推荐
流风的专栏
01-20 1万+
NAPI应用 Openharmony
napi_threadsafe_function 和 napi_async_work对比分析
Hens_Hello_Mr的博客
10-28 925
从用法和官方介绍角度来看，napi_threadsafe_function 和 napi_async_work 似乎是两个完全不相同的两个东西，但从源码分析他们实现的原理，是有很大重合度。以至于使用场景亦有重合的地方。读前须知uv_async_send、uv_async_init、uv_queue_work 具体用法和作用。napi_async_work 系列 API 具体用法和作用。线程安全函数 API 具体用法和作用。
异步任务async work用法
Hens_Hello_Mr的博客
10-28 235
【代码】async work。
如何在OpenHarmony上使用SeetaFace2人脸识别库？
OpenHarmony_dev的博客
08-22 1762
相信大部分同学们都已了解或接触过OpenAtom OpenHarmony（以下简称“OpenHarmony”）了，但你一定没在OpenHarmony上实现过人脸识别功能，跟着本文带你快速在OpenHarmony标准设备上基于SeetaFace2和OpenCV实现人脸识别。本项目实现了导入人脸模型、人脸框选和人脸识别三大功能，操作流程如下：1. 录入页面点击右下角按钮，跳转拍摄页面进行拍照；2. 选择一张或多张人脸作为训练模型，并设置对应的名字；3. 选择一张未录入的人脸图片，点击框选按钮实现人脸图片框选功能
linux NAPI
09-02
NAPI机制使用了一组函数接口，包括netif_napi_add、__napi_schedule和napi_schedule_prep等，这些接口允许驱动程序使用NAPI收包机制。此外，内核还提供了napi_poll函数，用于调用收包poll函数。NAPI的引入使得Linux...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值