在yyjson中处理包含NUL字符的JSON键名

背景介绍

yyjson是一个高性能的JSON库，但在处理包含NUL字符('\0')的键名时会遇到问题。JSON规范允许字符串中包含NUL字符，但C语言中字符串以NUL字符作为结束符，这导致使用标准字符串函数处理时会截断数据。

问题分析

当尝试创建类似{"\u0000hi":"\u0001"}这样的JSON时，标准API如yyjson_mut_obj_add_func会使用strlen()获取键长度，遇到NUL字符会提前终止，导致无法正确添加包含NUL字符的键。

解决方案

yyjson提供了更底层的API来解决这个问题：

yyjson_mut_obj_add(obj, yyjson_mut_strn(doc, key, key_len), val);

这种方法的核心优势在于：

1. 使用yyjson_mut_strn()显式指定键的长度，避免依赖NUL终止符
2. 保持API简洁，不需要新增大量函数
3. 完全兼容现有的JSON规范

实现原理

yyjson_mut_strn()函数允许开发者显式指定字符串长度，而yyjson_mut_obj_add()则接受预创建的字符串值作为键。这种组合方式既解决了NUL字符问题，又保持了API的灵活性。

最佳实践

对于需要处理可能包含特殊字符的JSON键时，建议：

1. 始终记录键的实际长度
2. 优先使用yyjson_mut_strn()而非yyjson_mut_str()
3. 在不确定字符串内容时，使用显式长度参数

总结

yyjson通过提供底层API组合的方式，巧妙地解决了JSON键中包含NUL字符的问题。这种设计既保持了API的简洁性，又提供了处理特殊情况的灵活性，体现了优秀库设计的思想。开发者应理解这种设计模式，以便更好地处理JSON中的边缘情况。