c++中rapidjson庫下載安裝及使用
rapidjson庫官網地址:http://www.oschina.net/news/61812/rapidjson-1-0-final
rapidjson庫下載網地址:https://github.com/miloyip/rapidjson
rapidjson庫安裝及使用教程中文解釋網站:http://rapidjson.org/zh-cn/
如何安裝rapidjson庫:
高效的 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.
Build 狀態
簡介
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 的更多資訊可參考:
v1.1 中的亮點 (2016-8-25)
- 加入 JSON Pointer 功能,可更簡單地訪問及更改 DOM。
- 加入 JSON Schema 功能,可在解析或生成 JSON 時進行校驗。
- 加入 放寬的 JSON 語法 (註釋、尾隨逗號、NaN/Infinity)
- 使用 C++11 範圍 for 迴圈 去遍歷 array 和 object。
- 在 x86-64 架構下,縮減每個
Value
的記憶體開銷從 24 位元組至 16 位元組。
相容性
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 用於單元及效能測試
生成測試及例子的步驟:
- 執行
git submodule update --init
去獲取 thirdparty submodules (google test)。 - 在 rapidjson 目淥下,建立一個
build
目錄。 - 在
build
目錄下執行cmake ..
命令以設定生成。Windows 使用者可使用 cmake-gui 應用程式。 - 在 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 字串。
// rapidjson/example/simpledom/simpledom.cpp` #include "rapidjson/writer.h" #include "rapidjson/stringbuffer.h" #include <iostream> using namespace rapidjson; int main() { // 1. 把 JSON 解析至 DOM。 const char* json = "{\"project\":\"rapidjson\",\"stars\":10}"; d.Parse(json); // 2. 利用 DOM 作出修改。 Value& s = d["stars"]; s.SetInt(s.GetInt() + 1); // 3. 把 DOM 轉換(stringify)成 JSON。 d.Accept(writer); // Output {"project":"rapidjson","stars":11} std::cout << buffer.GetString() << std::endl; return 0; }注意此例子並沒有處理潛在錯誤。
下圖展示執行過程。
simpledom還有許多 例子 可供參考:
- 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 格式的命令列工具。
- simplereader: 使用
- Schema API
- schemavalidator: 使用 JSON Schema 去校驗 JSON 的命令列工具。
- 進階
- prettyauto: pretty 的修改版本,可自動處理任何 UTF 編碼的 JSON。
- parsebyparts: 這例子中的
AsyncDocumentParser
類使用 C++ 執行緒來逐段解析 JSON。 - filterkey: 移取使用者指定的鍵值的命令列工具。
- filterkeydom: 如上的工具,但展示如何使用生成器(generator)去填充一個
Document
。