Tencent / RapidJSON C++

RapidJSON是一个C++的JSON解析器及生成器

腾讯 c++ json
拷贝地址

项目最近一次提交:一年多 前 f191cd9df

文件列表 提交日期 作者 提交信息 提交编号
CMakeModules / 2015-05-12 06:23:50 No_avatar Phyks Fix CMakeLists for include as a third... 89ad34ce
bin / 2016-03-04 11:52:18 4_miloyip miloyip Normalize line endings but not JSON f... a6277748
doc / 2016-04-15 10:43:14 4_miloyip miloyip Added documentation for kParseNumbers... f4ea0d3f
docker / 2016-03-02 01:45:05 4_miloyip miloyip Add debian docker file for development 680c1112
example / 2016-04-04 15:01:34 4_miloyip miloyip Try to fix all /W4 warnings in VC2015 c843a265
include / 2016-04-21 09:29:48 4_miloyip miloyip Fix potential memory leak of RAPIDJSO... f191cd9d
test / 2016-04-21 09:29:48 4_miloyip miloyip Fix potential memory leak of RAPIDJSO... f191cd9d
thirdparty / 2014-10-29 02:35:36 No_avatar Philipp A. Hartmann Drop thirdparty JSON implementations/... 20bab938
.gitattributes 2016-03-04 11:52:18 4_miloyip miloyip Normalize line endings but not JSON f... a6277748
.gitignore 2015-12-31 15:30:28 4_miloyip miloyip PutReserve() and PutUnsafe() optimisa... ef6957c1
.gitmodules 2014-08-23 12:00:10 4_miloyip miloyip Add google test as submodule 38889835
.travis.yml 2016-02-28 00:53:15 4_miloyip miloyip Add missing valgrind bc40c8a6
CHANGELOG.md 2016-04-19 15:44:50 4_miloyip miloyip Update changelog bbcdb8b5
CMakeLists.txt 2016-04-04 15:01:34 4_miloyip miloyip Try to fix all /W4 warnings in VC2015 c843a265
RapidJSON.pc.in 2015-02-24 22:35:12 No_avatar Christian Hitz RapidJSON.pc.in: include dir not set 46554603
RapidJSONConfig.cmake.in 2014-11-11 23:26:59 No_avatar Andriy Senkovych Add initial CMake support 8ae1c971
RapidJSONConfigVersion.cmake.in 2014-11-11 23:26:59 No_avatar Andriy Senkovych Add initial CMake support 8ae1c971
appveyor.yml 2016-03-31 10:25:55 4_miloyip miloyip Add CMAKE verbose for appveyor 89afda06
library.json 2015-08-03 16:30:37 No_avatar Ivan Kravets Fix include location 720d1688
license.txt 2016-03-04 11:52:18 4_miloyip miloyip Normalize line endings but not JSON f... a6277748

README.md

A fast JSON parser/generator for C++ with both SAX/DOM style 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.

Build status

Linux Windows Coveralls
lin-badge win-badge cov-badge

Introduction

RapidJSON is a JSON parser and generator for C++. It was inspired by RapidXml.

  • RapidJSON is small but complete. It supports both SAX and DOM style API. The SAX parser is only a half thousand lines of code.

  • RapidJSON is fast. Its performance can be comparable to strlen(). It also optionally supports SSE2/SSE4.2 for acceleration.

  • RapidJSON is self-contained and header-only. It does not depend on external libraries such as BOOST. It even does not depend on STL.

  • RapidJSON is memory-friendly. Each JSON value occupies exactly 16/20 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.

  • 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).

More features can be read here.

JSON(JavaScript Object Notation) is a light-weight data exchange format. RapidJSON should be in fully compliance with RFC7159/ECMA-404. More information about JSON can be obtained at

Compatibility

RapidJSON is cross-platform. Some platform/compiler combinations which have been tested are shown as follows.

  • Visual C++ 2008/2010/2013 on Windows (32/64-bit)
  • GNU C++ 3.8.x on Cygwin
  • Clang 3.4 on Mac OS X (32/64-bit) and iOS
  • Clang 3.4 on Android NDK

Users can build and run the unit tests on their platform/compiler.

Installation

RapidJSON is a header-only C++ library. Just copy the include/rapidjson folder to system or project's include path.

RapidJSON uses following software as its dependencies:

  • CMake as a general build tool
  • (optional)Doxygen to build documentation
  • (optional)googletest for unit and performance testing

To generate user documentation and run tests please proceed with the steps below:

  1. Execute git submodule update --init to get the files of thirdparty submodules (google test).
  2. Create directory called build in rapidjson source directory.
  3. Change to build directory and run cmake .. command to configure your build. Windows users can do the same with cmake-gui application.
  4. On Windows, build the solution found in the build directory. On Linux, run make from the build directory.

On successfull build you will find compiled test and example binaries in bin directory. The generated documentation will be available in doc/html directory of the build tree. To run tests after finished build please run make test or ctest from your build tree. You can get detailed output using ctest -V command.

It is possible to install library system-wide by running make install command from the build tree with administrative privileges. This will install all files according to system preferences. Once RapidJSON is installed, it is possible to use it from other CMake projects by adding find_package(RapidJSON) line to your CMakeLists.txt.

Usage at a glance

This 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.

// rapidjson/example/simpledom/simpledom.cpp`
#include "rapidjson/document.h"
#include "rapidjson/writer.h"
#include "rapidjson/stringbuffer.h"
#include <iostream>

using namespace rapidjson;

int main() {
    // 1. Parse a JSON string into DOM.
    const char* json = "{\"project\":\"rapidjson\",\"stars\":10}";
    Document d;
    d.Parse(json);

    // 2. Modify it by DOM.
    Value& s = d["stars"];
    s.SetInt(s.GetInt() + 1);

    // 3. Stringify the DOM
    StringBuffer buffer;
    Writer<StringBuffer> writer(buffer);
    d.Accept(writer);

    // Output {"project":"rapidjson","stars":11}
    std::cout << buffer.GetString() << std::endl;
    return 0;
}

Note that this example did not handle potential errors.

The following diagram shows the process.

simpledom

More examples are available:

  • DOM API

  • SAX API

    • simplereader: Dumps all SAX events while parsing a JSON by Reader.
    • condense: A command line tool to rewrite a JSON, with all whitespaces removed.
    • pretty: A command line tool to rewrite a JSON with indents and newlines by PrettyWriter.
    • capitalize: A command line tool to capitalize strings in JSON.
    • messagereader: Parse a JSON message with SAX API.
    • serialize: Serialize a C++ object into JSON with SAX API.
    • jsonx: Implements a JsonxWriter which stringify SAX events into JSONx (a kind of XML) format. The example is a command line tool which converts input JSON into JSONx format.
  • Schema

    • schemavalidator : A command line tool to validate a JSON with a JSON schema.
  • Advanced

    • prettyauto: A modified version of pretty to automatically handle JSON with any UTF encodings.
    • parsebyparts: Implements an AsyncDocumentParser which can parse JSON in parts, using C++11 thread.