HarmonyOS NEXT应用开发之预加载so并读取RawFile文件

腾讯T10级高工技术，安卓全套VIP课程全网免费送：https://docs.qq.com/doc/DSG1vYnRxSElnU3hE
学习鸿蒙开发势在必行。鸿蒙开发可参考学习文档：https://qr21.cn/FV7h05

介绍

本示例主要介绍在TaskPool子线程中使用 dlopen 预加载 so 库并使用句柄调用库函数的方法，以及在Native中使用 pread 系统函数读取Rawfile文件的部分文本内容，并添加 HiLog 日志。

效果图预览

使用说明

1. rawfile路径下存在一个有内容的文本文件rawfile.txt。
2. 输入开始读取位置、需要读取的长度，点击“开始读取”，即可通过调用Native侧暴露的getRawFileContent接口把读取到的内容显示在界面上。

具体代码可参考MainPage.ets。

实现思路

在TaskPool子线程中使用dlopen预加载so库和使用句柄调用so库函数的方式

1. 将需要加载的.so文件放到工程中，在CMakeLists中使用target_link_directories命令将包含这些库文件的目录添加到预加载库的链接目录。

target_link_directories(preloadso PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/../../../libs/${OHOS_ARCH}/
1

2. 使用target_link_libraries命令将需要预加载的so库链接到项目中。

target_link_libraries(preloadso PUBLIC libhilog_ndk.z.so libace_napi.z.so global_handlers libnativerawfile.so)
1

3. 定义一个全局对象global_handlers用于存放加载so库所得句柄，其他需要使用global_handlers的cpp文件需要引入定义全局对象的头文件。

std::unordered_map global_handlers;
1

4. 在 Native 层的 Preload 接口中，遍历传入的 .so 路径数组，使用 dlopen 函数加载库，并将句柄保存到 global_handlers 中。

// 获取传入的so库路径数组的长度
uint32_t arrayLength;
napi_get_array_length(env, args[0], &arrayLength);
for (uint32_t i = 0; i < arrayLength; i++) {
    napi_get_element(env, args[0], i, &pathString); // 获取数组的第 i 个元素
    napi_status status = napi_get_value_string_utf8(env, pathString, path, sizeof(path), &pathLength);
    if (status != napi_ok) {
        // 处理获取路径失败的情况
        continue;
    }
    // TODO：知识点：使用dlopen动态加载so库，返回so库的句柄
    void *handler = dlopen(path, RTLD_LAZY);
    if (handler == nullptr) {
        // TODO：知识点：dlerror抛出加载库失败的错误
        dlerror();
        continue; // 加载下一个
    }
    // 将句柄保存到全局对象global_handlers中
    global_handlers[std::string(path)] = handler;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

5. 暴露Preload接口给ArkTS层使用，使其能够通过preload调用Native层的Preload接口。

napi_property_descriptor desc[] = {{"preload", nullptr, Preload, nullptr, nullptr, nullptr, napi_default, nullptr}};
1

6. ArkTS层使用TaskPool创建子线程，通过preload接口调用Native侧的Preload接口，实现在TaskPool子线程中加载.so库，导出preloadSOByTaskPool函数。

@Concurrent
function preloadSO(): string[] {
  return napi.preload(Constants.LIBRARY_PATH_ARRAY);
}
export function preloadSOByTaskPool(): void {
  // TODO: 知识点：使用new taskpool.Task()创建任务项，传入任务执行函数和所需参数
  let task: taskpool.Task = new taskpool.Task(preloadSO);
  try {
    // TODO：知识点：使用taskpool.execute将待执行的函数放入TaskPool内部任务队列等待执行
    taskpool.execute(task, taskpool.Priority.HIGH).then((res: string[]) => {
    // so库预加载完成的处理
    logger.info(TAG, '%{public}s', 'PreloadSOByTaskPool：' + JSON.stringify(res));
    })
  } catch (err) {
     logger.error(TAG, "PreloadSOByTaskPool: execute failed, " + (err as BusinessError).toString());
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

7. 在Ability的onCreate生命周期函数中，调用preloadSOByTaskPool开启子线程，完成so库的预加载。

    onCreate(want: Want, launchParam: AbilityConstant.LaunchParam): void {
        // 在TaskPool子线程预加载so
        preloadSOByTaskPool();
    }
1
2
3
4

8. 后续可以通过句柄使用so库中的函数。

• 在Native层引入头文件global_handlers.h。

    #include "global\_handlers.h"
1

• 编写napi接口，用于实现ArkTS层和so库之间的交互

static napi_value GetTotalRawFileContent(napi_env env, napi_callback_info info){}
static napi_value GetRawFileContent(napi_env env, napi_callback_info info) {}
1
2

• 在napi接口中从全局对象global_handlers中取出对应so库的句柄。

// 从全局对象中获取指定so库的句柄
void *handler = global_handlers["libnativerawfile.so"];
1
2

• 句柄不为空时，使用dlsym查找和调用so库中的符号。

// TODO：知识点：使用dlsym查找和调用so库中的符号
GetTotalRawFileContentWrapperFunc getTotalRawFileContentWrapper =
    reinterpret_cast(dlsym(handler, "GetTotalRawFileContentWrapper"));
if (getTotalRawFileContentWrapper) {
    // 调用 GetRawFileContentWrapper 函数
    napi_value result = getTotalRawFileContentWrapper(env, info);
    OH_LOG_Print(LOG_APP, LOG_INFO, GLOBAL_RESMGR, TAG, " GetRawFileContentWrapper finish");
    return result;
} else {
    // 处理无法获取函数指针的情况
    OH_LOG_Print(LOG_APP, LOG_ERROR, GLOBAL_RESMGR, TAG, " GetTotalRawFileContentWrapper fn failed");
    return nullptr;
}
1
2
3
4
5
6
7
8
9
10
11
12
13

• 在ArkTS层调用编写的napi接口，就可以使用so库导出的函数

this.rawfileContent = nativeRawfileApi.getRawFileContent(getContext().resourceManager, 'rawfile.txt', 2, 5);
1

Native中加入hilog日志的实现主要步骤如下

1. 在CMakeLists中通过target_link_libraries导入日志模块libhilog_ndk.z.so。

target_link_libraries(nativerawfile PUBLIC libace_napi.z.so libhilog_ndk.z.so librawfile.z.so)
1

2. 在需要打印hilog日志的cpp文件开头引入头文件 #include “hilog/log.h”。

#include "hilog/log.h"
1

3. 在需要打印日志的地方通过OH_LOG_Print打印日志。日志级别有LOG_INFO、LOG_ERROR等

OH_LOG_Print(LOG_APP, LOG_INFO, GLOBAL_RESMGR, TAG, "GetRawFileContent Begin");
1

Native读取Rawfile中文本文件部分内容主要步骤如下：

1. 在前端通过调用Native中的getRawFileContent接口读取文件部分内容。传入的参数为文件名、开始读取位置、读取文件长度。

Button($r('app.string.ReadButton'))
  .onClick(()=> {
     this.rawfileContent = nativeRawfileApi.getRawFileContent(getContext().resourceManager, 'rawfile.txt', this.ReadStartPos, this.readLength);
}).margin($r('app.string.rawfile_margin'))
1
2
3
4

2. 在Native侧native_rawfile.cpp的getRawFileContent接口中通过Rawfile的API接口以及pread函数读取Rawfile文件部分内容。

 // TODO 知识点：通过pread读取文件部分内容。
 if ((ret = pread(descriptor.fd, buf, lenContent,  descriptor.start + startPos)) == -1) {
     OH_LOG_Print(LOG_APP, LOG_ERROR, GLOBAL_RESMGR, TAG, "GetRawFileContent pread error!");
 } else {
     buf[lenContent] = '\0';
     OH_LOG_Print(LOG_APP, LOG_INFO, GLOBAL_RESMGR, TAG, "GetRawFileContent: %{public}ld: %{public}ld: %{public}s\n",
                  descriptor.start, len, buf);
 }
1
2
3
4
5
6
7
8

高性能知识点

不涉及

工程结构&模块类型

nativerawfile                               // har类型
|---libs\
|   |---arm64-v8a\libnativeRawFile.so       // arm64-v8a类型so库
|   |---armeabi-v7a\libnativeRawFile.so     // armeabi-v7a类型so库
|   |---x86_64\libnativeRawFile.so          // x86_64类型so库
|---src\main\ets\components\mainpage\
|   |---MainPage.ets                        // 视图层-Rawfile场景主页面
|---src\main\ets\utils\
|   |---Constants.ets                       // 常量数据
|   |---TaskPool.ets                        // TaskPool子线程加载so库
|---src\main\cpp\
|   |---include\global_handlers.h           // native层-全局句柄头文件
|   |---global_handlers.cpp                 // native层-定义全局句柄对象
|   |---preloadso.cpp                       // native层-加载libnativeRawFile.so业务逻辑
|   |---nativeRawFile.cpp                   // native层-读取Rawfile文件部分内容业务逻辑，libnativeRawFile.so源代码
|   |---native_rawfile_api.cpp              // native层-libnativeRawFile.so和ArkTS中间层接口
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

模块依赖

1. 本实例依赖common模块来实现公共组件FunctionDescription。

参考资料

公共组件FunctionDescription

腾讯T10级高工技术，安卓全套VIP课程全网免费送：https://docs.qq.com/doc/DSG1vYnRxSElnU3hE
学习鸿蒙开发势在必行。鸿蒙开发可参考学习文档：https://qr21.cn/FV7h05

为了能让大家更好的学习鸿蒙（HarmonyOS NEXT）开发技术，这边特意整理了《鸿蒙开发学习手册》（共计890页），希望对大家有所帮助：https://qr21.cn/FV7h05

《鸿蒙开发学习手册》：https://qr21.cn/FV7h05

入门必看：https://qr21.cn/FV7h05

1. 应用开发导读(ArkTS)
2. ……

HarmonyOS 概念：https://qr21.cn/FV7h05

1. 系统定义
2. 技术架构
3. 技术特性
4. 系统安全

如何快速入门：https://qr21.cn/FV7h05

1. 基本概念
2. 构建第一个ArkTS应用
3. 构建第一个JS应用
4. ……

开发基础知识：https://qr21.cn/FV7h05

1. 应用基础知识
2. 配置文件
3. 应用数据管理
4. 应用安全管理
5. 应用隐私保护
6. 三方应用调用管控机制
7. 资源分类与访问
8. 学习ArkTS语言
9. ……

基于ArkTS 开发：https://qr21.cn/FV7h05

1. Ability开发
2. UI开发
3. 公共事件与通知
4. 窗口管理
5. 媒体
6. 安全
7. 网络与链接
8. 电话服务
9. 数据管理
10. 后台任务(Background Task)管理
11. 设备管理
12. 设备使用信息统计
13. DFX
14. 国际化开发
15. 折叠屏系列
16. ……

鸿蒙开发面试真题（含参考答案）：https://qr21.cn/FV7h05