纯血鸿蒙APP实战开发——监听HiLog日志实现测试用例验证

程序猿会指北2024-05-03 14:48

介绍

日常中在进行测试用例验证时，会出现部分场景无法通过判断UI的变化来确认用例是否正常运行，我们可以通过监听日志的方式来巧妙的实现这种场景。本示例通过监听hilog日志的回调，判断指定日志是否打印，来确定测试用例的执行结果是成功还是失败。由于ArkTS没有注册日志回调的接口，示例通过Native来注册日志回调，并在Native的自定义日志处理函数中过滤用户传入的日志内容后回调ArkTS端的回调函数。

效果图预览

验证场景

使用说明：

  1. 在product工程的ohosTest中启动Ability.test.ets来验证开启日志回调、关闭日志回调两个测试用例是否成功。

实现思路

  1. 在Native中实现注册日志回调函数。
cpp 复制代码 
   static napi_value SetLogCallback(napi_env env, napi_callback_info info) {
       size_t argc = 2;
       napi_value args[2] = {nullptr};
       napi_get_cb_info(env, info, &argc, args, nullptr, nullptr);
       // 解析要过滤的日志
       size_t logSize;
       napi_get_value_string_utf8(env, args[0], logToFilter, MAX_LOG_LEN, &logSize);
   
       // 解析ArkTS端的回调函数
       napi_valuetype valueType = napi_undefined;
       napi_typeof(env, args[1], &valueType);
       if(valueType != napi_function) {
           OH_LOG_Print(LOG_APP, LOG_ERROR, GLOBAL_RESMGR, TAG, "SetLogCallback fail，param[2] is not a function！");
           return nullptr;
       }
       // 创建ArkTS端回调函数的引用
       napi_create_reference(env, args[1], 1, &callbackRef);
       g_env = env;
       // 注册日志回调接口
       OH_LOG_SetCallback(HiLogCallbackFilter);
       OH_LOG_Print(LOG_APP, LOG_INFO, GLOBAL_RESMGR, TAG, "TestLogCallback SetCallback end");
       return nullptr;
   }

  1. 在Native中实现自定义日志处理函数。

    cpp 复制代码 
    static void HiLogCallbackFilter(const LogType type, const LogLevel level, const unsigned int domain, const char *tag,
                 const char *msg) {
 std::string strMsg(msg, strlen(msg) + 1);    
 // TODO: 知识点： 过滤要查找的日志
 size_t foundIndex = strMsg.find(logToFilter);
 if(foundIndex != -1) {
     // ArkTS回调函数
     napi_value callback = nullptr;
     napi_get_reference_value(g_env, callbackRef, &callback);
     // 返回日志内容
     napi_value hilogArg;
     napi_create_string_utf8(g_env, msg, NAPI_AUTO_LENGTH, &hilogArg);
     napi_value ret;
     // TODO: 知识点： 调用ArkTS端传入的回调函数
     napi_call_function(g_env, nullptr, callback, 1, &hilogArg, &ret);
 }
 return;
}

  2. 在Native中实现关闭日志回调功能。

    cpp 复制代码 
    static napi_value CancelLogCallback(napi_env env, napi_callback_info info) {
    // 关闭日志回调
    OH_LOG_SetCallback(nullptr);
    OH_LOG_Print(LOG_APP, LOG_INFO, GLOBAL_RESMGR, TAG, "TestLogCallback CancelLogCallBack end");
    // 删除回调函数引用
    napi_delete_reference(env, callbackRef);
    return nullptr;
}

  3. 将以上Native的日志回调功能封装成ts接口HiLogMonitorManagement。

typescript 复制代码 
   import testNapi from 'liblogcallback.so';   
   export class HiLogMonitorManagement {

     // TODO: 知识点： 注册日志回调函数
     registerCallback(strLog: string, callBack : Function) : void {
       testNapi.setLogCallback(strLog, callBack);
     }
   
     // TODO: 知识点： 关闭日志回调
     cancelCallback() : void {
       testNapi.cancelLogCallback();
     }
   }
  1. 在product工程中实现测试用例编写。
