<img src="https://yellow-cdn.veclightyear.com/ab5030c0/e7426cef-3a69-44b7-a484-01d8fabca8ad.png" alt="{fmt}" width="25%"/>

**{fmt}**是一个开源格式化库，为C stdio和C++ iostreams提供了快速且安全的替代方案。

如果您喜欢这个项目，请考虑向帮助乌克兰战争受害者的基金捐款：https://www.stopputin.net/。

文档

速查表

问答：在StackOverflow上使用fmt标签提问。

在Compiler Explorer中试用{fmt}。

特性

• 简单的格式API，支持本地化的位置参数
• 实现了C++20 std::format和C++23 std::print
• 格式字符串语法类似于Python的format
• 使用Dragonbox算法的快速IEEE 754浮点格式化器，具有正确舍入、简洁性和往返保证
• 可移植的Unicode支持
• 安全的printf实现，包括POSIX扩展的位置参数
• 可扩展性：支持用户自定义类型
• 高性能：比常见的标准库实现如(s)printf、iostreams、to_string和to_chars更快，参见速度测试和每秒将一亿个整数转换为字符串
• 源代码和编译后代码的体积小：最小配置仅包含三个文件，core.h、format.h和format-inl.h；参见编译时间和代码膨胀
• 可靠性：库有广泛的测试集，并且持续进行模糊测试
• 安全性：库完全类型安全，格式字符串中的错误可在编译时报告，自动内存管理防止缓冲区溢出错误
• 易用性：小型独立代码库，无外部依赖，宽松的MIT许可证
• 可移植性，跨平台输出一致，支持旧编译器
• 即使在高警告级别（如-Wall -Wextra -pedantic）下也无警告的干净代码库
• 默认情况下独立于区域设置
• 可选的仅头文件配置，通过FMT_HEADER_ONLY宏启用

更多详情请参阅文档。

示例

打印到标准输出 (运行)

#include <fmt/core.h>

int main() {
  fmt::print("Hello, world!\n");
}

格式化字符串 (运行)

std::string s = fmt::format("The answer is {}.", 42);
// s == "The answer is 42."

使用位置参数格式化字符串 (运行)

std::string s = fmt::format("I'd rather be {1} than {0}.", "right", "happy");
// s == "I'd rather be happy than right."

打印日期和时间 (运行)

#include <fmt/chrono.h>

int main() {
  auto now = std::chrono::system_clock::now();
  fmt::print("Date and time: {}\n", now);
  fmt::print("Time: {:%H:%M}\n", now);
}

输出：

Date and time: 2023-12-26 19:10:31.557195597
Time: 19:10

打印容器 (运行)

#include <vector>
#include <fmt/ranges.h>

int main() {
  std::vector<int> v = {1, 2, 3};
  fmt::print("{}\n", v);
}

输出：

[1, 2, 3]

在编译时检查格式字符串

std::string s = fmt::format("{:d}", "I am not a number");

在C++20中，这会产生编译时错误，因为d对字符串来说是无效的格式说明符。

从单线程写入文件

#include <fmt/os.h>

int main() {
  auto out = fmt::output_file("guide.txt");
  out.print("Don't {}", "Panic");
}

这可能比fprintf快5到9倍。

使用颜色和文本样式打印

#include <fmt/color.h>

int main() {
  fmt::print(fg(fmt::color::crimson) | fmt::emphasis::bold,
             "Hello, {}!\n", "world");
  fmt::print(fg(fmt::color::floral_white) | bg(fmt::color::slate_gray) |
             fmt::emphasis::underline, "Olá, {}!\n", "Mundo");
  fmt::print(fg(fmt::color::steel_blue) | fmt::emphasis::italic,
             "你好{}！\n", "世界");
}

在支持Unicode的现代终端上的输出：

基准测试

速度测试

库	方法	运行时间，秒
libc	printf	0.91
libc++	std::ostream	2.49
{fmt} 9.1	fmt::print	0.74
Boost Format 1.80	boost::format	6.26
Folly Format	folly::format	1.87

