日志打印之输出日志法
如果你的嵌入式项目比较大,调试建议采用输出日志法!
在我们嵌入式开发中,调试代码的方法有很多。比如使用调试器在线调试、借助一些测量仪器、输出调试日志等方式。
没有哪种方法是最好的调试方法,实际开发中需要根据实际情况借助不同的方法进行调试。但是,在一些稍微大点的项目中,输出调试日志却是比较好的调试方法。
输出日志可以比较随意,想输出什么就输出什么,但是也得注意两个点:
一是输出的日志尽量整洁明了,因为如果日志稍微多一点,看起来就会很乱,很扰心;
二是方便打开/关闭日志相关代码,程序调试阶段打开,方便定位问题,程序发布阶段关闭,可节省不必要地资源开销。
分模块打印
给各个模块加上宏打印开关。在调试时可以通过宏开关先屏蔽掉没有问题的模块的日志信息,减少日志地输出,方便专注于有问题的模块分析。
/*
demo: 分模块打印日志
*/
#include <stdio.h>
#include "module1.h"
#include "module2.h"
int main(void)
{
module1_print();
module2_print();
return 0;
}
//mylog.h
#ifndef __MYLOG_H__
#define __MYLOG_H__
#ifdef __cplusplus
extern "C" {
#endif
#include <stdio.h>
/* 各模块日志开关 */
#define MODULE1_LOG_SWITCH 1
#define MODULE2_LOG_SWITCH 1
/* 日志统一输出的格式 */
#define DBG_PRINTF(fmt, args...) \
do\
{\
printf("<<[%s\t%s]\tFile:%s\t Line:%d \tFunction:%s>> ", __DATE__,__TIME__,__FILE__, __LINE__, __FUNCTION__);\
printf(fmt, ##args);\
}while(0)
#ifdef __cplusplus
}
#endif
#endif /* __MYLOG_H__ */
//model1.h
#ifndef __MODEL1_H__
#define __MODEL1_H__
#ifdef __cplusplus
extern "C" {
#endif
#include "mylog.h"
void module1_print(void);
#ifdef __cplusplus
}
#endif
#endif /* __MODEL1_H__ */
//model1.c
#include "module1.h"
#if MODULE1_LOG_SWITCH
#define LOG_MODULE1(fmt, args...) DBG_PRINTF(fmt, ##args)
#else
#define LOG_MODULE1(fmt, args...)
#endif
void module1_print(void)
{
LOG_MODULE1("hello module1\n");
}
//model2.h
#ifndef __MODEL2_H__
#define __MODEL2_H__
#ifdef __cplusplus
extern "C" {
#endif
#include "mylog.h"
void module2_print(void);
#ifdef __cplusplus
}
#endif
#endif /* __MODEL2_H__ */
//model2.c
#include "module2.h"
#if MODULE2_LOG_SWITCH
#define LOG_MODULE2(fmt, args...) DBG_PRINTF(fmt, ##args)
#else
#define LOG_MODULE2(fmt, args...)
#endif
void module2_print(void)
{
LOG_MODULE2("hello module2\n");
}
结果:
huislee@huislee-virtual-machine:~/workspace/EasyLogger/test/module$ gcc *.c -o a
huislee@huislee-virtual-machine:~/workspace/EasyLogger/test/module$ ./a
<<[Nov 28 2020 08:51:22] File:module1.c Line:11 Function:module1_print>> hello module1
<<[Nov 28 2020 08:51:22] File:module2.c Line:11 Function:module2_print>> hello module2
通过模块日志开关可以打开/关闭各模块日志打印接口。这里的demo只拿两个模块作为例子,可模仿这两个模块拓展其它模块。
分级打印
分级打印是日志库里常用的方式
//main.c
/*
demo:分级打印日志
*/
#include "mylog.h"
int main(void)
{
LOG_A("Hello world");
LOG_E("Hello world");
LOG_W("Hello world");
LOG_I("Hello world");
LOG_D("Hello world");
LOG_V("Hello world");
return 0;
}
//mylog.h
#ifndef __MYLOG_H__
#define __MYLOG_H__
#ifdef __cplusplus
extern "C" {
#endif
#include <stdio.h>
/* 日志级别 */
#define ELOG_LVL_ASSERT 0
#define ELOG_LVL_ERROR 1
#define ELOG_LVL_WARN 2
#define ELOG_LVL_INFO 3
#define ELOG_LVL_DEBUG 4
#define ELOG_LVL_VERBOSE 5
/* 设置日志级别 */
#define ELOG_OUTPUT_LVL ELOG_LVL_VERBOSE
/* 断言(Assert) */
#define LOG_A(args,...)\
do{\
if (ELOG_OUTPUT_LVL >= ELOG_LVL_ASSERT)\
{\
printf("[A/%s Line:%.4d] " args "\n", __FILE__, __LINE__, ##__VA_ARGS__);\
}\
}while(0)
/* 错误(Error) */
#define LOG_E(args,...)\
do{\
if (ELOG_OUTPUT_LVL >= ELOG_LVL_ASSERT)\
{\
printf("[E/%s Line:%.4d] " args "\n", __FILE__, __LINE__, ##__VA_ARGS__);\
}\
}while(0)
/* 警告(Warn) */
#define LOG_W(args,...)\
do{\
if (ELOG_OUTPUT_LVL >= ELOG_LVL_WARN)\
{\
printf("[W/%s Line:%.4d] " args "\n", __FILE__, __LINE__, ##__VA_ARGS__);\
}\
}while(0)
/* 信息(Info) */
#define LOG_I(args,...)\
do{\
if (ELOG_OUTPUT_LVL >= ELOG_LVL_INFO)\
{\
printf("[I/%s Line:%.4d] " args "\n", __FILE__, __LINE__, ##__VA_ARGS__);\
}\
}while(0)
/* 调试(Debug) */
#define LOG_D(args,...)\
do{\
if (ELOG_OUTPUT_LVL >= ELOG_LVL_DEBUG)\
{\
printf("[D/%s Line:%.4d] " args "\n", __FILE__, __LINE__, ##__VA_ARGS__);\
}\
}while(0)
/* 详细(Verbose) */
#define LOG_V(args,...)\
do{\
if (ELOG_OUTPUT_LVL >= ELOG_LVL_VERBOSE)\
{\
printf("[V/%s Line:%.4d] " args "\n", __FILE__, __LINE__, ##__VA_ARGS__);\
}\
}while(0)
#ifdef __cplusplus
}
#endif
#endif /* __MYLOG_H__ */
结果:
huislee@huislee-virtual-machine:~/workspace/EasyLogger/test/level$ gcc *.c -o a
huislee@huislee-virtual-machine:~/workspace/EasyLogger/test/level$ ./a
[Nov 28 2020 09:03:10][A/main.c Line:0008] Hello world
[Nov 28 2020 09:03:10][E/main.c Line:0009] Hello world
[Nov 28 2020 09:03:10][W/main.c Line:0010] Hello world
[Nov 28 2020 09:03:10][I/main.c Line:0011] Hello world
[Nov 28 2020 09:03:10][D/main.c Line:0012] Hello world
[Nov 28 2020 09:03:10][V/main.c Line:0013] Hello world