Cocos數(shù)據(jù)篇[3.4](2) ——Json數(shù)據(jù)操作

【嘮叨】

    在游戲中使用Json來儲存數(shù)據(jù)，既方便讀取，又方便管理。

    比如CocosStudio 1.6之前版本導(dǎo)出的資源擴(kuò)展名就是 .ExportJson 格式的。

    Cocos2d-x 3.x 加入了rapidjson庫用于json解析。位于external/json下。

    本節(jié)要介紹的就是：如何使用 rapidjson庫 來操作處理json文件。

【參考】

    http://www.w3school.com.cn/json/index.asp （W3School）

    http://cn.cocos2d-x.org/tutorial/show?id=1203 （【官方文檔】rapidjson用法）

    http://cn.cocos2d-x.org/tutorial/show?id=1556 （RapidJson解析）

    http://cn.cocos2d-x.org/tutorial/show?id=1528  （rapidjson獲取Json數(shù)據(jù)的實(shí)戰(zhàn)經(jīng)驗(yàn)）

【Json簡介】

    摘自：http://www.w3school.com.cn/json/index.asp

1、什么是Json？

    > JSON 指的是 JavaScript 對象表示法（JavaScript Object Notation）。

    > JSON 是輕量級的存儲和文本數(shù)據(jù)交換格式，類似XML。

    > JSON 比 XML 更小、更快，更易解析。

    > JSON 具有自我描述性，更易理解。

    > JSON 獨(dú)立于語言 * 。

    *  JSON 使用 JavaScript 語法來描述數(shù)據(jù)對象，但是 JSON 仍然獨(dú)立于語言和平臺。

    *  JSON 解析器和 JSON 庫支持許多不同的編程語言。

2、語法規(guī)則

    JSON 語法是 JavaScript 對象表示法語法的子集。

    （1）數(shù)據(jù)在“名稱/值對”中，即 鍵值對（key-value）形式。

    （2）每條數(shù)據(jù)由“逗號”分隔。

    （3）“花括號”{ } 保存 對象。

    （4）“方括號”[ ] 保存 數(shù)組。

  2.1、名稱/值對

    JSON 數(shù)據(jù)的書寫格式是：名稱/值對（鍵值對 key-value）。

    名稱/值對，包括字段名稱（在雙引號中），后面寫一個冒號，然后是值。

//
	// "名稱" : "值"
	"firstName" : "John"
	
	// 錯誤。名稱必須加雙引號""
	name : "Alice"
//

  2.2、值

    JSON的值可以是：

        > null

        > 邏輯值（boolean）

        > 數(shù)字（number）

        > 字符串（string，在雙引號 " " 中）

        > 數(shù)組（在方括號 [ ] 中）

        > 對象（在花括號 { } 中）

    PS：即“名稱/值對”數(shù)據(jù)中，其名稱的冒號“ : ”后面對應(yīng)的值可以不是字符串，也可以是數(shù)字、數(shù)組、對象等。

  2.3、對象

    JSON 對象在花括號中書寫：{ } 。

    對象可以包含多個名稱/值對（ 可以理解為對象的 屬性名/屬性值 ）。

    PS：名稱必須要加雙引號" "，并且對象中只能包含名稱/值對的形式，不能只有一個值。

    如下所示：

//
	{ 
		"name":"John",       // 正確
		"age":23,            // 正確
		"array" : [1,2,3,4], // 正確。值可以為數(shù)組形式

		"hello world",       // 錯誤。不能僅為一個值
		name : "John"        // 錯誤。名稱必須加雙引號"name"
	}
//

  2.4、數(shù)組

    JSON 數(shù)組在方括號中書寫：[ ] 。

    數(shù)組可包含多個值（可以為null、邏輯值、數(shù)字、字符串、對象、數(shù)組）。

    PS：數(shù)組中只能包含值的形式，不能為名稱/值的形式。

    如下所示：

//
	[
		true,                       // 邏輯值Bool
		123,                        // 數(shù)字Number
		"888",                      // 字符串String
		"hello world",              // 字符串String
		{"name":"alice", "age":23}, // 對象Object
		[1,2,3,4],                  // 數(shù)組Object

		"name" : "John"             // 錯誤。不能為 名稱/值 的形式
	]