在基准测试的方法中，{fmt}是最快的，比printf快约20%。 上述结果是通过在 macOS 12.6.1 上使用 clang++ -O3 -DNDEBUG -DSPEED_TEST -DHAVE_FORMAT 构建 tinyformat_test.cpp 并取三次运行中的最佳结果得出的。在测试中，格式字符串 "%0.10f:%04d:%+g:%s:%p:%c:%%\n" 或等效格式被填充 2,000,000 次，输出发送到 /dev/null；更多详情请参考源代码。

在 IEEE754 float 和 double 格式化方面，{fmt} 比 std::ostringstream 和 sprintf 快 20-30 倍（dtoa-benchmark），并且比 double-conversion 和 ryu 更快：

[图片]

编译时间和代码膨胀

format-benchmark 中的脚本 bloat-test.py 测试了非平凡项目的编译时间和代码膨胀。它生成 100 个翻译单元，每个单元中使用 printf() 或其替代品五次，以模拟中等规模的项目。结果可执行文件大小和编译时间（使用 Apple clang 版本 15.0.0 (clang-1500.1.0.2.5)，macOS Sonoma，取三次中的最佳结果）如下表所示。

优化构建 (-O3)

方法	编译时间，秒	可执行文件大小，KiB	剥离后大小，KiB
printf	1.6	54	50
IOStreams	25.9	98	84
fmt 83652df	4.8	54	50
tinyformat	29.1	161	136
Boost Format	55.0	530	317

{fmt} 编译速度快，在每次调用的二进制大小方面与 printf 相当（在此系统上误差在四舍五入范围内）。

非优化构建

方法	编译时间，秒	可执行文件大小，KiB	剥离后大小，KiB
printf	1.4	54	50
IOStreams	23.4	92	68
{fmt} 83652df	4.4	89	85
tinyformat	24.5	204	161
Boost Format	36.4	831	462

libc、lib(std)c++ 和 libfmt 都作为共享库链接，以仅比较格式化函数的开销。Boost Format 是一个仅头文件的库，因此不提供任何链接选项。

运行测试

关于如何构建库和运行单元测试的说明，请参阅从源代码构建。

基准测试位于单独的仓库 format-benchmarks 中，因此要运行基准测试，您首先需要克隆此仓库并使用 CMake 生成 Makefiles：

$ git clone --recursive https://github.com/fmtlib/format-benchmark.git
$ cd format-benchmark
$ cmake .

然后您可以运行速度测试：

$ make speed-test

或膨胀测试：

$ make bloat-test

代码迁移

clang-tidy v18 提供了 modernize-use-std-print 检查，如果配置为这样做，它能够将 printf 和 fprintf 的出现转换为 fmt::print。（默认情况下，它转换为 std::print。）

使用此库的著名项目

• 0 A.D.：一款免费、开源、跨平台的即时战略游戏
• AMPL/MP：一个用于数学规划的开源库
• Apple的FoundationDB：一个开源的分布式事务型键值存储
• Aseprite：动画精灵编辑器和像素艺术工具
• AvioBook：一套全面的飞机操作套件
• 暴雪战网：一个在线游戏平台
• Celestia：太空实时3D可视化
• Ceph：一个可扩展的分布式存储系统
• ccache：一个编译器缓存
• ClickHouse：一个分析型数据库管理系统
• Contour：一个现代终端模拟器
• CUAUV：康奈尔大学的自主水下航行器
• Drake：非线性动力系统的规划、控制和分析工具箱（麻省理工学院）
• Envoy：C++编写的L7代理和通信总线（Lyft）
• FiveM：GTA V的修改框架
• fmtlog：一个高性能的fmtlib风格日志库，延迟在纳秒级
• Folly：Facebook开源库
• GemRB：Bioware的无限引擎的可移植开源实现
• Grand Mountain Adventure：一款美丽的开放世界滑雪和单板滑雪游戏
• HarpyWar/pvpgn：玩家对战游戏网络，带有优化
• KBEngine：一个开源的MMOG服务器引擎
• Keypirinha：Windows的语义启动器
• Kodi（前身为xbmc）：家庭影院软件
• Knuth：高性能比特币全节点
• libunicode：一个现代C++17 Unicode库
• MariaDB：关系数据库管理系统
• Microsoft Verona：并发所有权研究编程语言
• MongoDB：分布式文档数据库
• MongoDB Smasher：生成随机数据集的小工具
• OpenSpace：一个开源的天体可视化框架
• PenUltima Online (POL)：一个MMO服务器，兼容大多数Ultima Online客户端
• PyTorch：一个开源机器学习库
• quasardb：一个分布式、高性能的关联数据库
• Quill：异步低延迟日志库
• QKW：通过别名简化导航，执行复杂的多行终端命令序列
• redis-cerberus：Redis集群代理
• redpanda：用C++编写的比Kafka®快10倍的关键任务系统替代品
• rpclib：现代C++ msgpack-RPC服务器和客户端库
• Salesforce Analytics Cloud：商业智能软件
• Scylla：兼容Cassandra的NoSQL数据存储，单服务器可处理每秒100万事务
• Seastar：用于现代硬件上高性能服务器应用的先进开源C++框架
• spdlog：超快的C++日志库
• Stellar：金融平台
• Touch Surgery：手术模拟器
• TrinityCore：开源MMORPG框架
• 🐙 userver框架：具有丰富抽象和数据库驱动程序的开源异步框架
• Windows Terminal：新的Windows终端

