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_info | bundleName/moduleName的路径拼接 |
| result | 加载的模块 |
注意
- bundleName表示AppScope/app.json5中配置的工程名
- moduleName指的是待加载模块所在的HAP下module.json5中配置的名字
- napi_load_module只局限于在主线程中进行模块加载
napi_load_module_with_info支持的场景
| 场景 | 详细分类 | 说明 |
|---|---|---|
| 本地工程模块 | HAP加载模块内文件路径 | 要求路径以moduleName开头 |
| 本地工程模块 | HAP加载HAR模块名 | - |
| 远程包 | HAP加载远程HAR模块名 | - |
| 远程包 | HAP加载ohpm包名 | - |
| API | HAP加载@ohos.或 @system. | - |
| 模块Native库 | HAP加载libNativeLibrary.so | - |
注意
- 加载一个模块名，实际的行为是加载该模块的入口文件，一般为index.ets/ts。
- 如果在HAR中加载另外一个HAR，需要确保module_info的配置正确，尤其注意moduleName应为HAP的moduleName。
- 如果在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;
}