//

【rapidjson】

    Cocos2d-x 3.x 加入了 rapidjson庫，用于Json解析。位于external/json下。

    只支持標(biāo)準(zhǔn)的Json格式，一些非標(biāo)準(zhǔn)的Json格式不支持。一些常用的解析方法需要自己封裝。注意判斷解析節(jié)點(diǎn)是否存在。

    PS：解析的Json文件，根節(jié)點(diǎn)必須為對象、或數(shù)組。不然無法解析。

    如下所示：

1、添加頭文件

    如果只用于解析Json文件，只要前2行的頭文件即可。

//
	#include "json/rapidjson.h"
	#include "json/document.h"
	#include "json/writer.h"
	#include "json/stringbuffer.h"
	//#include "json/filestream.h"
	//#include "json/prettywriter.h"

	using namespace rapidjson; // 命名空間
//

2、Json數(shù)據(jù)解析

    Cocos封裝的 rapidjson庫，只能解析對象格式、或數(shù)組格式的Json文件。

  2.1、解析對象格式的Json

    Json文件中的數(shù)據(jù)，根節(jié)點(diǎn)為一個對象，所有屬性在大花括號 { } 中。

    對象中的數(shù)據(jù)，通過 名稱/值 的形式進(jìn)行訪問。

    Json文件內(nèi)容如下：

//
{
	"hello" : "world",
	"t"     : true,
	"f"     : false,
	"n"     : null,
	"i"     : 123,
	"pi"    : 3.1416,
	"array" : [1, 2, 3, 4],
	"object": {
		"name" : "alice",
		"age" : 23
	}
}
//

    Json解析使用舉例：

//
//[1] 讀取json文件內(nèi)容
	std::string str = FileUtils::getInstance()->getStringFromFile("testJson.json");
	CCLOG("%s", str.c_str());

//[2] 創(chuàng)建用于處理json代碼的類
	// 創(chuàng)建rapidjson::Document類：用于操作json代碼
	rapidjson::Document d;

//[3] 解析json文件內(nèi)容
	// 其中 rapidjson::kParseDefaultFlags = 0，默認(rèn)方式
	d.Parse<rapidjson::kParseDefaultFlags>(str.c_str());
	// d.Parse<0>(str.c_str());  // 也可以直接寫<0>

//[4] 判斷解析是否出錯
	if (d.HasParseError()) {
		CCLOG("GetParseError %s\n",d.GetParseError());
		return;
	}

//[5] 獲取json中的數(shù)據(jù)
	// 判斷json文件是否為對象格式
	if (d.IsObject()) {

		// 是否有 "hello" 屬性
		if (d.HasMember("hello")) {
			CCLOG("%s", d["hello"].GetString()); // 方式一：直接獲取
		}
		// 是否有 "i" 屬性
		if (d.HasMember("i")) {
			rapidjson::Value& i = d["i"];        // 方式二：保存為rapidjson::Value&
			CCLOG("%d", i.GetInt());
		}

		// 數(shù)組
		if (d.HasMember("array")) {
			// 獲取數(shù)組中的元素：d["array"][i]
			for (int i = 0; i < d["array"].Size(); i++) {
				CCLOG("%d : %d", i, d["array"][i].GetInt());
			}

//            // 也可以這么寫
//            rapidjson::Value& array = d["array"];
//            for (int i = 0; i < array.Size(); i++) {
//                CCLOG("%d : %d", i, array[i].GetInt());
//            }
		}

		// 對象
		if (d.HasMember("object")) {
			// 判斷 "object" 屬性對應(yīng)的值，是否為一個對象
			if (d["object"].IsObject()) {
				// 轉(zhuǎn)化為 rapidjson::Value&
				rapidjson::Value& object = d["object"];
				CCLOG("%s", d["object"]["name"].GetString());
				CCLOG("%d", object["age"].GetInt());
			}
		}
	}
