• Home
  • History
  • Annotate
Name Date Size #Lines LOC

..08-May-2020-

CMakeModules/H25-Aug-2016-3124

bin/H25-Aug-2016-10,1469,976

doc/H03-May-2022-11,7618,729

docker/debian/H25-Aug-2016-95

example/H03-May-2022-1,4931,080

include/rapidjson/H25-Aug-2016-15,1639,847

test/H03-May-2022-13,22210,406

thirdparty/gtest/H25-Aug-2016-

.gitattributesH A D25-Aug-2016450 2220

.gitignoreH A D25-Aug-2016349 2624

.gitmodulesH A D25-Aug-2016104 43

.travis.ymlH A D25-Aug-20163.4 KiB9992

CHANGELOG.mdH A D25-Aug-20166.7 KiB159135

RapidJSON.pc.inH A D25-Aug-2016229 86

RapidJSONConfig.cmake.inH A D25-Aug-2016200 43

RapidJSONConfigVersion.cmake.inH A D25-Aug-2016469 119

appveyor.ymlH A D25-Aug-20161 KiB4236

library.jsonH A D25-Aug-2016313 1312

package.jsonH A D25-Aug-2016561 2524

rapidjson.autopkgH A D25-Aug-20163.2 KiB7564

readme.mdH A D25-Aug-20168.7 KiB161114

readme.zh-cn.mdH A D25-Aug-20168.5 KiB152106

travis-doxygen.shH A D25-Aug-20163.2 KiB12384

readme.md

