代码拉取完成，页面将自动刷新
轻量、易集成、易使用，有时甚至可以不需写代码的HarmonyOS log系统，灵感来自log4j。
由于ohpm中心仓库审核需要时间，若您遇到恶性bug但中心仓库未提供更新，请先移步log4a代码仓库 检查是否存在新版本，若没有，您可以新建issue ，或向我发送邮件，我将尽快修复。
ohpm 以安装 @pie/log4a
ohpm install @pie/log4a
对于其他安装方式, 请参考 这篇文章.
使用LogManager.getLogger(context)获取当前对象的可用Logger。该方法传入this即可。
import { LogManager, Logger } from '@pie/log4a';
class LogTestClass {
private logger: Logger = LogManager.getLogger(this);
// ... Other code
}
获取logger后，即可开始打印日志：
import { LogManager, Logger } from '@pie/log4a';
class LogTestClass {
private logger: Logger = LogManager.getLogger(this);
add(a: number, b: number) {
this.logger.info('calculating {} + {}', a, b);
return a + b;
}
}
const adder = new LogTestClass;
adder.add(1, 2);
上面这段代码在执行之后，会打印出这样一条日志
[INFO ] 2024-04-19 23:32:54.746 [LogTestClass:1] calculating 1 + 2
可以看到，log4a打印出的日志中包含了以下信息：
日志来源
当logger属于class或struct时：
对于非静态logger，日志来源为class或struct的名称
对于静态logger，日志来源为Function
import { LogManager, Logger } from '@pie/log4a'; class StaticLogger { private static logger: Logger = LogManager.getLogger(this); static hello() { StaticLogger.logger.info("Hello from static logger"); } }这段代码将会打印：
[INFO ] 2024-04-19 23:32:54.746 [Function:1] Hello from static logger
对于一些匿名输出，可以通过添加标记的方式便于在日志中进行搜索，例如：
LogManager.anonymous().withMarker(MarkerManager.getMarker("我是一个Marker")).info('这是带Marker的日志');
log4a设计了追踪器，它可以帮你跟踪函数运行参数、函数运行结果、模板字符串的构造。
可用的追踪器：
@TraceEntry
@TraceEntry：用于跟踪函数运行参数，示例如下：import { TraceEntry } from '@pie/log4a';
class TestClass {
@TraceEntry
add(a: number, b: number): number {
return a + b;
}
}
const t = new TestClass;
t.add(1, 2);
虽然没有写任何的log代码，但这段代码在运行后仍然会出现如下log：
[TRACE] 2024-04-20 00:19:43.24 [TestClass:1] Method: [add] called with arguments [1,2]
这意味着，使用@TraceEntry装饰的函数将会被追踪，每当它被调用时，log4a都会打印一条日志，该日志包含该函数名称及本次调用传入的参数。
@TraceExit
@TraceExit：用于跟踪函数运行结果，示例如下：import { TraceExit } from '@pie/log4a';
class TestClass {
@TraceExit
add(a: number, b: number): number {
return a + b;
}
}
const t = new TestClass;
t.add(1, 2);
虽然没有写任何的log代码，但这段代码在运行后仍然会出现如下log：
[TRACE] 2024-04-20 00:19:43.24 [TestClass:1] Method: [add] exited with result: 3
这意味着，使用@TraceExit装饰的函数将会被追踪，每当它被调用时，log4a都会打印一条日志，该日志包含该函数名称及本次调用返回的结果。
TracedStr
TracedStr：用于跟踪字符串模板的构建过程，示例如下：import { TracedStr } from '@pie/log4a';
class TestClass {
param1: string = 'param1';
param2: string = 'param2';
str: string = TracedStr`build with ${this.param1} and ${this.param2}`;
}
const t = new TestClass;
虽然没有写任何的log代码，但这段代码在运行后仍然会出现如下log：
[INFO ] 2024-04-20 00:27:51.989 [Anonymous:1] built with format: ["build with "," and ",""] and args: ["param1","param2"] (Anonymous)
注意，TracedStr是标签而不是装饰器，因此不需要@前导。
MarkedTracedStr
MarkedTracedStr：为了方便使用者追踪特定的模板字符串构建，使用此标签并传入一个字符串作为标记import { MarkedTracedStr } from '@pie/log4a';
class TestClass {
param1: string = 'param1';
param2: string = 'param2';
str: string = MarkedTracedStr("StrBuilder")`build with ${this.param1} and ${this.param2}`;
}
const t = new TestClass;
虽然没有写任何的log代码，但这段代码在运行后仍然会出现如下log：
[INFO ] 2024-04-20 00:33:31.793 [Anonymous:2] built with format: ["build with "," and ",""] and args: ["param1","param2"] (StrBuilder)
注意，MarkedTracedStr是函数而不是标签，需要传入一个参数。
Appender为Logger提供日志输出能力，分为两种类型：FileAppender、ConsoleAppender。
新建Logger时，将自动提供一个ConsoleAppender。Appender无法直接被创建，只能通过调用Logger实例下的addFileAppender
或addConsoleAppender来创建并绑定到该Logger.
ConsoleAppender提供向控制台输出日志的能力，每个Logger在创建时，就会带有一个ConsoleAppender，无需手动添加。
一个Logger最多只能拥有一个ConsoleAppender，当您向Logger添加ConsoleAppender时，若已存在，则该appender不会被添加至Logger。
// this.logger是一个Logger的实例
this.logger.addConsoleAppender(Level.INFO);
this.logger.removeTypedAppender(AppenderTypeEnum.CONSOLE);
this.logger.getHistoryOfAppender(AppenderTypeEnum.CONSOLE);
FileAppender提供向文件输出日志的能力。
一个Logger可以有多个FileAppender，如果有多个FileAppender指向同一个文件，则这些FileAppender将会共用一个文件对象。
this.logger.addFileAppender('/file/log.log', 'mainAppender', Level.INFO);
this.logger.removeNamedAppender('mainAppender');
const history = this.logger.getHistoryOfAppender('mainAppender');
const history = this.logger.getAllHistoryOfAppender('mainAppender');
this.logger.addFileAppender('/file/log.log', 'mainAppender', Level.INFO, {
useWorker: true
});
this.logger.addFileAppender('/file/log.log', 'mainAppender', Level.INFO, {
maxCacheCount: 10
});
this.logger.addFileAppender('/file/log.log', 'mainAppender', Level.INFO, {
maxFileSize: 10 // 最大10KB
});
为了帮助使用者更容易地从日志中提取有用的信息，log4a引入了日志级别的概念。 Logger和Appender都可以附带日志级别，log4a对Logger的日志等级的处理优先于对appender的日志等级的处理，举例如下：
this.logger.setLevel(Level.ERROR);
this.logger.addFileAppender("/path/to/log.log", "mainFileAppender", Level.INFO);
在这个例子中，由于添加的FileAppender日志级别为INFO，高于Logger的日志级别ERROR，此时WARN级别的日志无法送达Appender。
(日志等级排序为：OFF<FATAL<ERROR<WARN<INFO<DEBUG<TRACE<ALL)
在退出应用时，使用者应当在Ability的onDestroy生命周期中调用LogManager.terminate()来销毁Logger及Appender实例。
在下述版本验证通过：DevEco Studio NEXT Developer Preview 2 (4.1.3.700), SDK: API11 (4.1.0(11))
本库理论上支持所有API版本
本项目使用Apache License 2.0。
此处可能存在不合适展示的内容，页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容，可点击提交进行申诉，我们将尽快为您处理。