目录

loadNativeModule (同步动态加载系统库接口)

本模块提供了同步动态加载系统库接口的能力。

本模块首批接口从API version 12开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

loadNativeModule

loadNativeModule(moduleName: string): Object

loadNativeModule接口用于同步动态加载native模块,目的是按需加载所需要的模块。

系统能力:SystemCapability.Utils.Lang

参数:

参数名 类型 必填 说明
moduleName string 是 加载的模块名。

返回值:

类型 说明
Object native模块的默认导出,需使用ArkTS的ESObject类型去接收。

错误码:

以下错误码的详细介绍请参见通用错误码和语言基础类库错误码。

错误码ID 错误信息
401 The parameter check failed.
10200301 Loading native module failed.

loadNativeModule支持的场景

场景 示例
系统库模块 加载@ohos.或@system.
应用内native模块 加载libNativeLibrary.so

[h2]使用注意事项

以加载libentry.so为例,需要完成以下配置。

  1. 在模块级oh-package.json5文件中配置dependencies字段。配置说明见模块级oh-package.json5。

    {
      "dependencies": {
        "libentry.so": "file:./src/main/cpp/types/libentry"
      }
    }
  2. 在模块级build-profile.json5文件中配置runtimeOnly.packages字段。配置说明见模块级build-profile.json5文件。

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

示例1:HAP加载系统库模块

let hilog: ESObject = loadNativeModule("@ohos.hilog");
hilog.info(0, "testTag", "loadNativeModule ohos.hilog success");

示例2:HAP加载Native库

libentry.so的index.d.ts文件内容如下:

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

完成使用注意事项中的依赖配置后,使用loadNativeModule加载libentry.so并调用add函数。

let module: ESObject = loadNativeModule("libentry.so");
let sum: number = module.add(1, 2);