typescript 复制代码 
 //  ..\product\entry\src\ohosTest\ets\test\Ability.test.ets
  /**
   * 打开应用，应用启动后注册日志回调
   */
  it(BUNDLE + '_startAbility', 0, async (done: Function) => {
    logger.info(TAG, BUNDLE + '_startAbility start')
    let want: Want = {
      bundleName: 'com.north.commonappdevelopment',
      abilityName: 'EntryAbility'
    };
    delegator.startAbility(want, (err) => {
      logger.info(TAG, 'StartAbility get err ' + JSON.stringify(err));
      expect(err).assertNull();
    })
    logger.info(TAG, BUNDLE + '_startAbility end');
    let driver: Driver = Driver.create();
    await driver.delayMs(3000);
    done();
  })
 
  /**
   * 注册日志回调，验证保存Rawfile图片到沙箱功能是否运行
   */
  it('CommonAppDevelopment_nativesavepictosandbox_001', 1, async (done: Function) => {
    logger.info(TAG, `${BUNDLE}_nativesavepictosandbox_001 begin`);
    let driver: Driver = Driver.create();
    await driver.delayMs(1000);
    // 进入tab的native页签
    let nativeBtn: Component = await driver.findComponent(ON.text('Native'));
    await driver.delayMs(500);
    await nativeBtn.click();
    await driver.delayMs(500);

    // 点击进入native保存图片到沙箱场景首页
    await driver.swipe(0, 800, 0, 100, 600);
    let sandboxBtn: Component = await driver.findComponent(ON.text('native保存图片到沙箱'));
    await driver.delayMs(500);
    await sandboxBtn.click();
    await driver.delayMs(500);

    // TODO: 知识点： 注册日志回调, 侦听保存Rawfile图片到沙箱功能
    const logMonitor : string = "saveImageOfRawfile Be2gin";  // 要监听的日志内容
    let isMonitorLogPrint : Boolean = false;                 // 监听的日志内容是否打印
    let logCallback : string = "";                           // 回调返回的日志内容
    const hiLogMonitor: HiLogMonitorManagement = new HiLogMonitorManagement();
    hiLogMonitor.registerCallback(logMonitor, ((strLog: string) => {
      // 判断返回的日志内容是否包含侦听的日志内容
      logCallback = strLog;
      if (logCallback.indexOf(logMonitor) !== -1) {
        isMonitorLogPrint = true;
      } else {
        isMonitorLogPrint = false;
      }
    }));
    isMonitorLogPrint = false;
    // 点击保存Rawfile图片到沙箱
    let rawFileBtn: Component = await driver.findComponent(ON.text('保存Rawfile图片'));
    logger.info(TAG, 'TestLogCallback registerCallback call begin, isMonitorLogPrint:' + isMonitorLogPrint.toString());
    await rawFileBtn.click();
    await driver.delayMs(100);
    // 验证注册日志回调后，isMonitorLogPrint 为 true
    expect(isMonitorLogPrint).assertEqual(true);
    // 验证完后关闭侦听
    hiLogMonitor.cancelCallback();
    logger.info(TAG, 'TestLogCallback registerCallback call end, isMonitorLogPrint:' + isMonitorLogPrint.toString() + ', log: ' + logCallback);

    // 退出到首页面
    await driver.delayMs(500);
    await driver.pressBack();
    logger.info(TAG, `${BUNDLE}_nativesavepictosandbox_001 end`);
    done();
  })

高性能知识点

不涉及

工程结构&模块类型

   hilogmonitormanagement                // har类型
   |---src\main\ets\model\
   |   |---logCallBack.ets               // ArkTS层- ts接口
   |---src\main\cpp\
   |   |---logcallback.cpp               // native层-日志回调业务逻辑   
   
   ..\product\entry\src\ohosTest         // 测试用例工程
   |---ets\test\
   |   |---Ability.test.ets              // 测试用例

模块依赖

不涉及

参考资料

日志回调注册函数

鸿蒙全栈开发全新学习指南

也为了积极培养鸿蒙生态人才，让大家都能学习到鸿蒙开发最新的技术，针对一些在职人员、0基础小白、应届生/计算机专业、鸿蒙爱好者等人群，整理了一套纯血版鸿蒙（HarmonyOS Next）全栈开发技术的学习路线【包含了大APP实战项目开发】。