更多...

如果您知道其他使用本库的项目，请通过电子邮件或提交issue告诉我。

动机

那么为什么还要开发另一个格式化库呢？

有很多方法可以完成这个任务，从标准方法如printf系列函数和iostreams到Boost Format和FastFormat库。创建新库的原因是我发现的每个现有解决方案要么存在严重问题，要么无法提供我需要的所有功能。

printf

printf的优点是速度快，作为C标准库的一部分，随时可用。主要缺点是不支持用户定义类型。printf还有安全问题，尽管在GCC中通过attribute ((format (printf, ...)))在某种程度上得到了缓解。有一个POSIX扩展为printf添加了i18n所需的位置参数，但它不是C99的一部分，可能在某些平台上不可用。

iostreams

iostreams的主要问题最好用一个例子来说明：

std::cout << std::setprecision(2) << std::fixed << 1.23456 << "\n";

与printf相比，这需要大量输入：

printf("%.2f\n", 1.23456);

FastFormat的作者Matthew Wilson称之为"尖括号地狱"。iostreams在设计上不支持位置参数。

好处是iostreams支持用户定义类型，并且安全，尽管错误处理很笨拙。

Boost Format

这是一个非常强大的库，支持类似printf的格式字符串和位置参数。它的主要缺点是性能。根据各种基准测试，它比这里考虑的其他方法慢得多。Boost Format还有过长的构建时间和严重的代码膨胀问题（见基准测试）。

FastFormat

这是一个有趣的库，速度快、安全，并且有位置参数。然而，它有重大限制，引用其作者的话：

三个在当前设计中无法容纳的功能是：

• 前导零（或任何其他非空格填充）
• 八进制/十六进制编码
• 运行时宽度/对齐规范

它也相当大，并且严重依赖STLSoft，这可能对某些项目的使用过于限制。

Boost Spirit.Karma

这不是一个格式化库，但我决定在这里包含它以求完整。与iostreams一样，它存在将文字文本与参数混合的问题。该库相当快，但在Karma自己的基准测试中，整数格式化速度比使用格式字符串编译的fmt::format_to慢，参见每秒将一亿个整数转换为字符串。

许可证

{fmt}在MIT许可证下分发。

文档许可证

文档中的格式字符串语法部分基于Python 字符串模块文档中的内容。因此，文档在doc/python-license.txt中提供的Python软件基金会许可证下分发。它仅适用于分发{fmt}的文档。

维护者

{fmt}库由Victor Zverovich（vitaut）维护，并得到了许多其他人的贡献。部分贡献者和版本信息可以在贡献者和发布页面查看。如果您的贡献未被列出或提及有误，请告知我们，我们会进行修正。

安全政策

如需报告安全问题，请在安全公告页面披露。

本项目由志愿者团队在合理努力的基础上维护。因此，在公开披露之前，请给我们至少90天的时间来修复问题。