Easylogging++ 中 Logger 日志函数与 STL 容器的使用注意事项

问题现象

在使用 Easylogging++ 日志库时，开发者可能会遇到一个有趣的现象：当通过 Logger 对象的 info() 等日志函数直接输出 STL 容器时，如果参数中包含字符串和 STL 容器的组合，可能会出现日志内容缺失的情况。

具体表现为：

• 使用全局 LOG 宏可以正常输出字符串和 STL 容器的组合
• 使用 Logger 对象的日志函数时，如果第一个参数是字符串，后面跟着 STL 容器，容器内容不会被记录
• 如果直接传递 STL 容器作为唯一参数，则可以正常输出

原因分析

这种现象的根本原因在于 Easylogging++ 的两种不同日志记录方式的工作机制差异：

1. 流式日志记录(LOG宏)：

   • 使用 C++ 的流操作符(<<)拼接日志内容
   • 自动处理所有类型的输出
   • 对 STL 容器有原生支持(需定义 ELPP_STL_LOGGING)

2. 格式化日志记录(Logger成员函数)：

   • 使用类似 printf 的格式化语法
   • 需要在格式字符串中明确指定参数位置
   • 必须使用 %v 作为占位符来指示参数插入位置

解决方案

要正确使用 Logger 对象的日志函数输出 STL 容器，必须遵循以下规则：

1. 在格式字符串中使用 %v 占位符标记参数位置
2. 确保占位符数量与后续参数数量匹配
3. 对于 STL 容器参数，同样使用 %v 作为占位符

正确用法示例

#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"};
    
    // 正确用法1：使用%v占位符
    mainLogger.info("Logger log %v", check);
    
    // 正确用法2：直接传递容器
    mainLogger.info(check);
    
    // 正确用法3：多个参数和字符串组合
    mainLogger.info("First: %v, Second: %v", check, std::vector<int>{1,2,3});
    
    return 0;
};

技术背景

Easylogging++ 的这种设计源于其支持两种不同的日志记录范式：

1. 类型安全的流式接口：

   • 基于C++流操作符重载
   • 编译时类型检查
   • 自动处理各种类型的字符串表示

2. 高效的格式化接口：

   • 类似传统C的printf风格
   • 运行时解析格式字符串
   • 需要显式指定参数位置
   • 性能可能略优于流式接口

对于STL容器的支持，Easylogging++ 通过模板特化和运算符重载实现，但需要开发者明确启用 ELPP_STL_LOGGING 宏定义。

最佳实践建议

1. 根据项目需求统一选择一种日志记录风格
2. 如果使用格式化风格，务必记得添加%v占位符
3. 对于复杂对象组合，考虑使用流式接口提高可读性
4. 在性能敏感场景，可以测试两种方式的性能差异
5. 启用STL日志支持时，确保所有编译单元都定义了ELPP_STL_LOGGING

理解这些底层机制可以帮助开发者更有效地使用Easylogging++，避免常见的日志输出问题。