Quill日志库中自定义类型格式化输出的正确方法

在使用Quill日志库（6.1.0版本）时，开发者经常需要记录自定义数据类型。官方提供的Cheat Sheet虽然给出了基本示例，但在实际使用中可能会遇到编译错误，这是因为缺少关键的头文件包含。

问题背景

当用户尝试按照Cheat Sheet示例为自定义类型实现日志输出时，可能会遇到类似"未声明fmtquill::ostream_formatter"的编译错误。这是因为示例代码中缺少了必要的头文件包含，导致编译器无法找到相关的格式化器声明。

解决方案

正确的实现需要包含以下关键头文件：

#include <quill/bundled/fmt/ostream.h>

这个头文件提供了fmtquill::ostream_formatter的声明，它是Quill内部使用的fmt库的扩展，用于支持通过标准输出流(ostream)方式格式化自定义类型。

完整示例

以下是记录自定义类型的正确实现方式：

#include <quill/Quill.h>
#include <quill/bundled/fmt/ostream.h> // 必须包含的头文件

struct Point {
  int x;
  int y;
};

// 重载<<操作符用于Point类型的格式化输出
std::ostream& operator<<(std::ostream& os, Point const& obj) {
  os << "[" << obj.x << "," << obj.y << "]";
  return os;
}

int main() {
  quill::start();
  auto logger = quill::get_logger();
  
  Point p{10, 20};
  LOG_INFO(logger, "Point is {}", p); // 现在可以正确输出了
  
  return 0;
}

技术原理

Quill日志库底层使用了fmt库进行高效的格式化输出。对于自定义类型，Quill提供了两种格式化方式：

1. 通过fmt库的formatter特化（更高效）
2. 通过标准ostream的<<操作符重载（更简单）

当使用第二种方式时，必须包含<quill/bundled/fmt/ostream.h>头文件，该文件在fmt和标准ostream之间建立了桥梁，使得通过<<操作符定义的输出能够被fmt库识别和使用。

最佳实践

1. 对于简单的自定义类型，使用<<操作符重载方式即可
2. 对于性能敏感的场景，建议实现fmt::formatter特化
3. 确保包含所有必要的头文件
4. 在团队项目中，建议将自定义类型的日志支持代码集中管理

通过这种方式，开发者可以轻松地将任何自定义类型集成到Quill的日志系统中，实现灵活且类型安全的日志输出。