我的開發組長曾經說過這么一段話“一個優秀的程序員不在于他寫代碼有多快,也不在于他能不能實現這個模塊的功能,要實現業務實現功能誰不會啊,重要的是他的解決能力,也就說當程序出現錯誤時你能不能夠快速定位到錯誤并解決它?!?/span>
是的,我也非常贊同,代碼不可能完美,也可能有千奇百怪的bug,尤其是新手,犯的錯誤就更多了,所以,我們寫程序時應有自己的一套debug手段,有一套自己的LOG的方法,一旦程序發生錯誤,我們不需要再往程序中加繁瑣的打印就可以定位到錯誤位置,這樣才能加快自己的開發速度。
那怎么才算有一套高效的debug手段呢?我的想法是這樣:
進程內開一個獨立線程用于Debug&Info Center,在這里我們可以看到所有的打印信息,便于追蹤各程序動向
標準化一套日志/打印的手段,不要再使用簡陋的printf,在適當的位置加適當的log
今天我們先來完成自定義一套屬于我們LOG的規定。
一、信息類別與等級
我們知道,程序內可能出現各種異常,有的異常很嚴重,一不注意就發生coredump;有的異常只是可能對程序的運行產生影響,但不至于掛掉;有的異常是隱蔽的,雖說現在沒對系統產生明顯影響,但是不加處理也終究是個隱患。如果我們對這些異常都使用printf語句的話,我們就區分不了哪些異常重要哪些不重要了,所以我們首先得給信息分類別評等級(severity)。我的劃分是這樣的:
fatal ? ? ? ? ? 致命錯誤
alarm ? ? ? ? 需要立即糾正的錯誤
error ? ? ? ? ?需要關注的錯誤
warning ? ? ?警告,可能存在某種差錯
info ? ? ? ? ? ?一般提示信息
debug ? ? ? ?調試信息?
代碼定義可以這么寫:
#define FATAL 1#define ALARM 2#define ERROR 3#define WARN 4#define INFO 5#define DEBUG 6?
二、log的設計
根據我們上面規定的打印等級,我們很容易設計出相應的debug log,閑話少說,先上代碼:
#define MY_LOG(level, fmt, args...) do{ \ if(BIT_ON(debug_flag,level)){ \ printf("[%s]:", __FUNCTION__); \ printf(fmt, ##args); \ } \}while(0)
當然我們還需要定義一套設置debug level的方法,我的思路是這樣的:
采用bit-map思想,定義一個unsigned int的數,這個數的而每一位表示一個級別,比如一個unsigned int的數就可以表示32個級別
定義相應的函數/宏定義,去設置相應的位
根據以上想法,可以設置出下面一系列的操作:
#define PRESENT_BIT32(x) (((uint32)((uint32)1<<(x))))#define BIT_ON32(m, b) (((m) & PRESENT_BIT32(b)) != 0)#define SET_BIT32(m, b) ((m) |= PRESENT_BIT32(b))#define CLEAR_BIT32(m, b) ((m) &= ~PRESENT_BIT32(b))
解釋:
PRESENT_BIT32(x) ? ?:對應level的位的位置
BIT_ON32(m, b) ? ? ?:判定某一位是否為1
SET_BIT32(m, b) ? ? :設置指定位為1
CLEAR_BIT32(m, b) ? :將指定為設置為0
上面我們使用了宏定義來定義出帶級別的LOG,那該怎么使用這些LOG呢?使用方法如下:
if(pthread_create(&thread2_id, NULL, (void*)msg_sender2, NULL)){ MY_LOG(FATAL,"create handler thread fail!\n"); return -1; }MY_LOG(DEBUG,"I have recieved a message!\n");MY_LOG(DEBUG,"msgtype:%d msg_src:%d dst:%d\n\n",msg->hdr.msg_type,msg->hdr.msg_src,msg->hdr.msg_dst);
當然使用前需要先打開相應的log開關,比如我想看debug的log,可以這么做:
SET_BIT(debug_flag,?DEBUG);
這樣子我們就將系統的debug級別定義為DEBUG了。
再說一個打印的小技巧:給你的打印上顏色!
printf("\033[46;31m[%s:%d]\033[0m "#fmt" errno=%d, %m\r\n",?__func__,?__LINE__,?##args,?errno,?errno);
上面printf時在Linux命令行下打印出帶顏色的字體,方便一眼區分不同種類的調試信息,只需要加上一些顏色代碼,例如:這里的46代表底色, 31代表字體的顏色。
使用ascii code?是對顏色調用的始末格式如下:
\033[?;?m ……?\033[0m
后面哪個?”\033[0m”?是對前面哪個顏色載入的結束,恢復到終端原來的背景色和字體色,可以把后面哪個修改成如下試試:
#define DEBUG_ERR(fmt,?args...)?printf("\033[46;31m[%s:%d]\033[40;37m "#fmt" errno=%d, %m\r\n",?__func__,?__LINE__,?##args,?errno,?errno);
下面列出?ascii code?的顏色值:
字背景顏色范圍:40----49 ? ? ? ? ? ? ? ? ? ? ? ? ? 字顏色:30-----------39
40:黑? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ?30:黑
41:深紅? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? 31:紅
42:綠? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ?32:綠
43:黃色? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? 33:黃
44:藍色? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? 34:藍色
45:紫色? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? 35:紫色
46:深綠? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? 36:深綠
47:白色? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? 37:白色
記憶顏色格式太麻煩了,我們將它搞成宏定義吧,這樣以后用起來就方便得多。
#define NONE "\e[0m"#define BLACK "\e[0;30m"#define L_BLACK "\e[1;30m"#define RED "\e[0;31m"#define L_RED "\e[1;31m"#define GREEN "\e[0;32m"#define L_GREEN "\e[1;32m"#define BROWN "\e[0;33m"#define YELLOW "\e[1;33m"#define BLUE "\e[0;34m"#define L_BLUE "\e[1;34m"#define PURPLE "\e[0;35m"#define L_PURPLE "\e[1;35m"#define CYAN "\e[0;36m"#define L_CYAN "\e[1;36m"#define GRAY "\e[0;37m"#define WHITE "\e[1;37m"#define BOLD "\e[1m"#define UNDERLINE "\e[4m"#define BLINK "\e[5m"#define REVERSE "\e[7m"#define HIDE "\e[8m"#define CLEAR "\e[2J"#define CLRLINE "\r\e[K" //or "\e[1K\r"#define DEBUG_ERROR(fmt, args...) do{ \ printf(RED"[%s]:"NONE, __FUNCTION__); \ printf(fmt, ##args); \ }while(0);
效果:
所以,我建議將fatal一類致命錯誤級別的log用高亮顏色標注,一旦有這類錯誤發生我們也能第一時間察覺。
?
評論