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

原创 已于 2024-10-26 20:53:41 修改 · 731 阅读 · 27 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#harmonyos #华为 #1024程序员节 #鸿蒙 #android #NDK #ArkTS

于 2024-10-26 20:53:09 首次发布

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

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};

  1. 需要在工程的build-profile.json5文件中进行以下配置：

    {
    "buildOption" : {
        "arkOptions" : {
            "runtimeOnly" : {
                "sources": [
                    "./src/main/ets/Test.ets"
                ]
            }
        }
    }
}

  2. 使用napi_load_module_with_info加载Test文件，调用函数test以及获取变量value。

    注意

    开启seNormalizedOHMUrl后(即将工程目录中与entry同级别的应用级build-profile.json5文件中strictMode属性的useNormalizedOHMUrl字段配置为true)，加载hap包内文件路径时，bundleName不会影响最终加载逻辑，会智能通过module名索引进程内对应的hap，例如：工程的bundleName为com.example.application，实际入参时填写为 com.example.application1，模块也能正常加载。

    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调用函数test
    napi_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获取变量value
    napi_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};

  1. 在oh-package.json5文件中配置dependencies项。

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

  2. 在build-profile.json5中进行配置：

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

  3. 用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加载library
    napi_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调用函数test
    napi_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获取变量value
    napi_get_property(env, result, key, &value);
    return result;
}
  • HAP加载远程HAR模块名

  1. 在oh-package.json5文件中配置dependencies项。

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

  2. 在build-profile.json5中进行配置：

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

  3. 用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/hypium
    napi_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包名

  1. 在oh-package.json5文件中配置dependencies项。

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

  2. 在build-profile.json5中进行配置：

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

  3. 用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加载json5
    napi_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调用函数stringify
    napi_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.hilog
    napi_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;

  1. 在oh-package.json5文件中配置dependencies项。

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

  2. 在build-profile.json5中进行配置：

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

  3. 用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.so
    napi_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调用函数add
    napi_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};

  1. 在har1中的oh-package.json5文件中配置dependencies项。

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

  2. 在har1的build-profile.json5文件中进行配置：

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

  3. 在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包的moduleName
    napi_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调用函数test
    napi_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获取变量value
    napi_get_property(env, result, key, &value);
    return result;
}

JS调用C++模块中的函数
Hens_Hello_Mr的博客
10-28 2582
此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方法的代码，
鸿蒙HarmonyOS应用开发之使用NAPI接口在主线程中进行模块加载
YHDMYBY的博客
08-23 789
Node-API中的napi_load_module接口的功能是在主线程中进行模块的加载，当模块加载出来之后，可以使用函 napi_get_property获取模块导出的变量，也可以使用napi_get_named_property获取模块导出的函数，目前支持以下场景：
如何在OpenHarmony上使用SeetaFace2人脸识别库？
OpenHarmony_dev的博客
08-22 2678
相信大部分同学们都已了解或接触过OpenAtom OpenHarmony（以下简称“OpenHarmony”）了，但你一定没在OpenHarmony上实现过人脸识别功能，跟着本文带你快速在OpenHarmony标准设备上基于SeetaFace2和OpenCV实现人脸识别。本项目实现了导入人脸模型、人脸框选和人脸识别三大功能，操作流程如下：1. 录入页面点击右下角按钮，跳转拍摄页面进行拍照；2. 选择一张或多张人脸作为训练模型，并设置对应的名字；3. 选择一张未录入的人脸图片，点击框选按钮实现人脸图片框选功能
鸿蒙5.0进阶开发：UI开发-使用懒加载开发长列表界面
AyomQAQ的博客
12-29 920
针对List、Grid、WaterFlow、Swiper组件，提供NodeAdapter对象替代ArkTS侧的LazyForEach功能...........
鸿蒙5.0进阶开发：UI开发-构建自定义组件
AyomQAQ的博客
12-30 1023
ArkUI开发框架在NDK接口提供了自定义UI组件的能力，这些能力包括自定义测算，自定义布局和自定义绘制。
鸿蒙5.0开发进阶：使用GTest测试C++案例
HSMMQAQ的博客
10-06 2058
本示例主要介绍如何在HarmonyOS NEXT应用中使用GTest测试C++代码。
鸿蒙5.0进阶开发：UI开发-自定义渲染节点 (RenderNode)
AyomQAQ的博客
12-28 1069
对于不具备自己的渲染环境的三方框架，尽管已实现前端解析、布局及事件处理等功能，但仍需依赖系统的基础渲染和动画能力。
鸿蒙5.0进阶开发：UI开发-通过XComponent接入无障碍
最新发布
AyomQAQ的博客
12-30 1196
通过XComponent接入的三方平台，NDK提供了对接无障碍的接口函数，实现三方平台的组件在ArkUI中的无障碍能力。
NAPI 传递数据给JS
11-11 939
【代码】NAPI 传递数据给JS。
Openharmony应用NAPI详解--基础篇
热门推荐
流风的专栏
01-20 1万+
NAPI应用 Openharmony
基于C++的Node.js插件开发
gb173652770的专栏
08-06 2449
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
HarmonOS实战开发：Node-API接口适配模块加载指导
weqwe6668的博客
09-01 1216
如果在HAR中加载另外一个HAR，需要确保module_info的配置正确，尤其注意moduleName应为HAP的moduleName。
基于napi_load_module_with_info实现的napi调用arkts的接口
hongxiaomeng的博客
06-07 989
C++对JS Object的操作
Hens_Hello_Mr的博客
10-28 1301
N-API提供一些API来创建JavaScript所有类型值。
【鸿蒙实战开发】基于Napi调用ArkTS/系统接口
HarmonyOSMN的博客
06-27 1290
app应用在native侧调用 系统库/arkts模块的方法。应用经常会遇到如下的业务诉求：场景一：系统提供了ArkTS 接口，但未提供对应的NDK接口，当伙伴使用C++ 代码实现业务逻辑时，部分系统能力需要依赖系统ArkTS接口；场景二: 系统仅提供了ArkTS 异步接口，未提供对应的NDK接口，当伙伴使用C++ 代码实现业务逻辑时，部分系统能力需要依赖系统ArkTS 异步接口；
鸿蒙(HarmonyOS)实战开发篇——跨语言的复杂参数类型传递
lc748258的博客
10-08 1347
我们经常在ArkTS与C++之间相互传递参数，那么具体该如何传呢？下面介绍了几个常用的场景：
跨语言的复杂参数类型传递
hongxiaomeng的博客
06-07 1831
Android开发进阶：NDK实战指南
"Android开发入门与实战——期刊7，主要探讨NDK开发，适合初学者和有一定经验的开发者，内容涵盖NDK环境配置和实例开发，旨在帮助快速掌握原生C/C++编程在Android上的应用。" NDK，全称为Native Development Kit，...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值