//

    控制臺輸出結(jié)果：

  2.2、解析數(shù)組格式的Json

    json文件中的數(shù)據(jù)，根節(jié)點(diǎn)為一個數(shù)組，所有元素在一個大方括號 [ ] 中。

    數(shù)組中的數(shù)據(jù)，通過下標(biāo)的形式訪問元素值（下標(biāo)從0開始）。

    Json文件內(nèi)容如下：

//
	[
		true,
		123,
		"888",
		"hello world",
		{"name" : "alice", "age" : 23},
		[1,2,3,4]
	]
//

    Json解析使用舉例：

//
//[1] 讀取json文件內(nèi)容
	std::string str = FileUtils::getInstance()->getStringFromFile("testJson.json");
	CCLOG("%s", str.c_str());

//[2] 創(chuàng)建用于處理json代碼的類
	// 創(chuàng)建rapidjson::Document類：用于操作json代碼
	rapidjson::Document d;

//[3] 解析json文件內(nèi)容
	// 其中 rapidjson::kParseDefaultFlags = 0，默認(rèn)方式
	d.Parse<rapidjson::kParseDefaultFlags>(str.c_str());
	// d.Parse<0>(str.c_str());  // 也可以直接寫<0>

//[4] 判斷解析是否出錯
	if (d.HasParseError()) {
		CCLOG("GetParseError %s\n",d.GetParseError());
		return;
	}

//[5] 獲取json中的數(shù)據(jù)
	// 判斷json文件是否為數(shù)組格式
	if (d.IsArray()) {
		
		rapidjson::Value& array = d;
		
		for (int i = 0; i < array.Size(); i++) {

			if (d[i].IsBool()) {   // 邏輯值
				CCLOG("%d is Bool : %d", i, array[i].GetBool());
			}
			if (d[i].IsNumber()) { // 數(shù)字
				CCLOG("%d is Number : %d", i, array[i].GetInt());
			}
			if (d[i].IsString()) { // 字符串
				CCLOG("%d is String : %s", i, array[i].GetString());
			}
			if (d[i].IsObject()) { // 對象
				rapidjson::Value& object = d[i];
				CCLOG("%d is Object : %s", i, array[i]["name"].GetString());
				CCLOG("%d is Object : %d", i, object["age"].GetInt());
			}
			if (d[i].IsArray()) {  // 數(shù)組
				for (int j = 0; j < array[i].Size(); j++) {
					CCLOG("[%d,%d] is Array : %d", i, j, array[i][j].GetInt());
				}
			}
		}
	}
//

    控制臺輸出結(jié)果：

3、Json數(shù)據(jù)存儲

  3.1、存儲為對象格式的Json

    使用舉例：

//
//[1] 創(chuàng)建用于處理json代碼的類
	// 創(chuàng)建rapidjson::Document類：用于操作json代碼
	rapidjson::Document d;

//[2] 獲取分配器
	rapidjson::Document::AllocatorType& allocator = d.GetAllocator();

//[3] 設(shè)置為對象格式 SetObject
	d.SetObject();

//[4] 添加數(shù)據(jù)
	//[4.1] 往json對象中添加數(shù)據(jù)：名稱/值對
	rapidjson::Value object(rapidjson::kObjectType); // 創(chuàng)建對象

	object.AddMember("int", 1, allocator);         // 添加 "int" : 1
	object.AddMember("double", 1.1, allocator);    // 添加 "double" : 1.1
	object.AddMember("hello", "world", allocator); // 添加 "hello" : "world"

	//[4.2] 往json數(shù)組中添加數(shù)據(jù)：值
	rapidjson::Value array(rapidjson::kArrayType); // 創(chuàng)建數(shù)組

	rapidjson::Value str(rapidjson::kStringType);  // 字符串
	rapidjson::Value obj(rapidjson::kObjectType);  // 對象
	str.SetString("hello"); // 設(shè)置str的值
	obj.AddMember("name", "alice", allocator);
	obj.AddMember("age", 23, allocator);

	array.PushBack(123, allocator);   // 添加數(shù)字
	array.PushBack("888", allocator); // 添加字符串，方式一
	array.PushBack(str, allocator);   // 添加字符串，方式二
	array.PushBack(obj, allocator);   // 添加對象

	//[4.3] 往對象格式的json文件中添加數(shù)據(jù)
	d.AddMember("hello", "world", allocator);
	d.AddMember("object", object, allocator);
	d.AddMember("array", array, allocator);

