HarmonOS实战开发：Node-API接口适配模块加载指导

2024-09-02 04:36
文章标签 实战 模块 加载 接口 开发 api node 指导 适配 harmonos

本文主要是介绍HarmonOS实战开发：Node-API接口适配模块加载指导，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

Node-API中的napi_load_module_with_info接口的功能是进行模块的加载，当模块加载出来之后，可以使用函数napi_get_property获取模块导出的变量，也可以使用napi_get_named_property获取模块导出的函数，该函数可以在新创建的ArkTs基础运行时环境中使用

函数说明

napi_status napi_load_module_with_info(napi_env env,const char* path,const char* module_info,napi_value* result);
参数说明
env当前的虚拟机环境
path加载的文件路径或者模块名
module_infobundleName/moduleName的路径拼接
result加载的模块

注意

  1. bundleName表示AppScope/app.json5中配置的工程名
  2. moduleName指的是待加载模块所在的HAP下module.json5中配置的名字
  3. napi_load_module只局限于在主线程中进行模块加载

napi_load_module_with_info支持的场景

场景详细分类说明
本地工程模块HAP加载模块内文件路径要求路径以moduleName开头
本地工程模块HAP加载HAR模块名-
远程包HAP加载远程HAR模块名-
远程包HAP加载ohpm包名-
APIHAP加载@ohos.或 @system.-
模块Native库HAP加载libNativeLibrary.so-

注意

  1. 加载一个模块名，实际的行为是加载该模块的入口文件，一般为index.ets/ts。
  2. 如果在HAR中加载另外一个HAR，需要确保module_info的配置正确，尤其注意moduleName应为HAP的moduleName。
  3. 如果在HAP/HSP中直接或间接使用了三方包，该三方包中使用napi_load_module_with_info接口加载其他模块A，则需要在HAP/HSP中也添加A的依赖。

使用示例

  • HAP加载模块内文件路径

当加载文件中的模块时，如以下ArkTS代码：

//./src/main/ets/Test.ets
let value = 123;
function test() {console.log("Hello HarmonyOS");
}
export {value, test};
  • 需要在工程的build-profile.json5文件中进行以下配置
{"buildOption" : {"arkOptions" : {"runtimeOnly" : {"sources": ["./src/main/ets/Test.ets"]}}}
}
  • 使用napi_load_module_with_info加载Test文件，调用函数test以及获取变量value
static napi_value loadModule(napi_env env, napi_callback_info info) {napi_value result;//1. 使用napi_load_module_with_info加载Test文件中的模块napi_status status = napi_load_module_with_info(env, "entry/src/main/ets/Test", "com.example.application/entry", &result);napi_value testFn;//2. 使用napi_get_named_property获取test函数napi_get_named_property(env, result, "test", &testFn);//3. 使用napi_call_function调用函数testnapi_call_function(env, result, testFn, 0, nullptr, nullptr);napi_value value;napi_value key;std::string keyStr = "value";napi_create_string_utf8(env, keyStr.c_str(), keyStr.size(), &key);//4. 使用napi_get_property获取变量valuenapi_get_property(env, result, key, &value);return result;
}
  • HAP加载HAR模块名

HAR包Index.ets文件如下

//library Index.ets
let value = 123;
function test() {console.log("Hello HarmonyOS");
}
export {value, test};

在加载本地HAR包时，首先需要在oh-package.json5文件中配置dependencies项

{"dependencies": {"library": "file:../library"}
}

其次，还需要在build-profile.json5中进行配置

{"buildOption" : {"arkOptions" : {"runtimeOnly" : {"packages": ["library"]}}}
}

用napi_load_module_with_info加载library，调用函数test以及获取变量value

static napi_value loadModule(napi_env env, napi_callback_info info) {napi_value result;//1. 使用napi_load_module_with_info加载librarynapi_status status = napi_load_module_with_info(env, "library", "com.example.application/entry", &result);napi_value testFn;//2. 使用napi_get_named_property获取test函数napi_get_named_property(env, result, "test", &testFn);//3. 使用napi_call_function调用函数testnapi_call_function(env, result, testFn, 0, nullptr, nullptr);napi_value value;napi_value key;std::string keyStr = "value";napi_create_string_utf8(env, keyStr.c_str(), keyStr.size(), &key);//4. 使用napi_get_property获取变量valuenapi_get_property(env, result, key, &value);return result;
}
  • HAP加载远程HAR模块名

在远程HAR模块名时，首先需要在oh-package.json5文件中配置dependencies项

{"dependencies": {"@ohos/hypium": "1.0.16"}
}

其次，还需要在build-profile.json5中进行配置

{"buildOption" : {"arkOptions" : {"runtimeOnly" : {"packages": ["@ohos/hypium"]}}}
}

用napi_load_module_with_info加载@ohos/hypium，获取DEFAULT变量

