RapidJSON是什么?
RapidJSON是一个C++库,用于解析及生成JSON。读者可参考它的所有特点。
为什么称作RapidJSON?
它的灵感来自于RapidXML,RapidXML是一个高速的XML DOM解析器。
RapidJSON与RapidXML相似么?
RapidJSON借镜了RapidXML的一些设计, 包括原位(*in situ*)解析、只有头文件的库。但两者的API是完全不同的。此外RapidJSON也提供许多RapidXML没有的特点。
RapidJSON是免费的么?
是的,它在MIT特許條款下免费。它可用于商业软件。详情请参看license.txt。
RapidJSON很小么?它有何依赖?
是的。在Windows上,一个解析JSON并打印出统计的可执行文件少于30KB。
RapidJSON仅依赖于C++标准库。
怎样安装RapidJSON?
见安装一节。
RapidJSON能否运行于我的平台?
社区已在多个操作系统/编译器/CPU架构的组合上测试RapidJSON。但我们无法确保它能运行于你特定的平台上。只需要生成及执行单元测试便能获取答案。
RapidJSON支持C++03么?C++11呢?
RapidJSON开始时在C++03上实现。后来加入了可选的C++11特性支持(如转移构造函数、noexcept
)。RapidJSON应该兼容所有遵从C++03或C++11的编译器。
RapidJSON是否真的用于实际应用?
是的。它被配置于前台及后台的真实应用中。一个社区成员说RapidJSON在他们的系统中每日解析5千万个JSON。
RapidJSON是如何被测试的?
RapidJSON包含一组单元测试去执行自动测试。Travis(供Linux平台)及AppVeyor(供Windows平台)会对所有修改进行编译及执行单元测试。在Linux下还会使用Valgrind去检测内存泄漏。
RapidJSON是否有完整的文档?
RapidJSON提供了使用手册及API说明文档。
有没有其他替代品?
有许多替代品。例如nativejson-benchmark](https://github.com/miloyip/nativejson-benchmark)列出了一些开源的C/C++ JSON库。json.org也有一个列表。
什么是JSON?
JSON (JavaScript Object Notation)是一个轻量的数据交换格式。它使用人类可读的文本格式。更多关于JSON的细节可考RFC7159及ECMA-404。
JSON有什么应用场合?
JSON常用于网页应用程序,以传送结构化数据。它也可作为文件格式用于数据持久化。
RapidJSON是否符合JSON标准?
是。RapidJSON完全符合RFC7159及ECMA-404。它能处理一些特殊情况,例如支持JSON字符串中含有空字符及代理对(surrogate pair)。
RapidJSON是否支持宽松的语法?
现时不支持。RapidJSON只支持严格的标准格式。宽松语法现时在这issue中进行讨论。
什么是DOM风格API?
Document Object Model(DOM)是一个储存于内存的JSON表示方式,用于查询及修改JSON。
什么是SAX风格API?
SAX是一个事件驱动的API,用于解析及生成JSON。
我应用DOM还是SAX?
DOM易于查询及修改。SAX则是非常快及省内存的,但通常较难使用。
什么是原位(*in situ*)解析?
原位解析会把JSON字符串直接解码至输入的JSON中。这是一个优化,可减少内存消耗及提升性能,但输入的JSON会被更改。进一步细节请参考原位解析 。
什么时候会产生解析错误?
当输入的JSON包含非法语法,或不能表示一个值(如Number太大),或解析器的处理器中断解析过程,解析器都会产生一个错误。详情请参考解析错误。
有什么错误信息?
错误信息存储在ParseResult
,它包含错误代号及偏移值(从JSON开始至错误处的字符数目)。可以把错误代号翻译为人类可读的错误讯息。
为可不只使用double
去表示JSON number?
一些应用需要使用64位无号/有号整数。这些整数不能无损地转换成double
。因此解析器会检测一个JSON number是否能转换至各种整数类型及double
。
什么是转移语意?为什么?
Value
不用复制语意,而使用了转移语意。这是指,当把来源值赋值于目标值时,来源值的所有权会转移至目标值。
由于转移快于复制,此设计决定强迫使用者注意到复制的消耗。
怎样去复制一个值?
有两个API可用:含allocator的构造函数,以及CopyFrom()
。可参考深复制Value里的用例。
为什么我需要提供字符串的长度?
由于C字符串是空字符结尾的,需要使用strlen()
去计算其长度,这是线性复杂度的操作。若使用者已知字符串的长度,对很多操作来说会造成不必要的消耗。
此外,RapidJSON可处理含有\u0000
(空字符)的字符串。若一个字符串含有空字符,strlen()
便不能返回真正的字符串长度。在这种情况下使用者必须明确地提供字符串长度。
为什么在许多DOM操作API中要提供分配器作为参数?
由于这些API是Value
的成员函数,我们不希望为每个Value
储存一个分配器指针。
它会转换各种数值类型么?
当使用GetInt()
、GetUint()
等API时,可能会发生转换。对于整数至整数转换,仅当保证转换安全才会转换(否则会断言失败)。然而,当把一个64位有号/无号整数转换至double时,它会转换,但有可能会损失精度。含有小数的数字、或大于64位的整数,都只能使用GetDouble()
获取其值。
为什么不仅仅用printf
输出一个JSON?为什么需要Writer
?
最重要的是,Writer
能确保输出的JSON是格式正确的。错误地调用SAX事件(如StartObject()
错配EndArray()
)会造成断言失败。此外,Writer
会把字符串进行转义(如\n
)。最后,printf()
的数值输出可能并不是一个合法的JSON number,特别是某些locale会有数字分隔符。而且Writer
的数值字符串转换是使用非常快的算法来实现的,胜过printf()
及iostream
。
我能否暂停解析过程,并在稍后继续?
基于性能考虑,目前版本并不直接支持此功能。然而,若执行环境支持多线程,使用者可以在另一线程解析JSON,并通过阻塞输入流去暂停。
它是否支持UTF-8、UTF-16及其他格式?
是。它完全支持UTF-8、UTF-16(大端/小端)、UTF-32(大端/小端)及ASCII。
它能否检测编码的合法性?
能。只需把kParseValidateEncodingFlag
参考传给Parse()
。若发现在输入流中有非法的编码,它就会产生kParseErrorStringInvalidEncoding
错误。
什么是代理对(surrogate pair)?RapidJSON是否支持?
JSON使用UTF-16编码去转义Unicode字符,例如\u5927
表示中文字“大”。要处理基本多文种平面(basic multilingual plane,BMP)以外的字符时,UTF-16会把那些字符编码成两个16位值,这称为UTF-16代理对。例如,绘文字字符U+1F602在JSON中可被编码成\uD83D\uDE02
。
RapidJSON完全支持解析及生成UTF-16代理对。
它能否处理JSON字符串中的\u0000
(空字符)?
能。RapidJSON完全支持JSON字符串中的空字符。然而,使用者需要注意到这件事,并使用GetStringLength()
及相关API去取得字符串真正长度。
能否对所有非ASCII字符输出成\uxxxx
形式?
可以。只要在Writer
中使用ASCII<>
作为输出编码参数,就可以强逼转义那些字符。
我有一个很大的JSON文件。我应否把它整个载入内存中?
使用者可使用FileReadStream
去逐块读入文件。但若使用于原位解析,必须载入整个文件。
我能否解析一个从网络上串流进来的JSON?
可以。使用者可根据FileReadStream
的实现,去实现一个自定义的流。
我不知道一些JSON将会使用哪种编码。怎样处理它们?
你可以使用AutoUTFInputStream
,它能自动检测输入流的编码。然而,它会带来一些性能开销。
什么是BOM?RapidJSON怎样处理它?
字节顺序标记(byte order mark, BOM)有时会出现于文件/流的开始,以表示其UTF编码类型。
RapidJSON的EncodedInputStream
可检测/跳过BOM。EncodedOutputStream
可选择是否写入BOM。可参考编码流中的例子。
为什么会涉及大端/小端?
流的大端/小端是UTF-16及UTF-32流要处理的问题,而UTF-8不需要处理。
RapidJSON是否真的快?
是。它可能是最快的开源JSON库。有一个评测评估C/C++ JSON库的性能。
为什么它会快?
RapidJSON的许多设计是针对时间/空间性能来设计的,这些决定可能会影响API的易用性。此外,它也使用了许多底层优化(内部函数/intrinsic、SIMD)及特别的算法(自定义的double至字符串转换、字符串至double的转换)。
什是是SIMD?它如何用于RapidJSON?
SIMD指令可以在现代CPU中执行并行运算。RapidJSON支持了Intel的SSE2/SSE4.2去加速跳过空白字符。在解析含缩进的JSON时,这能提升性能。只要定义名为RAPIDJSON_SSE2
或RAPIDJSON_SSE42
的宏,就能启动这个功能。然而,若在不支持这些指令集的机器上执行这些可执行文件,会导致崩溃。
它会消耗许多内存么?
RapidJSON的设计目标是减低内存占用。
在SAX API中,Reader
消耗的内存与JSON树深度加上最长JSON字符成正比。
在DOM API中,每个Value
在32/64位架构下分别消耗16/24字节。RapidJSON也使用一个特殊的内存分配器去减少分配的额外开销。
高性能的意义何在?
有些应用程序需要处理非常大的JSON文件。而有些后台应用程序需要处理大量的JSON。达到高性能同时改善延时及吞吐量。更广义来说,这也可以节省能源。
谁是RapidJSON的开发者?
叶劲峰(Milo Yip,miloyip)是RapidJSON的原作者。全世界许多贡献者一直在改善RapidJSON。Philipp A. Hartmann(pah)实现了许多改进,也设置了自动化测试,而且还参与许多社区讨论。丁欧南(Don Ding,thebusytypist)实现了迭代式解析器。Andrii Senkovych(jollyroger)完成了向CMake的迁移。Kosta(Kosta-Github)提供了一个非常灵巧的短字符串优化。也需要感谢其他献者及社区成员。
为何你要开发RapidJSON?
在2011年开始这项目是,它仅一个兴趣项目。Milo Yip是一个游戏程序员,他在那时候认识到JSON并希望在未来的项目中使用。由于JSON好像很简单,他希望写一个仅有头文件并且快速的程序库。
为什么开发中段有一段长期空档?
主要是个人因素,例如加入新家庭成员。另外,Milo Yip也花了许多业馀时间去翻译Jason Gregory的《Game Engine Architecture》至中文版《游戏引擎架构》。
为什么这个项目从Google Code搬到GitHub?
这是大势所趋,而且GitHub更为强大及方便。