Easylogging++ 中STL容器与字符串混合输出的注意事项

问题现象

在使用Easylogging++日志库时，开发者可能会遇到一个特殊现象：当尝试通过Logger对象的info方法同时输出字符串和STL容器时，容器内容无法正常显示。然而，使用全局LOG宏却能正确输出所有内容。

示例代码分析

让我们看一个典型示例：

#include <string>
#include <vector>

#define ELPP_STL_LOGGING
#include "easylogging++.h"

INITIALIZE_EASYLOGGINGPP

int main() {
    auto& mainLogger = *el::Loggers::getLogger("main");
    std::vector<std::string> check = {"check1", "check2"};
    
    // 使用全局LOG宏 - 工作正常
    LOG(INFO) << "Global log: " << check;
    
    // 使用Logger对象的info方法 - 容器内容不显示
    mainLogger.info("Logger log: ", check);
    
    // 再次使用全局LOG宏确认
    LOG(INFO) << "Global log 2: " << check;
    return 0;
};

输出差异

上述代码会产生如下输出：

2024-08-22 03:10:59,186 INFO [default] Global log: [check1, check2]
2024-08-22 03:10:59,186 INFO [default] Global log 2: [check1, check2]

注意：使用Logger对象的info方法输出的行完全缺失了容器内容。

解决方案

关键在于理解Easylogging++的两种不同日志输出方式的工作机制差异：

1. 全局LOG宏：使用流式操作符(<<)拼接多个参数，每个参数都会被自动处理。

2. Logger对象的info方法：采用类似printf的风格，需要在格式字符串中使用占位符%v来指示变量的插入位置。

修正后的代码应为：

mainLogger.info("Logger log %v", check);  // 注意添加了%v占位符

深入理解

这种设计差异源于两种不同的日志输出范式：

• 流式输出：通过重载<<操作符实现，每个<<操作都会将内容追加到输出缓冲区。

• 格式化输出：需要明确指定参数插入位置，提供更精确的控制，但需要开发者显式标记。

最佳实践建议

1. 当需要混合输出字符串和STL容器时，优先使用全局LOG宏的流式语法，可读性更好。

2. 如果必须使用Logger对象的方法，记得：

   • 在格式字符串中添加%v占位符
   • 确保占位符数量与后续参数数量匹配

3. 对于复杂数据结构输出，考虑统一使用一种风格，避免混用导致混淆。

总结

Easylogging++提供了灵活的日志输出方式，但不同方式有各自的语法要求。理解流式输出与格式化输出的区别，特别是%v占位符的作用，是正确输出STL容器的关键。通过遵循正确的语法规范，开发者可以充分利用Easylogging++强大的STL容器支持功能。