【RT-Thread学习笔记】多彩的printf日志输出

​使用过C语言的童鞋都知道，使用printf可以在终端（控制台或者串口等输出设备）输出信息，这为我们平时调试程序提供了便利，只是我们通常的打印用法，仅仅是 printf("Hello World !\r\n"); 毫无生气，控制台也仅仅是输出，白底黑字的 Hello World ！

今天我将给大家介绍一种带颜色输出的printf用法，从此你将告诉枯燥单调的输出，你的日志也可以变成属于你自己的“艺术品”！话不多说，先来张图感受下 ！！！ 注意 72 行的输出其实是间隙闪烁的哦，只不过截图了感受不出来。

---

以下是正文部分，通过本文的阅读，你将了解到以下内容：

• printf带颜色控制的打印输出
• 日志分级别打印的实践

---

printf带颜色控制的打印输出

---

printf带颜色输出，首先需要了解下控制台输出的属性设置原理：通过用一串转义序列将输出的控制信息嵌入到printf语句中。

【转义序列】是以控制字符'ESC'开头。该字符的ASCII码十进制表示为27，十六进制表示为0x1B，八进制表示为033。多数转义序列超过两个字符，故通常以'ESC'和左括号'['开头。该起始序列称为控制序列引导符(CSI，Control Sequence Intro)，通常由'\033['或'\e['代替。通过转义序列设置终端显示属性时，可采用以下格式：

