1. 代码总览
#define inf 0
#define dbg 1
#define err 2
#define log_level inf
#define log(level, format, ...) do { \
if (level < log_level) break; \
time_t t = time(null); \
struct tm* ltm = localtime(&t); \
char tmp[32] = {0}; \
strftime(tmp, 31, "%h:%m:%s", ltm); \
fprintf(stdout, "[%s %s:%d] " format "\n", tmp, __file__, __line__, ##__va_args__); \
} while(0)
#define inf_log(format, ...) log(inf, format, ##__va_args__)
#define dbg_log(format, ...) log(dbg, format, ##__va_args__)
#define err_log(format, ...) log(err, format, ##__va_args__)
int main() {
inf_log("s");
return 0;
}这段代码定义了一套简单的日志宏,支持:
- 日志级别:
inf、dbg、err - 可变参数:像
printf一样格式化输出 - 自动附加时间、文件名、行号
- 通过
log_level控制输出级别
2. 为什么需要日志宏?
在服务器开发中,日志是排查问题的重要手段。
但直接写 printf 有几个问题:
- 无法控制级别:调试信息、错误信息混在一起。
- 缺少上下文:不知道日志来自哪个文件、哪一行。
- 代码冗余:每次都要手写时间、文件、行号。
- 性能问题:低级别日志在发布版本中不应该输出。
日志宏的目标:
- 一行代码输出日志。
- 自动带时间、文件、行号。
- 支持级别过滤。
- 支持可变参数格式化。
3. 逐行拆解
3.1 日志级别定义
#define inf 0 #define dbg 1 #define err 2 #define log_level inf
inf:普通信息,级别最低。dbg:调试信息。err:错误信息,级别最高。log_level:当前编译期日志级别,只有level >= log_level的日志才会输出。
这里 log_level = inf,表示所有日志都输出。
如果改成 log_level = dbg,则 inf 日志被过滤,只输出 dbg 和 err。
3.2 核心宏 log
#define log(level, format, ...) do { \
if (level < log_level) break; \
time_t t = time(null); \
struct tm* ltm = localtime(&t); \
char tmp[32] = {0}; \
strftime(tmp, 31, "%h:%m:%s", ltm); \
fprintf(stdout, "[%s %s:%d] " format "\n", tmp, __file__, __line__, ##__va_args__); \
} while(0)逐部分解释:
3.2.1do { ... } while(0)
宏体用 do { ... } while(0) 包裹,是 c/c++ 宏的经典技巧。
好处:
- 保证宏展开后是一个语句块,可以安全地用在
if/else中。 - 避免分号问题。
- 内部可以使用
break提前退出。
例如:
if (cond)
log(inf, "hello");
else
...如果没有 do...while(0),展开后可能出错。
3.2.2 日志级别过滤
if (level < log_level) break;
- 如果当前日志级别低于设定级别,直接
break跳出do...while,不输出。 - 因为是编译期常量比较,编译器可能优化掉低级别日志。
3.2.3 获取当前时间
time_t t = time(null);
struct tm* ltm = localtime(&t);
char tmp[32] = {0};
strftime(tmp, 31, "%h:%m:%s", ltm);
time(null):获取当前时间戳。localtime(&t):转换为本地时间结构体struct tm。strftime:格式化时间为hh:mm:ss字符串,存入tmp。tmp[32]:足够容纳时间字符串。
注意:localtime 不是线程安全的,多线程环境建议用 localtime_r。
但在简单日志中,通常可以接受。
3.2.4 格式化输出
fprintf(stdout, "[%s %s:%d] " format "\n", tmp, __file__, __line__, ##__va_args__);
stdout:输出到标准输出。"[%s %s:%d] " format "\n":把固定格式和用户传入的format拼接。tmp:时间字符串。__file__:当前源文件名,预定义宏。__line__:当前行号,预定义宏。##__va_args__:gnu 扩展,处理可变参数为空的情况,删除前面的逗号。
输出格式类似:
[14:23:45 server.cpp:10] hello
3.3 三个封装宏
#define inf_log(format, ...) log(inf, format, ##__va_args__) #define dbg_log(format, ...) log(dbg, format, ##__va_args__) #define err_log(format, ...) log(err, format, ##__va_args__)
inf_log:输出普通信息。dbg_log:输出调试信息。err_log:输出错误信息。
使用时:
inf_log("server start");
dbg_log("client fd = %d", fd);
err_log("accept failed: %s", strerror(errno));
4. 关键知识点
4.1 可变参数宏
c++11 起支持可变参数宏:
#define log(format, ...) printf(format, ##__va_args__)
...表示可变参数。__va_args__在宏展开时替换为实际参数。##__va_args__是 gnu 扩展,当可变参数为空时删除前面的逗号,避免printf(format, )语法错误。
c++20 提供了 __va_opt__,但很多项目仍使用 ##__va_args__。
4.2 预定义宏
__file__:当前源文件名。__line__:当前行号。__func__:当前函数名(c++11)。__date__、__time__:编译日期和时间。
这些宏由编译器自动提供,非常适合日志。
4.3 do…while(0) 技巧
为什么不用 {} 而用 do...while(0)?
{}展开后可能和外部if/else产生悬空 else 问题。do...while(0)是一个完整语句,末尾需要分号,行为更一致。- 内部可以用
break跳出,相当于提前返回。
4.4 日志级别过滤
日志级别数值越大越严重:
inf=0:信息dbg=1:调试err=2:错误
log_level 控制最低输出级别。
例如 log_level=dbg,则 inf 不输出,dbg 和 err 输出。
这种设计在编译期决定,低级别日志可以被编译器优化掉,减少运行时开销。
5. 使用示例
#include <cstdio>
#include <ctime>
#include <cstring>
#define inf 0
#define dbg 1
#define err 2
#define log_level inf
#define log(level, format, ...) do { \
if (level < log_level) break; \
time_t t = time(null); \
struct tm* ltm = localtime(&t); \
char tmp[32] = {0}; \
strftime(tmp, 31, "%h:%m:%s", ltm); \
fprintf(stdout, "[%s %s:%d] " format "\n", tmp, __file__, __line__, ##__va_args__); \
} while(0)
#define inf_log(format, ...) log(inf, format, ##__va_args__)
#define dbg_log(format, ...) log(dbg, format, ##__va_args__)
#define err_log(format, ...) log(err, format, ##__va_args__)
int main() {
inf_log("server start");
dbg_log("client fd = %d", 10);
err_log("accept failed: %s", strerror(2));
return 0;
}输出示例:
[14:23:45 server.cpp:20] server start [14:23:45 server.cpp:21] client fd = 10 [14:23:45 server.cpp:22] accept failed: no such file or directory
6. 总结
这段日志宏虽然简单,但包含了多个 c/c++ 重要知识点:
- 可变参数宏:
...、__va_args__、##__va_args__ - do…while(0):宏定义的安全技巧
- 预定义宏:
__file__、__line__ - 时间处理:
time、localtime、strftime - 格式化输出:
fprintf - 日志级别:编译期过滤
一句话记忆:
日志宏 = 级别过滤 + 时间/文件/行号 + 可变参数格式化 + do…while(0) 安全包裹。
掌握它,你就理解了服务器开发中最基础的日志模块实现。
到此这篇关于c++ 仿 muduo 高并发服务器:日志模块(实例详解)的文章就介绍到这了,更多相关c++ muduo 高并发服务器内容请搜索代码网以前的文章或继续浏览下面的相关文章希望大家以后多多支持代码网!
发表评论