文章详情

短信预约-IT技能 免费直播动态提醒

请输入下面的图形验证码

提交验证

短信预约提醒成功

如何用printf写一个自己的日志打印系统?

2024-12-02 05:22

关注

日志打印的注意事项

在编写程序后,我们可以随手在需要的地方加入打印信息,同时需要考虑如下事项:

  1. 日志输出是有代价的,特别是在嵌入式系统,或者对执行时序要求较高的应用场景。因此:

     a) 只有在需要的地方加入,不能滥用。

     b) 一定要有一个全局的开关,在不需要或者产品发布的时候,关闭输出,或者降低日志输出的频率。

  1. 日志输出需要有优先级控制,例如:发生错误时的日志优先级最高,一般都要输出;一些重要的提示,优先级中等,可能会在debug版的软件中打开;一些不重要的提示,可能只会在需要的时候(例如跟踪bug)打开。
  2. 不要直接使用printf(或者printk)。日志输出的目标是多样的,例如通过printf输出到屏幕、通过串口输出到串口调试助手、通过文件操作写入到文件等等。

    要通过重定义的方式,将所有的日志输出指令定义到合适的输出路径,当需要修        改输出路径的时候,只要修改重定义的部分即可。否则需要在整个代码中修改,        就麻烦了。

  1. 最好为每个软件模块提供单独的日志输出开关,以增加调试的灵活性。
  2. 很多时候,日志输出语句,可以部分代替代码注释的功能。

日志打印的实现

结合上面的注意事项,我们可以按照如下步骤实现一个小型的日志输出系统。

  1. 新建debug.h(如果只是在PC上使用printf,则只需要一个头文件即可。如果有需要文件或者串口操作,可以在这个基础上增加debug.c,这里暂时不再描述)
  2. 定义一个宏开关,用于控制日志输出的开关。

#define CONFIG_ENABLE_DEBUG
  1. 定义ERR、INFO、DEBUG三个日志级别。

#include
#define PRINT printf
  1. 定义一个宏,用于定义日志输出级别。

#define DEBUG_SET_LEVEL(x) static int debug = x

需要在每一个需要日志输出的C文件中调用,如下:


DEBUG_SET_LEVEL(DEBUG_LEVEL_ERR);
  1. 定义ASSERT、ERR、INFO、DEBUG等宏 。
#define ASSERT()                                        \
do { \
PRINT("ASSERT: %s %s %d", \
__FILE__, __FUNCTION__, __LINE__); \
while (1); \
} while (0)
#define ERR(...) \
do { \
if (debug >= DEBUG_LEVEL_ERR) { \
PRINT(__VA_ARGS__); \
} \
} while (0)

  1. 在需要日志输出的C文件中,包含debug.h,并定义所需的日志级别。就可以在需要的时候输出日志信息了。
debug_test.c
-----------------------------------------------------
#include "debug.h"

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. 可以根据需要,修改容许输出的日志级别。

来源:C语言与C++编程内容投诉

免责声明:

① 本站未注明“稿件来源”的信息均来自网络整理。其文字、图片和音视频稿件的所属权归原作者所有。本站收集整理出于非商业性的教育和科研之目的,并不意味着本站赞同其观点或证实其内容的真实性。仅作为临时的测试数据,供内部测试之用。本站并未授权任何人以任何方式主动获取本站任何信息。

② 本站未注明“稿件来源”的临时测试数据将在测试完成后最终做删除处理。有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341

软考中级精品资料免费领

  • 历年真题答案解析
  • 备考技巧名师总结
  • 高频考点精准押题
  • 2024年上半年信息系统项目管理师第二批次真题及答案解析(完整版)

    难度     813人已做
    查看
  • 【考后总结】2024年5月26日信息系统项目管理师第2批次考情分析

    难度     354人已做
    查看
  • 【考后总结】2024年5月25日信息系统项目管理师第1批次考情分析

    难度     318人已做
    查看
  • 2024年上半年软考高项第一、二批次真题考点汇总(完整版)

    难度     435人已做
    查看
  • 2024年上半年系统架构设计师考试综合知识真题

    难度     224人已做
    查看

相关文章

发现更多好内容

猜你喜欢

AI推送时光机
位置:首页-资讯-后端开发
咦!没有更多了?去看看其它编程学习网 内容吧
首页课程
资料下载
问答资讯