//[5] 將json數(shù)據(jù)寫入文件中
	StringBuffer buffer;
	rapidjson::Writer<StringBuffer> writer(buffer);
	d.Accept(writer);
	CCLOG("%s", buffer.GetString());

	FILE* file = fopen("/soft/cocos2d-x-3.4/projects/Demo34/Resources/testJson.json", "wb");
	if(file) {
		fputs(buffer.GetString(), file);
		fclose(file);
	}
//

    控制臺輸出結(jié)果：

    Json代碼整理一下，如下：

//
	{
		"hello" : "world",
		"object": { "int":1, "double":1.1, "hello":"world" },
		"array" : [ 123, "888", "hello", {"name":"alice", "age":23} ]
	}
//

  3.2、存儲為數(shù)組格式的Json

    使用方法與存儲為對象格式類似。

    使用舉例：

//
//[1] 創(chuàng)建用于處理json代碼的類
	// 創(chuàng)建rapidjson::Document類：用于操作json代碼
	rapidjson::Document d;

//[2] 獲取分配器
	rapidjson::Document::AllocatorType& allocator = d.GetAllocator();

//[3] 設(shè)置為數(shù)組格式 SetArray
	d.SetArray();

//[4] 添加數(shù)據(jù)
	rapidjson::Value object(rapidjson::kObjectType);
	object.AddMember("name", "alice", allocator);
	object.AddMember("age", 23, allocator);

	d.PushBack(123, allocator);
	d.PushBack("hello", allocator);
	d.PushBack(object, allocator);

//[5] 將json數(shù)據(jù)寫入文件中
	StringBuffer buffer;
	rapidjson::Writer<StringBuffer> writer(buffer);
	d.Accept(writer);
	CCLOG("%s", buffer.GetString());

	FILE* file = fopen("/soft/cocos2d-x-3.4/projects/Demo34/Resources/testJson.json", "wb");
	if(file) {
		fputs(buffer.GetString(), file);
		fclose(file);
	}
//

    控制臺輸出結(jié)果：

4、Json數(shù)據(jù)修改

    以對象格式的Json文件為例。

    Json文件內(nèi)容如下：

//
	{
		"hello" : "world",
		"array" : [1, 2, 3, 4],
		"object": {"name":"alice", "age":23 }
	}
//

    對Json文件數(shù)據(jù)進(jìn)行修改：

//
//[1] 讀取json文件內(nèi)容
	std::string str = FileUtils::getInstance()->getStringFromFile("/soft/cocos2d-x-3.4/projects/Demo34/Resources/testJson.json");

//[2] 創(chuàng)建用于處理json代碼的類、獲取分配器、解析json文件內(nèi)容
	rapidjson::Document d;
	rapidjson::Document::AllocatorType& allocator = d.GetAllocator();
	d.Parse<0>(str.c_str());

//[3] 判斷解析是否出錯
	if (d.HasParseError()) {
		CCLOG("GetParseError %s\n",d.GetParseError());
		return;
	}

//[4] 修改Json文件的數(shù)據(jù)
	// 修改： "hello" 的值 "hello":"hehe"
	d["hello"].SetString("hehe");
	// 添加：對象的數(shù)據(jù) "newdata":"888"
	d.AddMember("newdata", "888", allocator);
	// 刪除：對象中的數(shù)據(jù) "object"
	d.RemoveMember("object");

//[5] 將json數(shù)據(jù)重新寫入文件中
	StringBuffer buffer;
	rapidjson::Writer<StringBuffer> writer(buffer);
	d.Accept(writer);
	CCLOG("%s", buffer.GetString());

	FILE* file = fopen("/soft/cocos2d-x-3.4/projects/Demo34/Resources/testJson.json", "wb");
	if(file) {
		fputs(buffer.GetString(), file);
		fclose(file);
	}
