Tencent / RapidJSON C++

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

腾讯 c++ json
拷贝地址

项目最近一次提交:大约 2 年 前 a6f102472

文件列表 提交日期 作者 提交信息 提交编号
CMakeModules / 2014-11-11 23:26:59 No_avatar Andriy Senkovych Add initial CMake support 8ae1c971
bin / 2014-06-25 16:07:44 4_miloyip miloyip Revert "Remove some clang -Weverythin... f930d9e2
doc / 2015-04-03 11:33:55 4_miloyip miloyip Minor dom doc modifications fc18b128
example / 2015-04-02 09:44:25 4_miloyip miloyip Merge pull request #279 from pah/fix/... f5b021d7
include / 2015-04-03 12:57:16 4_miloyip miloyip Change copyright owner and related ch... d1959ba6
test / 2015-04-03 11:35:32 4_miloyip miloyip Try to fix a compilation error on gcc... b8cc02e0
thirdparty / 2014-10-29 02:35:36 No_avatar Philipp A. Hartmann Drop thirdparty JSON implementations/... 20bab938
.gitignore 2015-02-20 00:27:52 No_avatar Andrii Senkovych Cleaning up gitignore. Refs #240. aa0fdd3b
.gitmodules 2014-08-23 12:00:10 4_miloyip miloyip Add google test as submodule 38889835
.travis.yml 2015-03-25 04:04:38 No_avatar Philipp A. Hartmann .travis.yml: disable SSE4.2 on 32-bit... 107aff0c
CMakeLists.txt 2015-03-24 13:50:02 No_avatar thebusytypist Exclude intermediate files from install. 58cd253f
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 2015-03-11 03:32:39 No_avatar Philipp A. Hartmann appveyor.yml: skip perftest on debug ... 0ed4cdfa
license.txt 2015-04-03 12:57:16 4_miloyip miloyip Change copyright owner and related ch... d1959ba6
readme.md 2015-04-03 12:57:16 4_miloyip miloyip Change copyright owner and related ch... d1959ba6
readme.zh-cn.md 2015-04-03 15:24:41 4_miloyip miloyip Copyright text for zh-cn readme a6f10247
travis-doxygen.sh 2015-04-02 15:48:13 4_miloyip miloyip Add doxyfile for zh-cn d1a345a6

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
lin-badge win-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.1 for acceleration.

  • RapidJSON is self-contained. 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.