static napi_value loadModule(napi_env env, napi_callback_info info) {napi_value result;//1. 使用napi_load_module_with_info加载@ohos/hypiumnapi_status status = napi_load_module_with_info(env, "@ohos/hypium", "com.example.application/entry", &result);napi_value key;std::string keyStr = "DEFAULT";napi_create_string_utf8(env, keyStr.c_str(), keyStr.size(), &key);//2. 使用napi_get_property获取DEFAULT变量napi_value defaultValue;napi_get_property(env, result, key, &defaultValue);return result;
}
  • HAP加载ohpm包名

在加载ohpm包时，首先需要在oh-package.json5文件中配置dependencies项

{"dependencies": {"json5": "^2.2.3"}
}

其次，还需要在build-profile.json5中进行配置

{"buildOption" : {"arkOptions" : {"runtimeOnly" : {"packages": ["json5"]}}}
}

用napi_load_module_with_info加载json5，调用函数stringify

static napi_value loadModule(napi_env env, napi_callback_info info) {napi_value result;//1. 使用napi_load_module_with_info加载json5napi_status status = napi_load_module_with_info(env, "json5", "com.example.application/entry", &result);napi_value key;std::string keyStr = "default";napi_create_string_utf8(env, keyStr.c_str(), keyStr.size(), &key);//2. 使用napi_get_property获取default对象napi_value defaultValue;napi_get_property(env, result, key, &defaultValue);napi_value stringifyFn;//3. 使用napi_get_named_property获取stringify函数napi_get_named_property(env, defaultValue, "stringify", &stringifyFn);//4. 使用napi_call_function调用函数stringifynapi_value argStr;std::string text = "call json5 stringify";napi_create_string_utf8(env, text.c_str(), text.size(), &argStr);napi_value args[1] = {argStr};napi_value returnValue;napi_call_function(env, defaultValue, stringifyFn, 1, args, &returnValue);return result;
}
  • HAP加载API模块
static napi_value loadModule(napi_env env, napi_callback_info info) {//1. 使用napi_load_module_with_info加载模块@ohos.hilognapi_value result;napi_status status = napi_load_module_with_info(env, "@ohos.hilog", nullptr, &result);//2. 使用napi_get_named_property获取info函数napi_value infoFn;napi_get_named_property(env, result, "info", &infoFn);napi_value tag;std::string formatStr = "test";napi_create_string_utf8(env, formatStr.c_str(), formatStr.size(), &tag);napi_value outputString;std::string str = "Hello HarmonyOS";napi_create_string_utf8(env, str.c_str(), str.size(), &outputString);napi_value flag;napi_create_int32(env, 0, &flag);napi_value args[3] = {flag, tag, outputString};//3. 使用napi_call_function调用info函数napi_call_function(env, result, infoFn, 3, args, nullptr);return result;
}
  • HAP加载Native库

libentry.so的index.d.ts文件如下

//index.d.ts
export const add: (a: number, b: number) => number;

在加载本地so库时，首先需要在oh-package.json5文件中配置dependencies项

{"dependencies": {"libentry.so": "file:../src/main/cpp/types/libentry"}
}

其次，还需要在build-profile.json5中进行配置

{"buildOption" : {"arkOptions" : {"runtimeOnly" : {"packages": ["libentry.so"]}}}
}

用napi_load_module_with_info加载libentry.so，调用函数add

static napi_value loadModule(napi_env env, napi_callback_info info) {napi_value result;//1. 使用napi_load_module_with_info加载libentry.sonapi_status status = napi_load_module_with_info(env, "libentry.so", "com.example.application/entry", &result);napi_value addFn;//2. 使用napi_get_named_property获取add函数napi_get_named_property(env, result, "add", &addFn);napi_value a;napi_value b;napi_create_int32(env, 2, &a);napi_create_int32(env, 3, &b);napi_value args[2] = {a, b};//3. 使用napi_call_function调用函数addnapi_value returnValue;napi_call_function(env, result, addFn, 2, args, &returnValue);return result;
}
  • HAR加载HAR模块名

场景为har1加载har2，har2中的Index.ets文件如下

//har2 Index.ets
let value = 123;
function test() {console.log("Hello HarmonyOS");
}
export {value, test};

在加载har2时，首先需要在har1中的oh-package.json5文件中配置dependencies项

{"dependencies": {"har2": "file:../har2"}
}

其次，还需要在har1的build-profile.json5文件中进行配置

{"buildOption" : {"arkOptions" : {"runtimeOnly" : {"packages": ["har2"]}}}
}

在har1中用napi_load_module_with_info加载har2，调用函数test以及获取变量value

static napi_value loadModule(napi_env env, napi_callback_info info) {napi_value result;//1. 使用napi_load_module_with_info加载har2，注意这里的moduleName为模块所在HAP包的moduleNamenapi_status status = napi_load_module_with_info(env, "har2", "com.example.application/entry", &result);napi_value testFn;//2. 使用napi_get_named_property获取test函数napi_get_named_property(env, result, "test", &testFn);//3. 使用napi_call_function调用函数testnapi_call_function(env, result, testFn, 0, nullptr, nullptr);napi_value value;napi_value key;std::string keyStr = "value";napi_create_string_utf8(env, keyStr.c_str(), keyStr.size(), &key);//4. 使用napi_get_property获取变量valuenapi_get_property(env, result, key, &value);return result;
}

