nlohmann/json 库中 Windows 平台下文件路径转 JSON 的 UTF-8 编码问题

在 nlohmann/json 这个流行的 C++ JSON 库中，存在一个与 Windows 平台文件系统路径处理相关的编码问题。当开发者尝试将 std::filesystem::path 对象转换为 JSON 时，在 Windows 平台上可能会遇到 UTF-8 编码异常。

问题背景

nlohmann/json 库内部规定所有字符串都必须以 UTF-8 编码存储。然而，在 Windows 平台上，std::filesystem::path::string() 方法返回的字符串并非 UTF-8 编码，而是使用当前系统的本地代码页（通常是 Windows-1252 编码）。这会导致当路径包含非 ASCII 字符时，转换后的 JSON 字符串包含无效的 UTF-8 字节序列。

典型的表现是，当路径中包含 Unicode 字符（如右单引号 U+2019）时，转换过程会产生 Windows-1252 编码的字节 \x92，而非正确的 UTF-8 编码 \xe2\x80\x99。当尝试 dump 这个 JSON 对象时，库会抛出 "invalid UTF-8 byte" 异常。

技术分析

Windows 平台的文件系统 API 传统上使用 UTF-16 编码。std::filesystem::path 在 Windows 上的实现底层也是基于宽字符（wchar_t）的 UTF-16 编码。当调用 string() 方法时，它会将 UTF-16 转换为当前系统的本地代码页，而不是 UTF-8。

C++17 引入了 u8string() 方法，专门用于获取 UTF-8 编码的路径字符串。但在 C++20 中，这个方法的行为有所改变，它现在返回 std::u8string 类型，这给跨版本兼容带来了挑战。

解决方案

经过社区讨论，提出了几种可能的解决方案：

1. 使用 Windows API 显式转换：通过 WideCharToMultiByte 函数将路径的本地编码显式转换为 UTF-8。这种方法直接有效，但引入了对 Windows.h 的依赖。

2. 使用 u8string() 方法：这是最简洁的解决方案，利用了 C++ 标准库提供的功能。在 C++17 中，u8string() 直接返回 UTF-8 编码的 std::string；在 C++20 中，需要将 std::u8string 转换为 std::string。

3. 文档说明：不修改代码，但在文档中明确说明 Windows 平台下的这一限制，让开发者自行处理编码转换。

最终，社区倾向于第二种方案，因为它：

• 不依赖平台特定 API
• 保持了代码的可移植性
• 符合 C++ 标准库的设计理念

实现细节

对于跨 C++17 和 C++20 的兼容实现，可以采用如下代码：

inline auto to_u8_string(const std::filesystem::path& p) -> std::string
{
#if CPP_STD_VERSION < 202002
    return p.u8string(); // C++17 直接返回 std::string
#else
    const std::u8string s = p.u8string();
    return std::string(s.begin(), s.end()); // C++20 需要转换
#endif
}

这个实现优雅地处理了不同 C++ 标准版本间的差异，确保了在所有情况下都能返回正确的 UTF-8 编码字符串。

对开发者的建议

对于正在使用 nlohmann/json 库的开发者，如果遇到类似问题，可以：

1. 等待库的官方修复
2. 临时使用自定义的转换函数
3. 在 Windows 应用程序清单中启用 UTF-8 代码页支持（需要 Windows 10 1903 或更高版本）

总结

文件系统路径的编码处理一直是跨平台开发的难点之一。nlohmann/json 库的这一问题凸显了 Windows 平台与其他平台在字符串编码处理上的差异。通过使用 C++ 标准库提供的 u8string() 方法，可以在保持代码简洁的同时解决编码问题，这体现了现代 C++ 在处理这类问题上的进步。