OpenHarmony eTS通用日志组件，写日志快一点

Posted 2022-05-16 开源基础软件社区官方

@toc

OpenHarmony eTS通用日志组件

在开发的过程中总要通过日志输出来完成一些调试工作，所以写日志是避免不了的，日志记录的功能并不复杂，却是必要的、重复的，每个页面要引入日志工具类，还要定义一个TAG常量，在记录日志的时候将TAG变量传递给日志工具类，大概需要三步：
1.导入日志工具类---2.定义TAG常量（每个页面定义一遍）---3.编写记录日志代码行
想了一下，完全可以传递this对象到日志工具类，由工具类获取当前页面名称来完成日志的记录，无需每个页面定义TAG。

1.能做什么

1.支持按照tag和module两层，分级记录日志
2.支持自动获取页面类名称作为module，支持查看某个页面或整个项目的日志
3.配合 DevEco Studio自动提示功能，达到快速记录日志效果

2.使用步骤

1).npm安装组件
命令行进入entry目录，执行下面命令

npm install git+https://gitee.com/butingyou/ohos-clogger.git

2).页面导入CommonLog

import  CommonLog  as logger  from @ohos/ohos_clogger

3).修改CommonLog 文件中 tag名为项目名称，方便区分

按住CTRL+ 鼠标左键点击CommonLog，进入index.ets，再点一次，进入 CommonLog.ets 文件,就可以修改了，整个项目只需要修改一次。

/**
 * 日志管理类
 */
export default class CommonLog 
  private tag: string = "OhosCpt"  //修改为项目名称
  private static module: string = "Log"

4).编写日志行

logger.getInstance(this).debug(`this.notice:$this.notice`)

4.还可以更快一点
配合 IDE 的代码生成功能，一键生成日志代码行，只需要关心要输出的内容

File---Settings---Live Templates---添加3个快捷生成代码模板

可以快乐的记录日志了 O(∩_∩)O~~

日志效果

3.日志组件Gitee地址

https://gitee.com/butingyou/ohos-clogger

想了解更多关于开源的内容，请访问：

51CTO 开源基础软件社区

https://ost.51cto.com/#bkwz