这篇关于HarmonOS实战开发：Node-API接口适配模块加载指导的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1129010。

相关文章

Golang操作DuckDB实战案例分享

Golang操作DuckDB实战案例分享

《Golang操作DuckDB实战案例分享》DuckDB是一个嵌入式SQL数据库引擎,它与众所周知的SQLite非常相似,但它是为olap风格的工作负载设计的,DuckDB支持各种数据类型和SQL特性... 目录DuckDB的主要优点环境准备初始化表和数据查询单行或多行错误处理和事务完整代码最后总结Duck
阅读更多...
基于Python开发电脑定时关机工具

基于Python开发电脑定时关机工具

《基于Python开发电脑定时关机工具》这篇文章主要为大家详细介绍了如何基于Python开发一个电脑定时关机工具,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录1. 简介2. 运行效果3. 相关源码1. 简介这个程序就像一个“忠实的管家”，帮你按时关掉电脑，而且全程不需要你多做
阅读更多...
Java后端接口中提取请求头中的Cookie和Token的方法

Java后端接口中提取请求头中的Cookie和Token的方法

《Java后端接口中提取请求头中的Cookie和Token的方法》在现代Web开发中,HTTP请求头（Header）是客户端与服务器之间传递信息的重要方式之一,本文将详细介绍如何在Java后端（以Sp... 目录引言1. 背景1.1 什么是 HTTP 请求头？1.2 为什么需要提取请求头？2. 使用 Spr
阅读更多...
Java中的Opencv简介与开发环境部署方法

Java中的Opencv简介与开发环境部署方法

《Java中的Opencv简介与开发环境部署方法》OpenCV是一个开源的计算机视觉和图像处理库,提供了丰富的图像处理算法和工具,它支持多种图像处理和计算机视觉算法,可以用于物体识别与跟踪、图像分割与... 目录1.Opencv简介Opencv的应用2.Java使用OpenCV进行图像操作opencv安装j
阅读更多...
Python中的随机森林算法与实战

Python中的随机森林算法与实战

《Python中的随机森林算法与实战》本文详细介绍了随机森林算法,包括其原理、实现步骤、分类和回归案例,并讨论了其优点和缺点,通过面向对象编程实现了一个简单的随机森林模型,并应用于鸢尾花分类和波士顿房... 目录1、随机森林算法概述2、随机森林的原理3、实现步骤4、分类案例：使用随机森林预测鸢尾花品种4.1
阅读更多...
SpringBoot项目启动后自动加载系统配置的多种实现方式

SpringBoot项目启动后自动加载系统配置的多种实现方式

《SpringBoot项目启动后自动加载系统配置的多种实现方式》：本文主要介绍SpringBoot项目启动后自动加载系统配置的多种实现方式,并通过代码示例讲解的非常详细,对大家的学习或工作有一定的... 目录1. 使用 CommandLineRunner实现方式：2. 使用 ApplicationRunne
阅读更多...
使用SpringBoot创建一个RESTful API的详细步骤

使用SpringBoot创建一个RESTful API的详细步骤

《使用SpringBoot创建一个RESTfulAPI的详细步骤》使用Java的SpringBoot创建RESTfulAPI可以满足多种开发场景,它提供了快速开发、易于配置、可扩展、可维护的优点,尤... 目录一、创建 Spring Boot 项目二、创建控制器类（Controller Class）三、运行
阅读更多...
多模块的springboot项目发布指定模块的脚本方式

多模块的springboot项目发布指定模块的脚本方式

《多模块的springboot项目发布指定模块的脚本方式》该文章主要介绍了如何在多模块的SpringBoot项目中发布指定模块的脚本,作者原先的脚本会清理并编译所有模块,导致发布时间过长,通过简化脚本... 目录多模块的springboot项目发布指定模块的脚本1、不计成本地全部发布2、指定模块发布总结多模
阅读更多...
SpringBoot项目删除Bean或者不加载Bean的问题解决

SpringBoot项目删除Bean或者不加载Bean的问题解决

《SpringBoot项目删除Bean或者不加载Bean的问题解决》文章介绍了在SpringBoot项目中如何使用@ComponentScan注解和自定义过滤器实现不加载某些Bean的方法,本文通过实... 使用@ComponentScan注解中的@ComponentScan.Filter标记不加载。@C
阅读更多...
springboot 加载本地jar到maven的实现方法

springboot 加载本地jar到maven的实现方法

《springboot加载本地jar到maven的实现方法》如何在SpringBoot项目中加载本地jar到Maven本地仓库,使用Maven的install-file目标来实现,本文结合实例代码给... 在Spring Boothttp://www.chinasem.cn项目中，如果你想要加载一个本地的ja
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2