\033[ Param {;Param;...}m 或 \e[ Param {;Param;...}m

其中，'\033['或'\e['引导转义序列，'m'表示设置属性并结束转义序列。Param为属性值，{...}表示可选(多个参数之间用分号隔开，与顺序无关)。

【颜色】是通过添加专用序列来选择的 -- 基本上是夹在 "\e["和 "m" 之间数字值。如果指定一个以上的数字代码，则用分号将它们分开。例如"\e[31;40m"；第一个数字(31)为前景颜色(红色)；第二个数字为(40)背景颜色(黑色)； "\e[0m" 表示关闭设置属性。
【显示】：0(默认)、1(粗体/高亮)、22(非粗体)、4(单条下划线)、24(无下划线)、5(闪烁)、25(无闪烁)、7(反显、翻转前景色和背景色)、27(无反显)
【颜色值】：0(黑)、1(红)、2(绿)、 3(黄)、4(蓝)、5(紫)、6(深绿)、7(白)；颜色分为背景色和字体色，30~39（30+颜色值）用来设置字体色（前景色），40~49（40+颜色值）设置背景（背景色）：如31表示前景色为红色，41表示背景色为红色。

好了，基本知识就介绍到，以下是前面图片对应的示例代码。

#include 

/*
显示：0(默认)、1(粗体/高亮)、22(非粗体)、4(单条下划线)、24(无下划线)、5(闪烁)、25(无闪烁)、7(反显、翻转前景色和背景色)、27(无反显)
颜色值：0(黑)、1(红)、2(绿)、 3(黄)、4(蓝)、5(紫)、6(深绿)、7(白)
颜色分为背景色和字体色，30~39（30+颜色值）用来设置字体色（前景色），40~49（40+颜色值）设置背景（背景色）：如31表示前景色为红色，41表示背景色为红色。
*/
#define COLOR_NONE         			"\033[0;m"  
#define RED          				"\033[0;31m"
#define LIGHT_RED    				"\033[1;31m"  //红色高亮
#define LIGHT_RED_INV    			"\033[5;7;31m"  //红色高亮，并反白显示，字体闪烁
#define GREEN        				"\033[0;32m"
#define LIGHT_GREEN  				"\033[1;32m"
#define BLUE         				"\033[0;34m"
#define LIGHT_BLUE   				"\033[1;34m" //蓝色高亮
#define DARY_GRAY    				"\033[1;30m"
#define CYAN         				"\033[0;36m"
#define LIGHT_CYAN   				"\033[1;36m"
#define PURPLE       				"\033[0;35m"
#define LIGHT_PURPLE 				"\033[1;35m"
#define YELLOW        				"\033[0;33m"
#define LIGHT_YELLOW       			"\033[1;33m" //黄色高亮
#define WHITE                                   "\033[0;37m"
#define LIGHT_WHITE        			"\033[1;37m" //白色高亮

/*
日志级别定义，数值越小，级别越高
*/
#define LOGGER_FATAL_LEVEL			1 	//致命错误，不可恢复
#define LOGGER_ERROR_LEVEL			2	//一般错误，可恢复
#define LOGGER_WARN_LEVEL			3	//警告
#define LOGGER_INFO_LEVEL			4	//信息
#define LOGGER_DEBUG_LEVEL			5	//调试

/*
当前日志级别配置
*/
#define LOGGER_CFG_LEVEL			LOGGER_DEBUG_LEVEL

/*
根据配置的日志级别输出日志
*/
#define logger_level_printf(level, fmt, arg...)\
	do {\
		if (level <= LOGGER_CFG_LEVEL) {\
			printf("[%s,%d] "fmt, __FILE__, __LINE__, ##arg);\
		}\
	} while(0)

#define logger_fatal(fmt, arg...)	logger_level_printf(LOGGER_FATAL_LEVEL, LIGHT_RED_INV fmt COLOR_NONE, ##arg)		
#define logger_error(fmt, arg...)	logger_level_printf(LOGGER_ERROR_LEVEL, LIGHT_RED fmt COLOR_NONE, ##arg)
#define logger_warn(fmt, arg...)	logger_level_printf(LOGGER_WARN_LEVEL, LIGHT_YELLOW fmt COLOR_NONE, ##arg)
#define logger_info(fmt, arg...)	logger_level_printf(LOGGER_INFO_LEVEL, LIGHT_BLUE fmt COLOR_NONE, ##arg)
#define logger_debug(fmt, arg...)	logger_level_printf(LOGGER_DEBUG_LEVEL, LIGHT_WHITE fmt COLOR_NONE, ##arg)

int main(int argc, const char *argv[])
{
    /* 普通的printf输出 */
    printf("This is my function called %s() ...\n", __func__);
	
    /* 测试不同的日志输出 */
    logger_fatal("This fatal log ...\r\n");
    logger_error("This error log ...\r\n");
    logger_warn("This warn log ...\r\n");
    logger_info("This info log ...\r\n");
    logger_debug("This debug log ...\r\n");
	
    return 0;
}

---

日志分级别打印的实践

---

示例代码中将日志分为五个级别，从对运行的影响的重要性，从高到低分别是： 致命错误、普通错误、警告、信息、调试。

致命错误fatal级别的日志使用 “高亮红色输出，并且反色输出，同时字体间隙闪烁”；

普通错误error级别的日志使用 “高亮红色输出”；

警告warn级别的日志使用 “高亮黄色输出”；

信息info级别的日志使用 “高亮蓝色输出”；

调试debug级别的日志使用 “高亮白色输出”；

另外，有个宏LOGGER_CFG_LEVEL 可以配置当前的日志级别，此项配置的含义是，当需要输出的日志级别比配置的日志级别高时，该日志就会被最终输出，否则该日志则会被抛弃。【数值越小，表示日志级别越高】

示例代码中配置的是debug级别，所以所有级别的日志都会被输出。我们试下修改日志级别配置，配置成warn级别：

/*
当前日志级别配置
*/
#define LOGGER_CFG_LEVEL			LOGGER_WARN_LEVEL

编译后测试下

这基本就达到了我们需要控制日志输出的需求。

---

好了，关于printf带颜色输出和日志分级别输出的内容就介绍到这里，如果你觉得有帮助，可以试着应用在你的工程中，让你的日志输出高效起来吧 ！！！

​审核编辑：汤梓红