loadNativeModule (Synchronously and Dynamically Loading a System Library)

This module provides the capability of synchronously and dynamically loading a system library.

NOTE

The initial APIs of this module are supported since API version 12. Newly added APIs will be marked with a superscript to indicate their earliest API version.

The APIs of this module can be used only in the stage model.

loadNativeModule

loadNativeModule(moduleName: string): Object

The loadNativeModule API is used to synchronously and dynamically load a native module, that is, only load the required module at a time. Using this API increases the time for loading the .so file. You need to evaluate the impact on the functionality.

NOTE

The name of the module loaded by loadNativeModule is the name provided in dependencies in the oh-package.json5 file of the dependency.

loadNativeModule can be used only to load native modules in the UI main thread.

Dependencies must be configured for the API call regardless of whether the parameter is a constant string or variable expression.

System capability: SystemCapability.Utils.Lang

Parameters

Name	Type	Mandatory	Description
moduleName	string	Yes	Name of the module to load.

Return value

Type	Description
Object	Default export of the native module.

Error codes

For details about the error codes, see Universal Error Codes and Utils Error Codes.

ID	Error Message
401	The parameter check failed.
10200301	Loading native module failed.

Scenarios supported by loadNativeModule

Scenario	Example
System library module	Load @ohos. or @system..
Native module in an application	Load libNativeLibrary.so.

Example 1: Loading a System Library Module to a HAP

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

Example 2: Loading a Native Library to a HAP

The index.d.ts file of libentry.so is as follows:

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

1. When loading a local .so library, configure dependencies in the oh-package.json5 file. For details, see Fields in the Module-level oh-package.json5 File.

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

2. Configure the module-level build-profile.json5 file. For details, see Module-level build-profile.json5 File.

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

3. Use loadNativeModule to load libentry.so and call the add function.

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