//

    控制臺輸出結(jié)果：

【常用操作】

    常用操作如下：

//
// 創(chuàng)建用于處理json文件的類
	rapidjson::Document d;
// 獲取分配器
	rapidjson::Document::AllocatorType& allocator = d.GetAllocator();
// 判斷是否解析錯誤
	d.HasParseError();
	d.GetParseError();

// 解析json文件
	d.Parse<0>(const Ch *str);
// 將數(shù)據(jù)寫入json文件
	StringBuffer buffer;
	rapidjson::Writer<StringBuffer> writer(buffer);
	d.Accept(writer);

	FILE* file = fopen("/soft/cocos2d-x-3.4/projects/Demo34/Resources/testJson.json", "wb");
	if(file) {
		fputs(buffer.GetString(), file);
		fclose(file);
	}

// json數(shù)組操作
// json數(shù)組
	rapidjson::Value& array = d["array"];
	rapidjson::Value array(rapidjson::kArrayType);

	array.PushBack(T value, allocator);   // 向數(shù)組中添加值
	array.Size();  // 數(shù)組元素個數(shù)
	array.Clear(); // 清空數(shù)組元素
	array.Empty(); // 判斷數(shù)組元素是否為空

// json對象操作
	// json對象
	rapidjson::Value& object = d["object"];
	rapidjson::Value object(rapidjson::kObjectType);

	object.AddMember(const Ch *name, T value, allocator); // 向?qū)ο笾刑砑用Q/值對
	object.HasMember("key");    // 是否存在某名稱/值對
	object.RemoveMember("key"); // 刪除某名稱/值對


// 獲取值
	rapidjson::Value& value = d["key"]; // 對象格式，"key-value"
	rapidjson::Value& value = d[index]; // 數(shù)組格式，下標(biāo)idx為整數(shù)

	value.GetBool();   // 值為邏輯值
	value.GetInt();    // 值為整數(shù)
	value.GetUint();   // 值為無符號整數(shù)
	value.GetInt64();  // 值為64位整數(shù)
	value.GetUint64(); // 值為64位無符號整數(shù)
	value.GetDouble(); // 值為浮點(diǎn)數(shù)
	value.GetString(); // 值為字符串
	// 獲取值的類型，返回值為枚舉類型rapidjson::Type
	// 	enum Type {
	//		kNullType   = 0,  //!< null
	//		kFalseType  = 1,  //!< false
	//		kTrueType   = 2,  //!< true
	//		kObjectType = 3,  //!< object
	//		kArrayType  = 4,  //!< array 
	//		kStringType = 5,  //!< string
	//		kNumberType = 6,  //!< number
	//	};
	value.GetType();   

// 判斷值的類型
	rapidjson::Value& value = d["key"]; // 對象格式，"key-value"
	rapidjson::Value& value = d[index]; // 數(shù)組格式，下標(biāo)idx為整數(shù)

	value.IsNull(); // 是否為空，null
	value.IsBool()、IsTrue()、IsFalse();
	value.IsNumber()、IsInt()、IsUint()、IsUint64()、IsInt64()、IsDouble();
	value.IsArray();
	value.IsObject();
	value.IsString();

// 設(shè)置值
	rapidjson::Value& value = d["key"]; // 對象格式，"key-value"
	rapidjson::Value& value = d[index]; // 數(shù)組格式，下標(biāo)idx為整數(shù)
	rapidjson::Value value;

	value.SetNull();               // 設(shè)置為空值
	value.SetBool(bool b);         // 設(shè)置為邏輯值
	value.SetInt(int i);           // 設(shè)置為Int值
	value.SetUint(unsigned int u); // 設(shè)置為UInt值
	value.SetInt64(int64_t i64);   // 設(shè)置為Int64值
	value.SetUint64(uint64_t u64); // 設(shè)置為UInt64值
	value.SetDouble(double d);     // 設(shè)置為double值 
	value.SetArray();              // 設(shè)置為數(shù)組格式
	value.SetObject();             // 設(shè)置為對象格式
	value.SetString(const Ch *s);  // 設(shè)置為字符串值
//