大家好，我是麥鴿，這次分享一個(gè)小技巧，打印帶顏色編碼的日志，希望對(duì)你有所幫助。

在項(xiàng)目開發(fā)中，日志可以幫助我們調(diào)試和發(fā)現(xiàn)產(chǎn)品中潛藏的問題，比如在發(fā)生錯(cuò)誤的時(shí)候，打印相應(yīng)的日志，定位發(fā)生錯(cuò)誤的位置，通常我們需要日志滿足以下這些功能：

• 不同的日志級(jí)別（Trace、Warning、Info、Error、fatal）；
• 能夠設(shè)置日志級(jí)別；
• 基于日志級(jí)別的顏色編碼；
• 占用空間小；
• 可配置，可以完全禁用它；
• 時(shí)間戳；
• 易于集成；

下面我們介紹一下如何在串口上打印出不同顏色的字符串。

在Stack Overflow上有人提出過類似的問題，如何在終端打印出彩色的字符？

這里給出了一個(gè)很簡單的C程序demo，我測試了一下，確實(shí)可以實(shí)現(xiàn)；

#include <stdio.h>

#define ANSI_COLOR_RED     "x1b[31m"
#define ANSI_COLOR_GREEN   "x1b[32m"
#define ANSI_COLOR_YELLOW  "x1b[33m"
#define ANSI_COLOR_BLUE    "x1b[34m"
#define ANSI_COLOR_MAGENTA "x1b[35m"
#define ANSI_COLOR_CYAN    "x1b[36m"
#define ANSI_COLOR_RESET   "x1b[0m"

int main (int argc, char const *argv[]) {
        
        printf(ANSI_COLOR_RED     "This text is RED!"     ANSI_COLOR_RESET "rn");
        printf(ANSI_COLOR_GREEN   "This text is GREEN!"   ANSI_COLOR_RESET "rn");
        printf(ANSI_COLOR_YELLOW  "This text is YELLOW!"  ANSI_COLOR_RESET "rn");
        printf(ANSI_COLOR_BLUE    "This text is BLUE!"    ANSI_COLOR_RESET "rn");
        printf(ANSI_COLOR_MAGENTA "This text is MAGENTA!" ANSI_COLOR_RESET "rn");
        printf(ANSI_COLOR_CYAN    "This text is CYAN!"    ANSI_COLOR_RESET "rn");

        return 0;
}

最終編譯之后運(yùn)行得到的結(jié)果如下，發(fā)現(xiàn)打印的字符顏色發(fā)生了變化；

輸出結(jié)果

ANSI轉(zhuǎn)義序列（ANSI escape sequences）是一種帶內(nèi)信號(hào)的轉(zhuǎn)義序列標(biāo)準(zhǔn)，用于控制視頻文本終端上的光標(biāo)位置、顏色和其他選項(xiàng)。在文本中嵌入確定的字節(jié)序列，大部分以ESC轉(zhuǎn)義字符和"["字符開始，終端會(huì)把這些字節(jié)序列解釋為相應(yīng)的指令，而不是普通的字符編碼。

所以這里我們查了一下ascii碼表，可以發(fā)現(xiàn)ESC的碼值是十進(jìn)制的27，也就是十六進(jìn)制的0x1b，具體如下所示；

ascii碼表

所以轉(zhuǎn)義序列的格式如下；

轉(zhuǎn)自wiki

可以參考文檔:https://invisible-island.net/xterm/ctlseqs/ctlseqs.html

所以這里簡單舉個(gè)例子，設(shè)置不同的背景色；

#include <stdio.h>

int main(){

        for(int i = 0; i < 256; i++){

                printf("x1b[48;5;%dm %03d x1b[0m", i, i);

                if( i % 10 == 0){
                        printf("rn");
                }
        }
        return 0;
}

重點(diǎn)是這一句：printf("x1b[48;5;%dm %03d x1b[0m", i, i);簡單分析一下；

• 其中x1b[ 是起始指令，后面的48表示設(shè)置背景色，38是前景色；
• 48后面通常會(huì)跟一個(gè);5;，這個(gè)是文檔中規(guī)定的，第一個(gè)%d，是設(shè)置色號(hào)，最后以m結(jié)尾；

參數(shù)設(shè)置

• 第二個(gè)%03d是中間需要顯示的文本；
• 最后以x1b[0m結(jié)束；

測試系統(tǒng)是Ubuntu 1804，最終的運(yùn)行結(jié)果如下所示；

運(yùn)行結(jié)果

單片機(jī)可以將日志通過串口打印出來，這時(shí)候需要顯示彩色字符，需要一個(gè)前提，就是串口終端軟件需要支持解析ANSI轉(zhuǎn)義序列。

下面我做了簡單的實(shí)驗(yàn)，通過STM32的串口，發(fā)送相應(yīng)的字符，然后在PC端使用MobaXterm軟件打開串口并接收數(shù)據(jù)；因?yàn)檫@個(gè)軟件是支持ANSI序列的，所以最終可以顯示出不同顏色的字符串。具體如下所示；

moba xterm中的結(jié)果

本文介紹了如何打印彩色字符串，其中簡單介紹了ANSI轉(zhuǎn)義序列，并且給出了幾個(gè)小的實(shí)驗(yàn)結(jié)果，并在單片機(jī)上發(fā)送字符串到PC上，使用xterm串口終端，可以正常顯示設(shè)置前景色的字符串，結(jié)果符合預(yù)期。

其實(shí)已經(jīng)有一些日志庫可以支持彩色的打印。后面再來推薦一波。