关于C++ JSON格式化的那点事儿,其实核心就几个关键点,很多人容易在细节上“翻车”。今天咱们就把它彻底说透。
目前最常用的方案,就是借助 nlohmann::json 这个库。它的 dump() 方法,可以说是集“格式化”与“输出”于一身,功能强大但用法也讲究。
用 nlohmann::json 的 dump() 控制缩进实现 Pretty Print
直接调用 dump() 并传入缩进宽度,这事儿其实很简单,也是最靠谱的做法。这个函数默认不换行、无缩进;但只要你传一个整数参数(比如 2),它就会自动启用带空格缩进的多行格式。
不少人会踩的坑是:以为要自己手动拼接换行符,或者找别的函数来搞定。其实 nlohmann::json 内部已经内置支持,压根不需要额外处理。
json_obj.dump()→ 单行紧凑格式,适合机器读json_obj.dump(2)→ 2 空格缩进,带换行和空格的可读格式,适合人看json_obj.dump(-1)→ 使用制表符缩进(注意:部分编辑器对混合空格/制表符渲染不一致,容易乱)- 缩进值为
0时,等效于不缩进(单行),但会保留键名引号和基本转义
写入文件前必须确保 std::ofstream 以文本模式打开且编码正确
这又是一个容易被忽略的细节。在 Windows 下,如果你用默认构造打开文件,可能会因为换行符(\r\n)被二次转换,导致 JSON 换行错乱。Linux/macOS 虽然对此不敏感,但跨平台项目还是得统一处理。
关键点:千万别用 std::ios::binary。它会禁用换行转换,但 JSON 是文本文件,不该用二进制模式写。同样,也不要依赖默认行为。
- 显式用
std::ofstream file("out.json");(文本模式,默认即可) - 写入前检查
file.is_open()和file.good() - 写入后调用
file.close(),或依赖 RAII 自动析构 - 注意:中文路径下,用窄字符流(
std::ofstream)会有问题。如需支持 Unicode 路径,应改用std::wofstream+std::locale,或使用 UTF-8 编码路径(C++20 的std::filesystem::u8path)
输出含中文的 JSON 时,nlohmann::json 默认转义 Unicode,需显式关闭
这也是一个让人头疼的“坑”。默认情况下,nlohmann::json 会把非 ASCII 字符(如中文)转成 \uXXXX 形式,导致文件内容直接“面目全非”。这不是 bug,而是 JSON 规范兼容性设计,但日常调试或配置文件中,我们通常需要看到原生 UTF-8 显示。
- 调用
dump(2, ' ', '\n', nlohmann::json::error_handler_t::replace)并不会影响中文显示,真正起作用的是第四个参数。 - 关键设置:
json_obj.dump(2, ' ', '\n', false)—— 第四个参数为false表示不转义非 ASCII 字符。 - 完整推荐写法:
file << json_obj.dump(2, ' ', '\n', false); - 注意:文件保存必须为 UTF-8 编码(现代编辑器默认如此),否则中文仍会乱码。
避免 std::endl 导致多余换行和性能损耗
最后,很多人习惯在写入 JSON 后加一句 file << std::endl;,这其实是个坏习惯。它会在文件末尾多出一个空行,破坏 JSON 有效性(严格来说,JSON 文本不应有尾随空白,部分解析器会报 parse error at 1:xxx)。
- 用
'\n'替代std::endl(std::endl= 写入\n+ 刷新缓冲区,没必要) dump()已包含结尾换行(当缩进 > 0 时),无需额外添加- 如果非要确保文件以换行结尾,可以检查
dump()输出末尾是否已有\n,再决定是否追加 —— 但更稳妥的做法是不做任何追加
最容易被忽略的,其实是中文转义控制和文件末尾换行这两个点。它们不报错,但会导致生成的 JSON 在人眼层面“看起来不对”,或者被某些严格解析器拒绝。只要记牢 dump(2, ' ', '\n', false) 这个调用组合,95% 的 Pretty Print 场景就稳了。