EasyLogger——讓BUG無(wú)處藏身
交心
在我們嵌入式開發(fā)中，調(diào)試代碼的方法有很多。比如使用調(diào)試器在線調(diào)試、借助一些測(cè)量?jī)x器、輸出調(diào)試日志等方式。
沒(méi)有哪種方法是最好的調(diào)試方法，實(shí)際開發(fā)中需要根據(jù)實(shí)際情況借助不同的方法進(jìn)行調(diào)試。但是，在一些稍微大點(diǎn)的項(xiàng)目中，輸出調(diào)試日志卻是比較好的調(diào)試方法。
輸出日志可以比較隨意，想輸出什么就輸出什么，但是也得注意兩個(gè)點(diǎn)：
一是輸出的日志盡量整潔明了，因?yàn)槿绻罩旧晕⒍嘁稽c(diǎn)，看起來(lái)就會(huì)很亂，很擾心；
二是方便打開/關(guān)閉日志相關(guān)代碼，程序調(diào)試階段打開，方便定位問(wèn)題，程序發(fā)布階段關(guān)閉，可節(jié)省不必要地資源開銷。
最近在做Linux方面的開發(fā)，整天分析日志，有點(diǎn)體會(huì)。順便也寫點(diǎn)日志筆記分享給大家：
站在巨人的肩膀上
網(wǎng)絡(luò)上有很多現(xiàn)成的日志庫(kù)，簡(jiǎn)單移植一下就可以使用。這里分享一個(gè)常用的日志庫(kù)—— EasyLogger。
碼云倉(cāng)庫(kù)及介紹地址：
https://gitee.com/Armink/EasyLogger?_from=gitee_search#easylogger
1、EasyLogger介紹
EasyLogger是一款超輕量級(jí)(ROM<1.6K, RAM<0.3K)、高性能的C/C++日志庫(kù)，非常適合對(duì)資源敏感的軟件項(xiàng)目，例如：IoT產(chǎn)品、可穿戴設(shè)備、智能家居等等。
2、EasyLogger特性
-
支持用戶自定義輸出方式（例如：終端、文件、數(shù)據(jù)庫(kù)、串口、485、Flash...）； -
日志內(nèi)容可包含級(jí)別、時(shí)間戳、線程信息、進(jìn)程信息等； -
日志輸出被設(shè)計(jì)為線程安全的方式，并支持 異步輸出及 緩沖輸出模式； -
支持多種操作系統(tǒng)（RT-Thread、UCOS、Linux、Windows...），也支持裸機(jī)平臺(tái)； -
日志支持 RAW格式，支持 hexdump； -
支持按 標(biāo)簽 、 級(jí)別、 關(guān)鍵詞進(jìn)行動(dòng)態(tài)過(guò)濾； -
各級(jí)別日志支持不同顏色顯示； -
擴(kuò)展性強(qiáng)，支持以插件形式擴(kuò)展新功能。
3、EasyLogger的嘗試
該開源項(xiàng)目提供了豐富的demo，有stm32裸機(jī)的demo，有RT-Thread的demo、有Windows下的demo、有Linux下的demo。這里我們跑一下stm32裸機(jī)的demo。
進(jìn)行初始化及一些設(shè)置之后就可以調(diào)用其給我們用戶提供的日志打印接口log_a、log_e、log_w等來(lái)輸出日志信息，我們使用日志庫(kù)也主要使用的是這幾個(gè)接口，其它輔助功能有興趣的朋友可自行學(xué)習(xí)使用。
4、EasyLogger的移植、剖析
想要對(duì)EasyLogger進(jìn)行深入學(xué)習(xí)可查閱項(xiàng)目的readme文件、源碼閱讀及如下兩篇文章：
【開源解讀】一款輕量級(jí)C日志庫(kù)-EasyLogger
第3期 | EasyLogger，一款輕量級(jí)且高性能的日志庫(kù)
自己動(dòng)手，豐衣足食
網(wǎng)絡(luò)上的一些日志庫(kù)的功能過(guò)于強(qiáng)大，有時(shí)候我們用不上一些高級(jí)的功能，沒(méi)必要大動(dòng)干戈移植一個(gè)日志庫(kù)。
這時(shí)候我們可以通過(guò)簡(jiǎn)單的幾行代碼實(shí)現(xiàn)我們自己的日志打印格式。其實(shí)之前也有簡(jiǎn)單分享過(guò)打印相關(guān)的技術(shù)筆記：C語(yǔ)言、嵌入式中幾個(gè)非常實(shí)用的宏技巧
摘選那篇筆記的代碼：
左右滑動(dòng)查看全部代碼>>>
#define??DEBUG???1??
#if?DEBUG
??#define?DBG_PRINTF(fmt,?args...)??\
??do\
??{\
????printf("<>?" ,?__FILE__,?__LINE__,?__FUNCTION__);\
????printf(fmt,?##args);\
??}while(0)
#else
??#define?DBG_PRINTF(fmt,?args...)???
#endif
我們拿來(lái)修改一下，下面分享兩種簡(jiǎn)單的日志輸出方式：
1、分模塊打印
給各個(gè)模塊加上宏打印開關(guān)。在調(diào)試時(shí)可以通過(guò)宏開關(guān)先屏蔽掉沒(méi)有問(wèn)題的模塊的日志信息，減少日志地輸出，方便專注于有問(wèn)題的模塊分析。
直接上代碼吧。。。
（1）main.c
左右滑動(dòng)查看全部代碼>>>
/*?
demo:?分模塊打印日志
公眾號(hào)：嵌入式大雜燴
*/
#include?
#include?"module1.h"
#include?"module2.h"
int?main(void)
{
?module1_print();
?module2_print();
?return?0;
}
（2）mylog.h
左右滑動(dòng)查看全部代碼>>>
#define?__MYLOG_H__
#ifdef?__cplusplus
extern?"C"?{
#endif
#include?
/*?各模塊日志開關(guān)?*/
#define??MODULE1_LOG_SWITCH??1
#define??MODULE2_LOG_SWITCH??1
/*?日志統(tǒng)一輸出的格式?*/
#define?DBG_PRINTF(fmt,?args...)??\
do\
{\
?printf("<>?" ,?__FILE__,?__LINE__,?__FUNCTION__);\
?printf(fmt,?##args);\
}while(0)
#ifdef?__cplusplus
}
#endif
#endif?/*?__MYLOG_H__?*/
（3）module1.c
左右滑動(dòng)查看全部代碼>>>
#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");
}
（4）module1.h
左右滑動(dòng)查看全部代碼>>>
#ifndef?__MODEL1_H__
#define?__MODEL1_H__
#ifdef?__cplusplus
extern?"C"?{
#endif
#include?"mylog.h"
void?module1_print(void);
#ifdef?__cplusplus
}
#endif
#endif?/*?__MODEL1_H__?*/
（5）module2.c
左右滑動(dòng)查看全部代碼>>>
#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");
}
（6）module2.h
左右滑動(dòng)查看全部代碼>>>
#ifndef?__MODEL2_H__
#define?__MODEL2_H__
#ifdef?__cplusplus
extern?"C"?{
#endif
#include?"mylog.h"
void?module2_print(void);
#ifdef?__cplusplus
}
#endif
#endif?/*?__MODEL2_H__?*/
通過(guò)模塊日志開關(guān)可以打開/關(guān)閉各模塊日志打印接口。這里的demo只拿兩個(gè)模塊作為例子，可模仿這兩個(gè)模塊拓展其它模塊。
編譯、運(yùn)行：
2、分級(jí)打印
分級(jí)打印是日志庫(kù)里常用的方式，比如上面的EasyLogger日志庫(kù)的分級(jí)打印實(shí)現(xiàn)方式：
這也是EasyLogger的核心部分。
我們可以把這一部分抽出來(lái)修改一下：
（1）main.c
左右滑動(dòng)查看全部代碼>>>
/*??
demo：分級(jí)打印日志
公眾號(hào)：嵌入式大雜燴
*/
#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;
}
（2）mylog.h
左右滑動(dòng)查看全部代碼>>>
#ifndef?__MYLOG_H__
#define?__MYLOG_H__
#ifdef?__cplusplus
extern?"C"?{
#endif
#include?
/*?日志級(jí)別?*/
#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
/*?設(shè)置日志級(jí)別?*/
#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)
/*?錯(cuò)誤(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)
?
/*?調(diào)試(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)
?
/*?詳細(xì)(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__?*/
編譯、運(yùn)行：
以上就是本次的筆記分享，如有錯(cuò)誤，歡迎指出，感謝閱讀！期待大家的轉(zhuǎn)發(fā)，大家的轉(zhuǎn)發(fā)也是我持續(xù)更新的動(dòng)力。
猜你喜歡
OpenBLT Bootloader的使用分享
C語(yǔ)言對(duì)象編程第一彈：封裝與抽象
免責(zé)聲明：本文內(nèi)容由21ic獲得授權(quán)后發(fā)布，版權(quán)歸原作者所有，本平臺(tái)僅提供信息存儲(chǔ)服務(wù)。文章僅代表作者個(gè)人觀點(diǎn)，不代表本平臺(tái)立場(chǎng)，如有問(wèn)題，請(qǐng)聯(lián)系我們，謝謝！
下載文檔
