利用C可变参数和宏定义来实现自己的日志系统

【为啥写这篇文章】

   在嵌入式应用的开发过程中，日志系统是非常重要的！特别是在生产环节出现了偶发性的、与当前的执行环境相关的bug的时候，如果没有日志系统来追踪问题，很难进行问题重现。

    因此，实现一个自己的日志系统是很有帮助、很必要的。在软件模型上，一般是把日志系统编译成库文件。应用程序直接调用库中提供的API接口函数，即可记录日志信息。

    那么实现自己的日志系统需要有3个问题需要处理：

（1）日志API函数的设计。

（2）日志信息的缓存。

（3）日志信息的持久化，也就是写入到本地文件系统。

 

这篇文章主要说明第一个问题：日志API函数的设计。

【先上代码】

【测试】

【知识点】

1.字符串字面量的拼接

    在C语言中，字符串的拼接有很多种方法：memcpy,strcpy,strcat,sprintf等等。

    在代码19行，使用了C语言中的字符串字面量拼接的方式，把 " %s:%d(%s) \"" format "\"\n" 这3个字符串拼接成一个字符串。

 

    补充一下：

    在日志系统代码中，有些地方需要格式化字符串。

    使用sprintf是最方便的，但是也是效率最低的！

    也可以利用一些第三方的库来实现字符串格式化，比如：fmtlib，facebook 的 folly format，google的 Abseil StrFormat。

    当然，最好的方式是自己实现格式化特定类型的数据，可以显著的提高日志系统的吞吐量，下一篇文章再说说这部分代码。

 

2.可变参数

    大家都知道，printf函数就是通过可变参数机制来实现的。

    可变参数可以这样定义和使用：

（1）不带参数名

#define debug1(...)                printf(__VA_ARGS__)
#define debug2(format, ...)        printf(format, __VA_ARGS__)
#define debug3(format, ...)        printf(format, ##__VA_ARGS__)

（2）带参数名

​
#define debug4(args...)            printf(args)
#define debug5(format, args...)    printf(format, args)
#define debug6(format, args...)    printf(format, ##args)

 

    第20行代码用 __VA_ARGS__ 来代表宏定义参数中的三个点（...），也就是可变参数。

 

    再来说说“##”：

    如果调用：debug2("code = %d", 100); 这样调用没有问题。

    如果调用：debug2("hello"); 这里调用时，在format后面没有传入任何参数，那么就会编译错误，因为在宏替换之后变成了 printf("hello",)，第一个参数之后多了一个逗号，因此报错。

    如果调用：debug3("hello, world!"); 这样就没有问题，因为debug3中在可变参数__VA_ARGS__的前面有“##”，当编译器发现没有传入参数时，会自动把format后面的逗号去掉，所以编译OK。

 

3.宏定义中的#和##

    #的作用就是在预处理的时候，把宏参数进行“字符串化”，例如：

#define LOG(exp)   printf("%s=%d\n", #exp, exe)
int code = 100;
LOG(code);                // 被替换为"code=100"

 

    ##的作用就是在预处理的时候，把两个宏参数进行“粘合”，例如：

#define VAR(name, no)  name##no
int VAR(err, 1);   // 被替换为 int err1;
err1 = 100;

 

【打完收工】

不知道这篇文章是否给你带来小小的帮助？

另外，评论和转发都是免费的哦~~~

我会持续分享嵌入式开发过程中的各种最佳实践，欢迎关注公号：IOT物联网小镇