# 使用NAPI接口在C++新创建的线程中进行模块加载

Node-API中的napi_load_module_with_info接口的功能是支持在C++新创建的线程中进行模块的加载，当模块加载出来之后，可以使用函数napi_get_property获取模块导出的变量，也可以使用napi_get_named_property获取模块导出的函数

## 函数说明
```cpp
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         | 加载的模块          | 

注：

1. bundleName表示AppScope/app.json5中配置的工程名
2. moduleName指的是待加载模块所在的HAP下module.json5中配置的名字

## napi_load_module_with_info支持的场景

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

## 使用示例

- **加载模块内文件路径**

当加载文件中的模块时，如以下ArkTS代码：
```javascript
//./src/main/ets/Test.ets
let value = 123;
function test() {
  console.log("Hello OpenHarmony");
}
export {value, test};
```

1. 需要在工程的build-profile.json5文件中进行以下配置
```json
{
    "buildOption" : {
        "arkOptions" : {
            "runtimeOnly" : {
                "sources": [
                    "./src/main/ets/Test.ets"
                ]
            }
        }
    }
}
```


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

```cpp
static napi_value loadModule(napi_env env, napi_callback_info info) {
    napi_value result;
    //1. 使用napi_load_module加载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
}
```

- **加载HAR模块名**

HAR包Index.ets文件如下
```javascript
//library Index.ets
let value = 123;
function test() {
  console.log("Hello OpenHarmony");
}
export {value, test};
```
1. 在加载本地HAR包时，首先需要在oh-package.json5文件中配置dependencies项
```json
{
    "dependencies": {
        "library": "file:../library"
    }
}
```
2. 其次，还需要在build-profile.json5中进项配置
```json
{
    "buildOption" : {
        "arkOptions" : {
            "runtimeOnly" : {
                "packages": [
                    "library"
                ]
            }
        }
    }
}
```

3. 用napi_load_module_with_info加载library，调用函数test以及获取变量value
```cpp
static napi_value loadModule(napi_env env, napi_callback_info info) {
    napi_value result;
    //1. 使用napi_load_module加载Test文件中的模块
    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
}
```

- **加载远程HAR模块名**
1. 在远程HAR模块名时，首先需要在oh-package.json5文件中配置dependencies项
```json
{
    "dependencies": {
        "@ohos/hypium": "1.0.16"
    }
}
```
2. 其次，还需要在build-profile.json5中进项配置
```json
{
    "buildOption" : {
        "arkOptions" : {
            "runtimeOnly" : {
                "packages": [
                    "@ohos/hypium"
                ]
            }
        }
    }
}
```
3. 用napi_load_module_with_info加载@ohos/hypium，获取DEFAULT变量
```cpp
static napi_value loadModule(napi_env env, napi_callback_info info) {
    napi_value result;
    //1. 使用napi_load_module加载@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
}
```

- **加载ohpm包名**
1. 在加载ohpm包时，首先需要在oh-package.json5文件中配置dependencies项
```json
{
    "dependencies": {
        "json5": "^2.2.3"
    }
}
```
2. 其次，还需要在build-profile.json5中进项配置
```json
{
    "buildOption" : {
        "arkOptions" : {
            "runtimeOnly" : {
                "packages": [
                    "json5"
                ]
            }
        }
    }
}
```

3. 用napi_load_module_with_info加载json5，调用函数stringify
```cpp
static napi_value loadModule(napi_env env, napi_callback_info info) {
    napi_value result;
    //1. 使用napi_load_module加载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 info = "call json5 stringify";
    napi_create_string_utf8(env, info.c_str(), info.size(), &argStr);
    napi_value args[1] = {argStr};

    napi_value returnValue;
    napi_call_function(env, result, stringifyFn, 1, args, &returnValue);
    return result
}
```

- **加载API模块**

```cpp
static napi_value loadModule(napi_env env, napi_callback_info info) {
    //1. 使用napi_load_module加载模块@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 OpenHarmony";
    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
}
```

- **模块Native库**
libentry.so的index.d.ts文件如下
```javascript
//index.d.ts
export const add: (a: number, b: number) => number;

```
1. 在加载本地so库时，首先需要在oh-package.json5文件中配置dependencies项
```json
{
    "dependencies": {
        "libentry.so": "file../src/main/cpp/types/libentry"
    }
}
```
2. 其次，还需要在build-profile.json5中进项配置
```json
{
    "buildOption" : {
        "arkOptions" : {
            "runtimeOnly" : {
                "packages": [
                    "libentry.so"
                ]
            }
        }
    }
}
```

3. 用napi_load_module_with_info加载libentry.so，调用函数add
```cpp
static napi_value loadModule(napi_env env, napi_callback_info info) {
    napi_value result;
    //1. 使用napi_load_module加载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", &result);
    
    napi_value a;
    napi_value b;
    napi_create_int32(env, 2, &a);
    napi_create_int32(env, 3, &b);
    napi_value args[1] = {a, b};
    //3. 使用napi_call_function调用函数add
    napi_value returnValue;
    napi_call_function(env, result, addFn, 2, args, &returnValue);
    return result
}
```