在Quill日志库中复用自定义类型fmt::formatter的最佳实践

背景介绍

Quill是一个高性能的C++日志库，它内部集成了fmt库用于格式化输出。在实际开发中，我们经常需要为自定义类型实现格式化功能，以便在日志中输出结构化的数据。本文将详细介绍如何在Quill中复用已经为fmt库实现的formatter，以及相关的技术细节和最佳实践。

问题核心

Quill使用了自己内部集成的fmt版本，而不是项目中可能使用的独立fmt库。这意味着即使我们已经在项目中为某个类型实现了fmt::formatter，Quill也无法直接使用这个实现，因为它使用的是不同的命名空间(fmtquill)。

解决方案

方法一：使用宏定义重复实现

我们可以定义一个宏来同时为fmt和fmtquill命名空间实现formatter：

#define DEFINE_FORMATTER(Namespace) \
template <> \
struct Namespace::formatter<User> \
{ \
  constexpr auto parse(Namespace::format_parse_context& ctx) { return ctx.begin(); } \
  auto format(const User& value, Namespace::format_context& ctx) const \
  { \
    return Namespace::format_to(ctx.out(), "id: {}, age: {}", value.id, value.age); \
  } \
}

DEFINE_FORMATTER(fmt);
DEFINE_FORMATTER(fmtquill);

#undef DEFINE_FORMATTER

这种方法简单直接，但需要确保两个实现保持一致。

方法二：使用模板继承

更优雅的方式是利用模板继承，避免代码重复：

template <>
struct fmt::formatter<User>
{
  template <typename TFormatParseCtx>
  constexpr auto parse(TFormatParseCtx& ctx) { return ctx.begin(); }

  template <typename TFormatCtx>
  auto format(const User& user, TFormatCtx& ctx) const
  {
    return fmt::format_to(ctx.out(), "id: {}, age: {}", user.id, user.age);
  }
};

template <>
struct fmtquill::formatter<User> : fmt::formatter<User>
{
};

这种方法通过继承复用fmt的实现，更加简洁且易于维护。

处理非平凡可复制类型

对于包含const成员或非平凡可复制的类型，Quill 8.0.0及以上版本需要使用DeferredFormatCodec：

template <>
struct quill::Codec<Option> : quill::DeferredFormatCodec<Option>
{
};

这种方式适用于任何类型，包括那些不能通过简单内存拷贝的类型。

通用解决方案

对于需要为多个类型实现格式化的情况，可以使用SFINAE和模板特化：

template <typename T>
struct fmt::formatter<T, std::enable_if_t<std::is_base_of<Formatable, T>::value, char>>
{
  // 实现通用的parse和format方法
};

template <typename T>
struct quill::Codec<T, std::enable_if_t<std::is_base_of<Formatable, T>::value>>
  : quill::DeferredFormatCodec<T>
{
};

template <typename T>
struct fmtquill::formatter<T, std::enable_if_t<std::is_base_of<Formatable, T>::value, char>>
  : fmt::formatter<T>
{
};

这种方法可以为所有继承自Formatable标记接口的类型自动提供格式化支持。

性能考虑

需要注意的是，使用DeferredFormatCodec会比TriviallyCopyableTypeCodec有轻微的性能开销，因为它需要在日志记录时进行格式化，而不是在日志后台线程中处理。对于性能敏感的场景，建议：

1. 尽可能使类型平凡可复制
2. 在热路径上考虑预格式化字符串
3. 仅在必要时使用DeferredFormatCodec

总结

在Quill中复用自定义类型的fmt::formatter实现需要特别注意命名空间的问题。通过模板继承或宏定义可以有效地解决这个问题。对于不同类型的特性（平凡可复制与否），Quill提供了不同的Codec实现策略。理解这些技术细节可以帮助开发者更高效地在Quill中记录自定义类型的日志信息。

在实际项目中，建议根据具体需求选择最适合的方案，平衡代码的可维护性和性能要求。对于大型项目，通用解决方案可以显著减少重复代码；而对于性能关键的应用，则需要仔细评估不同方案的开销。