提升效率之如何打印出漂亮的带颜色的日志(输出高亮)

日志系统对于一个软件的维护是很重要的，对于直接在本地打印的信息，可能包含非常多，如何才能快速发现自己想要打印的东西呢？带上颜色的输出，绝对是很好的选择。
使用c/c++的输出可以照搬shell的，那么先来看下shell怎么花里胡哨的输出。

1. 花里胡哨的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;
}

效果如图：

这样就完成了。
这个的代码有两点需要注意的

1. 使用了可变参数 va_arg，不懂得可以看我这篇 c语言 神奇的可变参数
2. 宏定义的do while(0)：do{...}while(0)在C中是唯一的构造程序，让你定义的宏总是以相同的方式工作，这样不管怎么使用宏（尤其在没有用大括号包围调用宏的语句），宏后面的分号也是相同的效果。其实就是说，使用do{...}while(0)构造后的宏定义不会受到大括号、分号等的影响，总是会按你期望的方式调用运行。

这样打印出的相当于高亮的日志是容易被发现的，在学习工作中，应该会提高不少效率。