本路线共分为四个阶段：

第一阶段：鸿蒙初中级开发必备技能

第二阶段：鸿蒙南北双向高工技能基础：gitee.com/MNxiaona/733GH

第三阶段：应用开发中高级就业技术

第四阶段：全网首发-工业级南向设备开发就业技术：https://gitee.com/MNxiaona/733GH

《鸿蒙 (Harmony OS)开发学习手册》（共计892页）

如何快速入门？

1.基本概念

2.构建第一个ArkTS应用

3.......

开发基础知识:gitee.com/MNxiaona/733GH

1.应用基础知识

2.配置文件

3.应用数据管理

4.应用安全管理

5.应用隐私保护

6.三方应用调用管控机制

7.资源分类与访问

8.学习ArkTS语言

9.......

基于ArkTS 开发

1.Ability开发

2.UI开发

3.公共事件与通知

4.窗口管理

5.媒体

6.安全

7.网络与链接

8.电话服务

9.数据管理

10.后台任务(Background Task)管理

11.设备管理

12.设备使用信息统计

13.DFX

14.国际化开发

15.折叠屏系列

16.......

鸿蒙开发面试真题（含参考答案）:gitee.com/MNxiaona/733GH

鸿蒙入门教学视频：

美团APP实战开发教学：gitee.com/MNxiaona/733GH

写在最后

  • 如果你觉得这篇内容对你还蛮有帮助，我想邀请你帮我三个小忙：
  • 点赞，转发，有你们的 『点赞和评论』，才是我创造的动力。
  • 关注小编，同时可以期待后续文章ing🚀，不定期分享原创知识。
  • 想要获取更多完整鸿蒙最新学习资源，请移步前往小编：gitee.com/MNxiaona/733GH
相关推荐
yilylong2 小时前
鸿蒙（Harmony）实现滑块验证码
华为·harmonyos·鸿蒙
baby_hua2 小时前
HarmonyOS第一课——DevEco Studio的使用
华为·harmonyos
HarmonyOS_SDK3 小时前
融合虚拟与现实，AR Engine为用户提供沉浸式交互体验
harmonyos
- 羊羊不超越 -4 小时前
App渠道来源追踪方案全面分析（iOS/Android/鸿蒙）
android·ios·harmonyos
Industio_触觉智能5 小时前
OpenHarmony4.1蓝牙芯片如何适配？触觉智能RK3568主板SBC3568演示
openharmony·rk3568·开源鸿蒙·鸿蒙开发板·触觉智能
长弓三石6 小时前
鸿蒙网络编程系列44-仓颉版HttpRequest上传文件示例
前端·网络·华为·harmonyos·鸿蒙
SameX8 小时前
鸿蒙 Next 电商应用安全支付与密码保护实践
前端·harmonyos
SuperHeroWu78 小时前
【HarmonyOS】键盘遮挡输入框UI布局处理
华为·harmonyos·压缩·keyboard·键盘遮挡·抬起
努力变厉害的小超超13 小时前
ArkTS中的组件基础、状态管理、样式处理、class语法以及界面渲染
笔记·鸿蒙
sanzk13 小时前
华为鸿蒙应用开发
华为·harmonyos
热门推荐
01【HarmonyOS】HUAWEI DevEco Studio 下载地址汇总02(欧拉)openEuler系统添加网卡文件配置流程、(欧拉)openEuler系统手动配置ipv6地址流程、(欧拉)openEuler系统网络管理说明03组基轨迹建模 GBTM的介绍与实现（Stata 或 R）04【AIGC】重塑未来的科技巨轮05全面解析：构建基于深度学习的安全帽检测系统（UI界面+YOLO代码+数据集）06【经验分享】Ubuntu22.04安装微信(linux官方版)07基于YOLOv10深度学习的CT扫描图像肾结石智能检测系统【python源码+Pyqt5界面+数据集+训练代码】深度学习实战、目标检测08Ubuntu 20.04使用Livox mid 360 测试 FAST_LIO09RAG 实践- Ollama+RagFlow 部署本地知识库10【TC3xx芯片】TC3xx芯片电源管理系统PMS详解