Table of Contents
Introduction
特点
教程
Pointer
流
编码
DOM
SAX
Schema
性能
Internals
常见问题
1.1
1.2
1.3
1.4
1.5
1.6
1.7
1.8
1.9
1.10
1.11
1.12
1
Introduction
高效的 C++ JSON 解析/生成器,提供 SAX 及 DOM 风格 API
Tencent is pleased to support the open source community by making RapidJSON available.
Copyright (C) 2015 THL A29 Limited, a Tencent company, and Milo Yip. All rights reserved.
RapidJSON GitHub
RapidJSON 文档
English
简体中文
GitBook 可下载 PDF/EPUB/MOBI,但不含 API 参考手册。
Build 状态
Linux
Windows
Coveralls
简介
RapidJSON 是一个 C++ 的 JSON 解析器及生成器。它的灵感来自 RapidXml。
RapidJSON 小而全。它同时支持 SAX 和 DOM 风格的 API。SAX 解析器只有约 500 行代码。
RapidJSON 快。它的性能可与 strlen() 相比。可支持 SSE2/SSE4.2 加速。
RapidJSON 独立。它不依赖于 BOOST 等外部库。它甚至不依赖于 STL。
RapidJSON 对内存友好。在大部分 32/64 位机器上,每个 JSON 值只占 16 字节(除字符串外)。它
预设使用一个快速的内存分配器,令分析器可以紧凑地分配内存。
RapidJSON 对 Unicode 友好。它支持 UTF-8、UTF-16、UTF-32 (大端序/小端序),并内部支持这些
编码的检测、校验及转码。例如,RapidJSON 可以在分析一个 UTF-8 文件至 DOM 时,把当中的
JSON 字符串转码至 UTF-16。它也支持代理对(surrogate pair)及 "\u0000" (空字符)。
在 这里 可读取更多特点。
JSON(JavaScript Object Notation)是一个轻量的数据交换格式。RapidJSON 应该完全遵从
RFC7159/ECMA-404,并支持可选的放宽语法。 关于 JSON 的更多信息可参考:
Introducing JSON
RFC7159: The JavaScript Object Notation (JSON) Data Interchange Format
Standard ECMA-404: The JSON Data Interchange Format
v1.1 中的亮点 (2016-8-25)
2
Introduction
加入 JSON Pointer 功能,可更简单地访问及更改 DOM。
加入 JSON Schema 功能,可在解析或生成 JSON 时进行校验。
加入 放宽的 JSON 语法 (注释、尾随逗号、NaN/Infinity)
使用 C++11 范围 for 循环 去遍历 array 和 object。
在 x86-64 架构下,缩减每个 Value 的内存开销从 24 字节至 16 字节。
其他改动请参考 change log.
兼容性
RapidJSON 是跨平台的。以下是一些曾测试的平台/编译器组合:
Visual C++ 2008/2010/2013 在 Windows (32/64-bit)
GNU C++ 3.8.x 在 Cygwin
Clang 3.4 在 Mac OS X (32/64-bit) 及 iOS
Clang 3.4 在 Android NDK
用户也可以在他们的平台上生成及执行单元测试。
安装
RapidJSON 是只有头文件的 C++ 库。只需把 include/rapidjson 目录复制至系统或项目的 include 目
录中。
RapidJSON 依赖于以下软件:
CMake 作为通用生成工具
(optional)Doxygen 用于生成文档
(optional)googletest 用于单元及性能测试
生成测试及例子的步骤:
1. 执行 git submodule update --init 去获取 thirdparty submodules (google test)。
2. 在 rapidjson 目渌下,建立一个 build 目录。
3. 在 build 目录下执行 cmake .. 命令以设置生成。Windows 用户可使用 cmake-gui 应用程序。
4. 在 Windows 下,编译生成在 build 目录中的 solution。在 Linux 下,于 build 目录运行 make 。
成功生成后,你会在 bin 的目录下找到编译后的测试及例子可执行文件。而生成的文档将位于 build 下的
doc/html 目录。要执行测试,请在 build 下执行 make test 或 ctest 。使用 ctest -V 命令可获
取详细的输出。
我们也可以把程序库安装至全系统中,只要在具管理權限下从 build 目录执行 make install 命令。这样
会按系统的偏好设置安装所有文件。当安装 RapidJSON 后,其他的 CMake 项目需要使用它时,可以通过
在 CMakeLists.txt 加入一句 find_package(RapidJSON) 。
用法一览
此简单例子解析一个 JSON 字符串至一个 document (DOM),对 DOM 作出简单修改,最终把 DOM 转换
(stringify)至 JSON 字符串。
3
Introduction
// rapidjson/example/simpledom/simpledom.cpp`
#include "rapidjson/document.h"
#include "rapidjson/writer.h"
#include "rapidjson/stringbuffer.h"
#include
using namespace rapidjson;
int main() {
// 1. 把 JSON 解析至 DOM。
const char* json = "{\"project\":\"rapidjson\",\"stars\":10}";
Document d;
d.Parse(json);
// 2. 利用 DOM 作出修改。
Value& s = d["stars"];
s.SetInt(s.GetInt() + 1);
// 3. 把 DOM 转换(stringify)成 JSON。
StringBuffer buffer;
Writer writer(buffer);
d.Accept(writer);
// Output {"project":"rapidjson","stars":11}
std::cout << buffer.GetString() << std::endl;
return 0;
}
注意此例子并没有处理潜在错误。
下图展示执行过程。
4
Introduction
还有许多 例子 可供参考:
DOM API
tutorial: DOM API 的基本使用方法。
SAX API
simplereader: 使用 Reader 解析 JSON 时,打印所有 SAX 事件。
condense: 移除 JSON 中所有空白符的命令行工具。
pretty: 为 JSON 加入缩进与换行的命令行工具,当中使用了 PrettyWriter 。
capitalize: 把 JSON 中所有字符串改为大写的命令行工具。
messagereader: 使用 SAX API 去解析一个 JSON 报文。
serialize: 使用 SAX API 去序列化 C++ 对象,生成 JSON。
jsonx: 实现了一个 JsonxWriter ,它能把 SAX 事件写成 JSONx(一种 XML)格式。这个例子
是把 JSON 输入转换成 JSONx 格式的命令行工具。
Schema API
schemavalidator: 使用 JSON Schema 去校验 JSON 的命令行工具。
进阶
prettyauto: pretty 的修改版本,可自动处理任何 UTF 编码的 JSON。
parsebyparts: 这例子中的 AsyncDocumentParser 类使用 C++ 线程来逐段解析 JSON。
filterkey: 移取使用者指定的键值的命令行工具。
5
Introduction
filterkeydom: 如上的工具,但展示如何使用生成器(generator)去填充一个 Document 。
6
特点
特点
总体
跨平台
编译器:Visual Studio、gcc、clang 等
架构:x86、x64、ARM 等
操作系统:Windows、Mac OS X、Linux、iOS、Android 等
容易安装
只有头文件的库。只需把头文件复制至你的项目中。
独立、最小依赖
不需依赖 STL、BOOST 等。
只包含 , , , , , 。
没使用 C++ 异常、RTTI
高性能
使用模版及内联函数去降低函数调用开销。
内部经优化的 Grisu2 及浮点数解析实现。
可选的 SSE2/SSE4.2 支持。
符合标准
RapidJSON 应完全符合 RFC4627/ECMA-404 标准。
支持 JSON Pointer (RFC6901).
支持 JSON Schema Draft v4.
支持 Unicod 代理对(surrogate pair)。
支持空字符( "\u0000" )。
例如,可以优雅地解析及处理 ["Hello\u0000World"] 。含读写字符串长度的 API。
支持可选的放宽语法
单行( // ... )及多行( /* ... */ ) 注释 ( kParseCommentsFlag )。
在对象和数组结束前含逗号 ( kParseTrailingCommasFlag )。
NaN 、 Inf 、 Infinity 、 -Inf 及 -Infinity 作为 double 值
( kParseNanAndInfFlag )
NPM 兼容.
Unicode
支持 UTF-8、UTF-16、UTF-32 编码,包括小端序和大端序。
这些编码用于输入输出流,以及内存中的表示。
支持从输入流自动检测编码。
内部支持编码的转换。
例如,你可以读取一个 UTF-8 文件,让 RapidJSON 把 JSON 字符串转换至 UTF-16 的 DOM。
内部支持编码校验。
例如,你可以读取一个 UTF-8 文件,让 RapidJSON 检查是否所有 JSON 字符串是合法的 UTF-8
7
特点
字节序列。
支持自定义的字符类型。
预设的字符类型是:UTF-8 为 char ,UTF-16 为 wchar_t ,UTF32 为 uint32_t 。
支持自定义的编码。
API 风格
SAX(Simple API for XML)风格 API
类似于 SAX, RapidJSON 提供一个事件循序访问的解析器
API( rapidjson::GenericReader )。RapidJSON 也提供一个生成器
API( rapidjson::Writer ),可以处理相同的事件集合。
DOM(Document Object Model)风格 API
类似于 HTML/XML 的 DOM,RapidJSON 可把 JSON 解析至一个 DOM 表示方式
( rapidjson::GenericDocument ),以方便操作。如有需要,可把 DOM 转换(stringify)回
JSON。
DOM 风格 API( rapidjson::GenericDocument )实际上是由 SAX 风格
API( rapidjson::GenericReader )实现的。SAX 更快,但有时 DOM 更易用。用户可根据情
况作出选择。
解析
递归式(预设)及迭代式解析器
递归式解析器较快,但在极端情况下可出现堆栈溢出。
迭代式解析器使用自定义的堆栈去维持解析状态。
支持原位(in situ)解析。
把 JSON 字符串的值解析至原 JSON 之中,然后让 DOM 指向那些字符串。
比常规分析更快:不需字符串的内存分配、不需复制(如字符串不含转义符)、缓存友好。
对于 JSON 数字类型,支持 32-bit/64-bit 的有号/无号整数,以及 double 。
错误处理
支持详尽的解析错误代号。
支持本地化错误信息。
DOM (Document)
RapidJSON 在类型转换时会检查数值的范围。
字符串字面量的优化
只储存指针,不作复制
优化“短”字符串
在 Value 内储存短字符串,无需额外分配。
对 UTF-8 字符串来说,32 位架构下可存储最多 11 字符,64 位下 21 字符(x86-64 下 13 字
符)。
可选地支持 std::string (定义 RAPIDJSON_HAS_STDSTRING=1 )
生成
8