日志打印的注意事项
在编写程序后,我们可以随手在需要的地方加入打印信息,同时需要考虑如下事项:
- 日志输出是有代价的,特别是在嵌入式系统,或者对执行时序要求较高的应用场景。因此:
a) 只有在需要的地方加入,不能滥用。
b) 一定要有一个全局的开关,在不需要或者产品发布的时候,关闭输出,或者降低日志输出的频率。
- 日志输出需要有优先级控制,例如:发生错误时的日志优先级最高,一般都要输出;一些重要的提示,优先级中等,可能会在debug版的软件中打开;一些不重要的提示,可能只会在需要的时候(例如跟踪bug)打开。
- 不要直接使用printf(或者printk)。日志输出的目标是多样的,例如通过printf输出到屏幕、通过串口输出到串口调试助手、通过文件操作写入到文件等等。
要通过重定义的方式,将所有的日志输出指令定义到合适的输出路径,当需要修 改输出路径的时候,只要修改重定义的部分即可。否则需要在整个代码中修改, 就麻烦了。
- 最好为每个软件模块提供单独的日志输出开关,以增加调试的灵活性。
- 很多时候,日志输出语句,可以部分代替代码注释的功能。
日志打印的实现
结合上面的注意事项,我们可以按照如下步骤实现一个小型的日志输出系统。
- 新建debug.h(如果只是在PC上使用printf,则只需要一个头文件即可。如果有需要文件或者串口操作,可以在这个基础上增加debug.c,这里暂时不再描述)
- 定义一个宏开关,用于控制日志输出的开关。
- 定义ERR、INFO、DEBUG三个日志级别。
- 定义一个宏,用于定义日志输出级别。
需要在每一个需要日志输出的C文件中调用,如下:
DEBUG_SET_LEVEL(DEBUG_LEVEL_ERR);
- 定义ASSERT、ERR、INFO、DEBUG等宏 。
…
- 在需要日志输出的C文件中,包含debug.h,并定义所需的日志级别。就可以在需要的时候输出日志信息了。
debug_test.c
-----------------------------------------------------
DEBUG_SET_LEVEL(DEBUG_LEVEL_ERR);
int main(void) {
ERR("This is a error message\n");
INFO("This is a info message\n");
DEBUG("This is a debug message\n");
ASSERT();
return 0;
}
Step8. 可以根据需要,修改容许输出的日志级别。