1![](doc/logo/rapidjson.png)
2
3![](https://img.shields.io/badge/release-v1.1.0-blue.png)
4
5## A fast JSON parser/generator for C++ with both SAX/DOM style API
6
7Tencent is pleased to support the open source community by making RapidJSON available.
8
9Copyright (C) 2015 THL A29 Limited, a Tencent company, and Milo Yip. All rights reserved.
10
11* [RapidJSON GitHub](https://github.com/miloyip/rapidjson/)
12* RapidJSON Documentation
13  * [English](http://rapidjson.org/)
14  * [简体中文](http://rapidjson.org/zh-cn/)
15  * [GitBook](https://www.gitbook.com/book/miloyip/rapidjson/) with downloadable PDF/EPUB/MOBI, without API reference.
16
17## Build status
18
19| [Linux][lin-link] | [Windows][win-link] | [Coveralls][cov-link] |
20| :---------------: | :-----------------: | :-------------------: |
21| ![lin-badge]      | ![win-badge]        | ![cov-badge]          |
22
23[lin-badge]: https://travis-ci.org/miloyip/rapidjson.png?branch=master "Travis build status"
24[lin-link]:  https://travis-ci.org/miloyip/rapidjson "Travis build status"
25[win-badge]: https://ci.appveyor.com/api/projects/status/u658dcuwxo14a8m9/branch/master "AppVeyor build status"
26[win-link]:  https://ci.appveyor.com/project/miloyip/rapidjson/branch/master "AppVeyor build status"
27[cov-badge]: https://coveralls.io/repos/miloyip/rapidjson/badge.png?branch=master
28[cov-link]:  https://coveralls.io/r/miloyip/rapidjson?branch=master
29
30## Introduction
31
32RapidJSON is a JSON parser and generator for C++. It was inspired by [RapidXml](http://rapidxml.sourceforge.net/).
33
34* RapidJSON is **small** but **complete**. It supports both SAX and DOM style API. The SAX parser is only a half thousand lines of code.
35
36* RapidJSON is **fast**. Its performance can be comparable to `strlen()`. It also optionally supports SSE2/SSE4.2 for acceleration.
37
38* RapidJSON is **self-contained** and **header-only**. It does not depend on external libraries such as BOOST. It even does not depend on STL.
39
40* RapidJSON is **memory-friendly**. Each JSON value occupies exactly 16 bytes for most 32/64-bit machines (excluding text string). By default it uses a fast memory allocator, and the parser allocates memory compactly during parsing.
41
42* RapidJSON is **Unicode-friendly**. It supports UTF-8, UTF-16, UTF-32 (LE & BE), and their detection, validation and transcoding internally. For example, you can read a UTF-8 file and let RapidJSON transcode the JSON strings into UTF-16 in the DOM. It also supports surrogates and "\u0000" (null character).
43
44More features can be read [here](doc/features.md).
45
46JSON(JavaScript Object Notation) is a light-weight data exchange format. RapidJSON should be in fully compliance with RFC7159/ECMA-404, with optional support of relaxed syntax. More information about JSON can be obtained at
47* [Introducing JSON](http://json.org/)
48* [RFC7159: The JavaScript Object Notation (JSON) Data Interchange Format](http://www.ietf.org/rfc/rfc7159.txt)
49* [Standard ECMA-404: The JSON Data Interchange Format](http://www.ecma-international.org/publications/standards/Ecma-404.htm)
50
51## Highlights in v1.1 (2016-8-25)
52
53* Added [JSON Pointer](doc/pointer.md)
54* Added [JSON Schema](doc/schema.md)
55* Added [relaxed JSON syntax](doc/dom.md) (comment, trailing comma, NaN/Infinity)
56* Iterating array/object with [C++11 Range-based for loop](doc/tutorial.md)
57* Reduce memory overhead of each `Value` from 24 bytes to 16 bytes in x86-64 architecture.
58
59For other changes please refer to [change log](CHANGELOG.md).
60
61## Compatibility
62
63RapidJSON is cross-platform. Some platform/compiler combinations which have been tested are shown as follows.
64* Visual C++ 2008/2010/2013 on Windows (32/64-bit)
65* GNU C++ 3.8.x on Cygwin
66* Clang 3.4 on Mac OS X (32/64-bit) and iOS
67* Clang 3.4 on Android NDK
68
69Users can build and run the unit tests on their platform/compiler.
70
71## Installation
72
73RapidJSON is a header-only C++ library. Just copy the `include/rapidjson` folder to system or project's include path.
74
75RapidJSON uses following software as its dependencies:
76* [CMake](https://cmake.org/) as a general build tool
77* (optional)[Doxygen](http://www.doxygen.org) to build documentation
78* (optional)[googletest](https://github.com/google/googletest) for unit and performance testing
79
80To generate user documentation and run tests please proceed with the steps below:
81
821. Execute `git submodule update --init` to get the files of thirdparty submodules (google test).
832. Create directory called `build` in rapidjson source directory.
843. Change to `build` directory and run `cmake ..` command to configure your build. Windows users can do the same with cmake-gui application.
854. On Windows, build the solution found in the build directory. On Linux, run `make` from the build directory.
86
87On successfull build you will find compiled test and example binaries in `bin`
88directory. The generated documentation will be available in `doc/html`
89directory of the build tree. To run tests after finished build please run `make
90test` or `ctest` from your build tree. You can get detailed output using `ctest
91-V` command.
92
93It is possible to install library system-wide by running `make install` command
94from the build tree with administrative privileges. This will install all files
95according to system preferences.  Once RapidJSON is installed, it is possible
96to use it from other CMake projects by adding `find_package(RapidJSON)` line to
97your CMakeLists.txt.
98
99## Usage at a glance
100
101This simple example parses a JSON string into a document (DOM), make a simple modification of the DOM, and finally stringify the DOM to a JSON string.
102
103~~~~~~~~~~cpp
104// rapidjson/example/simpledom/simpledom.cpp`
105#include "rapidjson/document.h"
106#include "rapidjson/writer.h"
107#include "rapidjson/stringbuffer.h"
108#include <iostream>
109
110using namespace rapidjson;
111
112int main() {
113    // 1. Parse a JSON string into DOM.
114    const char* json = "{\"project\":\"rapidjson\",\"stars\":10}";
115    Document d;
116    d.Parse(json);
117
118    // 2. Modify it by DOM.
119    Value& s = d["stars"];
120    s.SetInt(s.GetInt() + 1);
121
122    // 3. Stringify the DOM
123    StringBuffer buffer;
124    Writer<StringBuffer> writer(buffer);
125    d.Accept(writer);
126
127    // Output {"project":"rapidjson","stars":11}
128    std::cout << buffer.GetString() << std::endl;
129    return 0;
130}
131~~~~~~~~~~
132
133Note that this example did not handle potential errors.
134
135The following diagram shows the process.
136
137![simpledom](doc/diagram/simpledom.png)
138
139More [examples](https://github.com/miloyip/rapidjson/tree/master/example) are available:
140
141* DOM API
142 * [tutorial](https://github.com/miloyip/rapidjson/blob/master/example/tutorial/tutorial.cpp): Basic usage of DOM API.
143
144* SAX API
145 * [simplereader](https://github.com/miloyip/rapidjson/blob/master/example/simplereader/simplereader.cpp): Dumps all SAX events while parsing a JSON by `Reader`.
146 * [condense](https://github.com/miloyip/rapidjson/blob/master/example/condense/condense.cpp): A command line tool to rewrite a JSON, with all whitespaces removed.
147 * [pretty](https://github.com/miloyip/rapidjson/blob/master/example/pretty/pretty.cpp): A command line tool to rewrite a JSON with indents and newlines by `PrettyWriter`.
148 * [capitalize](https://github.com/miloyip/rapidjson/blob/master/example/capitalize/capitalize.cpp): A command line tool to capitalize strings in JSON.
149 * [messagereader](https://github.com/miloyip/rapidjson/blob/master/example/messagereader/messagereader.cpp): Parse a JSON message with SAX API.
150 * [serialize](https://github.com/miloyip/rapidjson/blob/master/example/serialize/serialize.cpp): Serialize a C++ object into JSON with SAX API.
151 * [jsonx](https://github.com/miloyip/rapidjson/blob/master/example/jsonx/jsonx.cpp): Implements a `JsonxWriter` which stringify SAX events into [JSONx](https://www-01.ibm.com/support/knowledgecenter/SS9H2Y_7.1.0/com.ibm.dp.doc/json_jsonx.html) (a kind of XML) format. The example is a command line tool which converts input JSON into JSONx format.
152
153* Schema
154 * [schemavalidator](https://github.com/miloyip/rapidjson/blob/master/example/schemavalidator/schemavalidator.cpp) : A command line tool to validate a JSON with a JSON schema.
155
156* Advanced
157 * [prettyauto](https://github.com/miloyip/rapidjson/blob/master/example/prettyauto/prettyauto.cpp): A modified version of [pretty](https://github.com/miloyip/rapidjson/blob/master/example/pretty/pretty.cpp) to automatically handle JSON with any UTF encodings.
158 * [parsebyparts](https://github.com/miloyip/rapidjson/blob/master/example/parsebyparts/parsebyparts.cpp): Implements an `AsyncDocumentParser` which can parse JSON in parts, using C++11 thread.
159 * [filterkey](https://github.com/miloyip/rapidjson/blob/master/example/filterkey/filterkey.cpp): A command line tool to remove all values with user-specified key.
160 * [filterkeydom](https://github.com/miloyip/rapidjson/blob/master/example/filterkeydom/filterkeydom.cpp): Same tool as above, but it demonstrates how to use a generator to populate a `Document`.
161

readme.zh-cn.md

1![](doc/logo/rapidjson.png)
2
3![](https://img.shields.io/badge/release-v1.1.0-blue.png)
4
5## 高效的 C++ JSON 解析/生成器,提供 SAX 及 DOM 风格 API
6
7Tencent is pleased to support the open source community by making RapidJSON available.
8
9Copyright (C) 2015 THL A29 Limited, a Tencent company, and Milo Yip. All rights reserved.
10
11* [RapidJSON GitHub](https://github.com/miloyip/rapidjson/)
12* RapidJSON 文档
13  * [English](http://rapidjson.org/)
14  * [简体中文](http://rapidjson.org/zh-cn/)
15  * [GitBook](https://www.gitbook.com/book/miloyip/rapidjson/) 可下载 PDF/EPUB/MOBI,但不含 API 参考手册。
16
17## Build 状态
18
19| [Linux][lin-link] | [Windows][win-link] | [Coveralls][cov-link] |
20| :---------------: | :-----------------: | :-------------------: |
21| ![lin-badge]      | ![win-badge]        | ![cov-badge]          |
22
23[lin-badge]: https://travis-ci.org/miloyip/rapidjson.png?branch=master "Travis build status"
24[lin-link]:  https://travis-ci.org/miloyip/rapidjson "Travis build status"
25[win-badge]: https://ci.appveyor.com/api/projects/status/u658dcuwxo14a8m9/branch/master "AppVeyor build status"
26[win-link]:  https://ci.appveyor.com/project/miloyip/rapidjson/branch/master "AppVeyor build status"
27[cov-badge]: https://coveralls.io/repos/miloyip/rapidjson/badge.png?branch=master
28[cov-link]:  https://coveralls.io/r/miloyip/rapidjson?branch=master
29
30## 简介
31
32RapidJSON 是一个 C++ 的 JSON 解析器及生成器。它的灵感来自 [RapidXml](http://rapidxml.sourceforge.net/)33
34* RapidJSON 小而全。它同时支持 SAX 和 DOM 风格的 API。SAX 解析器只有约 500 行代码。
35
36* RapidJSON 快。它的性能可与 `strlen()` 相比。可支持 SSE2/SSE4.2 加速。
37
38* RapidJSON 独立。它不依赖于 BOOST 等外部库。它甚至不依赖于 STL。
39
40* RapidJSON 对内存友好。在大部分 32/64 位机器上,每个 JSON 值只占 16 字节(除字符串外)。它预设使用一个快速的内存分配器,令分析器可以紧凑地分配内存。
41
42* RapidJSON 对 Unicode 友好。它支持 UTF-8、UTF-16、UTF-32 (大端序/小端序),并内部支持这些编码的检测、校验及转码。例如,RapidJSON 可以在分析一个 UTF-8 文件至 DOM 时,把当中的 JSON 字符串转码至 UTF-16。它也支持代理对(surrogate pair)及 `"\u0000"`(空字符)。
43
44在 [这里](doc/features.zh-cn.md) 可读取更多特点。
45
46JSON(JavaScript Object Notation)是一个轻量的数据交换格式。RapidJSON 应该完全遵从 RFC7159/ECMA-404,并支持可选的放宽语法。 关于 JSON 的更多信息可参考:
47* [Introducing JSON](http://json.org/)
48* [RFC7159: The JavaScript Object Notation (JSON) Data Interchange Format](http://www.ietf.org/rfc/rfc7159.txt)
49* [Standard ECMA-404: The JSON Data Interchange Format](http://www.ecma-international.org/publications/standards/Ecma-404.htm)
50
51## v1.1 中的亮点 (2016-8-25)
52
53* 加入 [JSON Pointer](doc/pointer.zh-cn.md) 功能,可更简单地访问及更改 DOM。
54* 加入 [JSON Schema](doc/schema.zh-cn.md) 功能,可在解析或生成 JSON 时进行校验。
55* 加入 [放宽的 JSON 语法](doc/dom.zh-cn.md) (注释、尾随逗号、NaN/Infinity56* 使用 [C++11 范围 for 循环](doc/tutorial.zh-cn.md) 去遍历 array 和 object。
57* 在 x86-64 架构下,缩减每个 `Value` 的内存开销从 24 字节至 16 字节。
58
59其他改动请参考 [change log](CHANGELOG.md).
60
61## 兼容性
62
63RapidJSON 是跨平台的。以下是一些曾测试的平台/编译器组合:
64* Visual C++ 2008/2010/2013 在 Windows (32/64-bit)
65* GNU C++ 3.8.x 在 Cygwin
66* Clang 3.4 在 Mac OS X (32/64-bit) 及 iOS
67* Clang 3.4 在 Android NDK
68
69用户也可以在他们的平台上生成及执行单元测试。
70
71## 安装
72
73RapidJSON 是只有头文件的 C++ 库。只需把 `include/rapidjson` 目录复制至系统或项目的 include 目录中。
74
75RapidJSON 依赖于以下软件:
76* [CMake](http://www.cmake.org) 作为通用生成工具
77* (optional)[Doxygen](http://www.doxygen.org) 用于生成文档
78* (optional)[googletest](https://code.google.com/p/googletest/) 用于单元及性能测试
79
80生成测试及例子的步骤:
81
821. 执行 `git submodule update --init` 去获取 thirdparty submodules (google test)。
832. 在 rapidjson 目渌下,建立一个 `build` 目录。
843. 在 `build` 目录下执行 `cmake ..` 命令以设置生成。Windows 用户可使用 cmake-gui 应用程序。
854. 在 Windows 下,编译生成在 build 目录中的 solution。在 Linux 下,于 build 目录运行 `make`。
86
87成功生成后,你会在 `bin` 的目录下找到编译后的测试及例子可执行文件。而生成的文档将位于 build 下的 `doc/html` 目录。要执行测试,请在 build 下执行 `make test` 或 `ctest`。使用 `ctest -V` 命令可获取详细的输出。
88
89我们也可以把程序库安装至全系统中,只要在具管理權限下从 build 目录执行 `make install` 命令。这样会按系统的偏好设置安装所有文件。当安装 RapidJSON 后,其他的 CMake 项目需要使用它时,可以通过在 `CMakeLists.txt` 加入一句 `find_package(RapidJSON)`。
90
91## 用法一览
92
93此简单例子解析一个 JSON 字符串至一个 document (DOM),对 DOM 作出简单修改,最终把 DOM 转换(stringify)至 JSON 字符串。
94
95~~~~~~~~~~cpp
96// rapidjson/example/simpledom/simpledom.cpp`
97#include "rapidjson/document.h"
98#include "rapidjson/writer.h"
99#include "rapidjson/stringbuffer.h"
100#include <iostream>
101
102using namespace rapidjson;
103
104int main() {
105    // 1. 把 JSON 解析至 DOM。
106    const char* json = "{\"project\":\"rapidjson\",\"stars\":10}";
107    Document d;
108    d.Parse(json);
109
110    // 2. 利用 DOM 作出修改。
111    Value& s = d["stars"];
112    s.SetInt(s.GetInt() + 1);
113
114    // 3. 把 DOM 转换(stringify)成 JSON。
115    StringBuffer buffer;
116    Writer<StringBuffer> writer(buffer);
117    d.Accept(writer);
118
119    // Output {"project":"rapidjson","stars":11}
120    std::cout << buffer.GetString() << std::endl;
121    return 0;
122}
123~~~~~~~~~~
124
125注意此例子并没有处理潜在错误。
126
127下图展示执行过程。
128
129![simpledom](doc/diagram/simpledom.png)
130
131还有许多 [例子](https://github.com/miloyip/rapidjson/tree/master/example) 可供参考:
132
133* DOM API
134 * [tutorial](https://github.com/miloyip/rapidjson/blob/master/example/tutorial/tutorial.cpp): DOM API 的基本使用方法。
135
136* SAX API
137 * [simplereader](https://github.com/miloyip/rapidjson/blob/master/example/simplereader/simplereader.cpp): 使用 `Reader` 解析 JSON 时,打印所有 SAX 事件。
138 * [condense](https://github.com/miloyip/rapidjson/blob/master/example/condense/condense.cpp): 移除 JSON 中所有空白符的命令行工具。
139 * [pretty](https://github.com/miloyip/rapidjson/blob/master/example/pretty/pretty.cpp): 为 JSON 加入缩进与换行的命令行工具,当中使用了 `PrettyWriter`。
140 * [capitalize](https://github.com/miloyip/rapidjson/blob/master/example/capitalize/capitalize.cpp): 把 JSON 中所有字符串改为大写的命令行工具。
141 * [messagereader](https://github.com/miloyip/rapidjson/blob/master/example/messagereader/messagereader.cpp): 使用 SAX API 去解析一个 JSON 报文。
142 * [serialize](https://github.com/miloyip/rapidjson/blob/master/example/serialize/serialize.cpp): 使用 SAX API 去序列化 C++ 对象,生成 JSON。
143 * [jsonx](https://github.com/miloyip/rapidjson/blob/master/example/jsonx/jsonx.cpp): 实现了一个 `JsonxWriter`,它能把 SAX 事件写成 [JSONx](https://www-01.ibm.com/support/knowledgecenter/SS9H2Y_7.1.0/com.ibm.dp.doc/json_jsonx.html)(一种 XML)格式。这个例子是把 JSON 输入转换成 JSONx 格式的命令行工具。
144
145* Schema API
146 * [schemavalidator](https://github.com/miloyip/rapidjson/blob/master/example/schemavalidator/schemavalidator.cpp): 使用 JSON Schema 去校验 JSON 的命令行工具。
147
148* 进阶
149 * [prettyauto](https://github.com/miloyip/rapidjson/blob/master/example/prettyauto/prettyauto.cpp): [pretty](https://github.com/miloyip/rapidjson/blob/master/example/pretty/pretty.cpp) 的修改版本,可自动处理任何 UTF 编码的 JSON。
150 * [parsebyparts](https://github.com/miloyip/rapidjson/blob/master/example/parsebyparts/parsebyparts.cpp): 这例子中的 `AsyncDocumentParser` 类使用 C++ 线程来逐段解析 JSON。
151 * [filterkey](https://github.com/miloyip/rapidjson/blob/master/example/filterkey/filterkey.cpp): 移取使用者指定的键值的命令行工具。
152 * [filterkeydom](https://github.com/miloyip/rapidjson/blob/master/example/filterkey/filterkey.cpp): 如上的工具,但展示如何使用生成器(generator)去填充一个 `Document`。