rapidjson图文讲解

目录

简介 

注意事项

GenericValue

json数据加载和输出

API

---

本文记录rapidjson的使用心得，篇幅较小，主要总结其中的重点部分，以文字和图表的方式叙述。

简介 

RapidJSON 是一个C++的JSON 解析器及生成器。我个人比较推荐，理由可看官网http://rapidjson.org/zh-cn/index.html介绍。而jsoncpp并不推荐，虽然它的API简单易用，但速度、Unicode支持等都不如RapidJSON。我比较看重RapidJSON的以下几点： 

1. RapidJSON库仅由头文件组成。
2. RapidJSON库对Unicode友好支持。目前支持UTF-8、UTF-16、UTF-32(大端序／小端序)，并且内部支持这些编码的自动检测、校验及转码。
3. 支持JSON Pointer功能快速访问和修改DOM，类似于XML的Xpath表达式遍历节点。
4. 支持JSON Schema功能（解析或生成json时校验是否符合某种格式，一般较少使用）。
5. 支持char或wchar_t编程接口，其中UTF-8为char，UTF-16为wchar_t，而UTF-32为uint32_t。
6. RapidJSON解析和生成速度快。

缺点： 

1. RapidJSON库较难使用，源码使用了大量的模板类和模板函数。
2. RapidJSON库的SAX风格接口较难使用，因此使用DOM接口即可。

注意事项

1. Value赋值使用move语义，而不是copy语义。也就是说，拷贝构造和拷贝赋值函数都是用move语义实现的。
2. 当string的生命周期不足时，Value应该使用Copy-string存储策略，否则value无法长期存储字符串。
3. StringBuffer是一个简单的输出流，当该缓冲区满溢时会自动增加容量（默认为256个字符）。
4. FileReadStream / FileWriteStream，和IStreamWrapper / OStreamWrapper，它们都是字节流，不处理编码。若输入流或输出流数据是非UTF-8编码时，输入流数据需要用EncodedInputStream或AutoUTFInputStream包装，而输出流数据需要用EncodedOutputStream 或AutoUTFOutputStream包装。
5. 原位解析适合用于短期的、用完即弃的 JSON。数据流的来源编码与目标编码必须相同，并且还要保证缓冲区的生命周期大于DOM。
6. RapidJSON支持SSE2，SSE4.2和ARM Neon指令加速解析，并且只对UTF-8编码的内存流启用。然而，若在不支持这些指令集的机器上执行这些可执行文件，会导致崩溃。
7. 不建议使用wistream和wostream。

GenericValue

 

json数据加载和输出

 

API

了解rapidjson的基本输入输出结构后，API的熟悉只需多用即可，常用的是 GenericValue。此外，还可自定义函数实现常用功能，例如以下函数实现了输出指定字符集的json字符串：

template<typename encode = rapidjson::UTF8<>, unsigned writeFlags = rapidjson::kWriteDefaultFlags>
basic_string<typename encode::Ch> rapidjson_get(const json_value& doc)
{
	using json_stream = rapidjson::GenericStringBuffer<encode>;
	json_stream buffer(0, 1024);	// 空间不足时自动增长
	rapidjson::Writer<json_stream, json_value::EncodingType, encode, rapidjson::CrtAllocator, writeFlags> writer(buffer);
	if (doc.Accept(writer))
	{
		return basic_string<typename encode::Ch>(buffer.GetString(), buffer.GetLength());
	}

	return basic_string<typename encode::Ch>();
}