提升效率之如何打印出漂亮的帶顏色的日誌(輸出高亮)


日誌系統對於一個軟件的維護是很重要的,對於直接在本地打印的信息,可能包含非常多,如何才能快速發現自己想要打印的東西呢?帶上顏色的輸出,絕對是很好的選擇。
使用c/c++的輸出可以照搬shell的,那麼先來看下shell怎麼花裏胡哨的輸出。

1. 花裏胡哨的shell打印

shell花式輸出
第二段就是我想要的結果,而第一段是錯誤的輸出,顏色該結束還沒結束,這個下面會說到原因。(不過我感覺都挺好看hhh,程序員的快樂就是這樣的簡單樸實)。
那麼這是怎麼搞得呢,廢話不多說,上代碼

#/bin/sh

#effect
echo -e "\033[1m Bold"        # bold effect
echo -e "\033[5m Blink"       # blink effect
echo -e "\033[0m Hello World" # back to normal

#color
echo -e "\033[31m Red"        # red
echo -e "\033[32m Green"      # green
echo -e "\033[33m Yellow"     # yellow
echo -e "\033[34m Blue"       # blue
echo -e "\033[35m Purple"     # purple
echo -e "\033[36m Cyan"       # cyan
echo -e "\033[0m Normal"      # back to normal

#background
echo -e "\033[41m Hello World Red\033[0m"
echo -e "\033[42m Hello World Green\033[0m"
echo -e "\033[43m Hello World Yellow\033[0m"
echo -e "\033[44m Hello World Blue\033[0m"
echo -e "\033[45m Hello World Purple\033[0m"
echo -e "\033[46m Hello World Cyan\033[0m"
echo -e "\033[0m Hello World Normal"

先來解釋下參數

  • echo -e是激活特殊字符格式,這不必多說
  • “\033”引導非常規字符序列
  • “m”意味着設置屬性然後結束非常規字符序列

所以決定什麼顏色的就是這些數字了。下表即爲數字的對照含義。

字顏色 背景顏色
紅色 31 41
綠色 32 42
黃色 33 43
藍色 34 44
紫色 35 45
藍綠色 36 46
正常 0 0

還有一些是特殊效果

含義
0 OFF
1 高亮顯示
4 下劃線
5 閃爍(blink,雖然我沒看出來怎麼blink了)
7 反白顯示
8 不可見

結合這些,我們可以做個實驗
顏色實驗

echo -e "\033[44;31;5m That is extremely cool \033[0m really?"

起作用的是 44;31;5,這個就是藍色背景,紅色字體,閃爍
實驗證明了三點:

  1. 這三個參數的擺放位置是無關的。
  2. 最後要回歸正常\033[0m,否則結果就是最後兩次的輸出嘗試,這也是我上面截圖所說的錯誤輸出的地方。
  3. 不同背景顏色字體顏色效果的搭配會使輸出看起來顏色不同,更好看hhh

從shell的這種輸出也可以推廣到c/c++或者其他語言。

2. c語言日誌的彩色輸出

echo是等價於printf的,其他等價轉換一下就ok了,直接上代碼。

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <stdarg.h>
#include <time.h>
#include <sys/timeb.h>



#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 log_info(format, ...)                                                                            \
    do                                                                                                      \
    {                                                                                                       \
        log_time(L_CYAN);                                                                                   \
        printf(L_CYAN "[WARN][%s][%s][%d]" format "\r\n", __FILE__, __FUNCTION__, __LINE__, ##__VA_ARGS__); \
        printf(NONE);                                                                                       \
    } while (0)

#define log_error(format, ...)                                                                            \
    do                                                                                                      \
    {                                                                                                       \
        log_time(L_RED);                                                                                   \
        printf(L_RED "[WARN][%s][%s][%d]" format "\r\n", __FILE__, __FUNCTION__, __LINE__, ##__VA_ARGS__); \
        printf(NONE);                                                                                       \
    } while (0)

#define log_warning(format, ...)                                                                            \
    do                                                                                                      \
    {                                                                                                       \
        log_time(YELLOW);                                                                                    \
        printf(YELLOW "[WARN][%s][%s][%d]" format "\r\n", __FILE__, __FUNCTION__, __LINE__, ##__VA_ARGS__); \
        printf(NONE);                                                                                       \
    } while (0)

#define log_bug(format, ...)                                                                                \
    do                                                                                                      \
    {                                                                                                       \
        log_time(L_BLUE);                                                                                   \
        printf(L_BLUE "[WARN][%s][%s][%d]" format "\r\n", __FILE__, __FUNCTION__, __LINE__, ##__VA_ARGS__); \
        printf(NONE);                                                                                       \
    } while (0)

#define log_time(color)                                                                                                                                      \
    do                                                                                                                                                      \
    {                                                                                                                                                       \
        struct tm *t;                                                                                                                                       \
        struct timeb stTimeb;                                                                                                                               \
        ftime(&stTimeb);                                                                                                                                    \
        t = localtime(&stTimeb.time);                                                                                                                       \
        printf(color "[%4d%02d%02d-%02d:%02d:%02d:%03d]", t->tm_year + 1900, t->tm_mon + 1, t->tm_mday, t->tm_hour, t->tm_min, t->tm_sec, stTimeb.millitm); \
        fflush(stdout);                                                                                                                                     \
        printf("\033[0m");                                                                                                                                  \
    } while (0)

int main()
{
    log_info("This is INFOMATION!");
    log_error("This is ERROR!");
    log_warning("This is WARNNING!");
    log_bug("This is BUG!");
    return 0;
}

效果如圖:
花裏胡哨的log
這樣就完成了。
這個的代碼有兩點需要注意的

  1. 使用了可變參數 va_arg,不懂得可以看我這篇 c語言 神奇的可變參數
  2. 宏定義的do while(0)do{...}while(0)在C中是唯一的構造程序,讓你定義的宏總是以相同的方式工作,這樣不管怎麼使用宏(尤其在沒有用大括號包圍調用宏的語句),宏後面的分號也是相同的效果。其實就是說,使用do{...}while(0)構造後的宏定義不會受到大括號、分號等的影響,總是會按你期望的方式調用運行。

這樣打印出的相當於高亮的日誌是容易被發現的,在學習工作中,應該會提高不少效率。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章