C++使用Json作为数据包装格式的通信

From: http://blog.csdn.net/xt_xiaotian/archive/2010/06/04/5648388.aspx

一、摘要

JSON 的全称为：JavaScript Object Notation，顾名思义，JSON 是用于标记 Javascript 对象的，JSON 官方的解释为：JSON 是一种轻量级的数据传输格式。

本文并不详细介绍 JSON 本身的细节，旨在讨论如何使用 C++ 语言来处理 JSON。关于 JSON 更具体的信息，可参见 JSON 官网：http://www.json.org。

二、本文选择处理JSON的C++库

本文选择一个第三方库 jsoncpp 来解析 JSON。jsoncpp 是比较出名的 C++ JSON 解析库。在 JSON 官网也是首推的。

下载地址为：http://sourceforge.net/projects/jsoncpp。本文使用的 jsoncpp 版本为：0.5.0。

三、jsoncpp在Windows下的编译

要使用第三方源码库，第一步少不了的就是编译，将源码文件编译成我们方便使用的动态链接库、静态链接库或者静态导入库[1]。

jsconcpp 进行 JSON 解析的源码文件分布在 include/json、src/lib_json 下。其实 jsoncpp 源码并不多，为了方便产品管理，此处没必要将其编译为动态链接库或者静态导入库，所以我们选择使用静态链接库[2]。

jsoncpp 已经处理的很完善了，所有编译选项都已经配置好，打开makefiles/vs71/jsoncpp.sln 便可以开始编译（默认是使用 VS2003 编译器的，打开时直接按照 VS2005 提示转换即可）。

四、jsoncpp使用详解

jsoncpp 主要包含三种类型的 class：Value、Reader、Writer。jsoncpp 中所有对象、类名都在 namespace Json 中，包含 json.h 即可。

Json::Value 只能处理 ANSI 类型的字符串，如果 C++ 程序是用 Unicode 编码的，最好加一个 Adapt 类来适配。

1、Value

Json::Value 是jsoncpp 中最基本、最重要的类，用于表示各种类型的对象，jsoncpp 支持的对象类型可见 Json::ValueType 枚举值。

可如下是用 Json::Value 类：

Json::Value json_temp; // 临时对象，供如下代码使用

json_temp["name"] = Json::Value("huchao");

json_temp["age"] = Json::Value(26);

Json::Value root; // 表示整个 json 对象

root["key_string"] = Json::Value("value_string"); // 新建一个 Key（名为：key_string），赋予字符串值："value_string"。

root["key_number"] = Json::Value(12345); // 新建一个 Key（名为：key_number），赋予数值：12345。

root["key_boolean"] = Json::Value(false); // 新建一个 Key（名为：key_boolean），赋予bool值：false。

root["key_double"] = Json::Value(12.345); // 新建一个 Key（名为：key_double），赋予 double 值：12.345。

root["key_object"] = Json_temp; // 新建一个 Key（名为：key_object），赋予 json::Value 对象值。

root["key_array"].append("array_string"); // 新建一个 Key（名为：key_array），类型为数组，对第一个元素赋值为字符串："array_string"。

root["key_array"].append(1234); // 为数组 key_array 赋值，对第二个元素赋值为：1234。

Json::ValueType type = root.type(); // 获得 root 的类型，此处为 objectValue 类型。

注：跟C++ 不同，JavaScript 数组可以为任意类型的值，所以 jsoncpp 也可以。

如上几个用法已经可以满足绝大部分 json 应用了，当然 jsoncpp 还有一些其他同能，比如说设置注释、比较 json 大小、交换 json 对象等，都很容易使用，大家自己尝试吧。

2、Writer

如上说了 Json::Value 的使用方式，现在到了该查看刚才赋值内容的时候了，查看 json 内容，使用 Writer 类即可。

Jsoncpp 的 Json::Writer 类是一个纯虚类，并不能直接使用。在此我们使用 Json::Writer 的子类：Json::FastWriter、Json::StyledWriter、Json::StyledStreamWriter。

顾名思义，用 Json::FastWriter 来处理 json 应该是最快的，下面我们来试试。

Json::FastWriter fast_writer;

std::cout << fast_writer.write(root) << std::endl;

输出结果为：

{"key_array":["array_string",1234],"key_boolean":false,"key_double":12.3450,"key_number":12345,"key_object":{"age":26,"name":"huchao"},"key_string":"value_string"}

再次顾名思义，用 Json::StyledWriter 是格式化后的 json，下面我们来看看 Json::StyledWriter 是怎样格式化的。

Json::StyledWriter styled_writer;

std::cout << styled_writer.write(root) << std::endl;

输出结果为：

{

"key_array" : [ "array_string", 1234 ],

"key_boolean" : false,

"key_double" : 12.3450,

"key_number" : 12345,

"key_object" : {

"age" : 26,

"name" : "huchao"

},

"key_string" : "value_string"

}

3、Reader

Json::Reader 是用于读取的，说的确切点，是用于将字符串转换为 Json::Value 对象的，下面我们来看个简单的例子。

Json::Reader reader;

Json::Value json_object;

const char* json_document = "{\"age\" : 26,\"name\" : \"huchao\"}";

if (!reader.parse(json_document, json_object))

return 0;

std::cout << json_object["name"] << std::endl;

std::cout << json_object["age"] << std::endl;

输出结果为：

"huchao"

26

可见，上述代码已经解析出了 json 字符串。

--------------------------------------

[1]：使用第三方源码最简单的方法是直接将文件加入工程，但这样不利于源码、软件产品管理，对于一般软件开发来说，不建议使用。

[2]：如果真需要编译成动态链接库、静态导入库的话，可以使用 VS 新建一个工程属性，然后在 Project --> Properties中进行相应的设置即可。

--------------------------------------------------------------------------------------------------------------------------------

出处：http://adebugger.cn/2009/11/cpp-json-data-communication/

Json大家都耳熟能详了吧？现在Json广泛用于各类通信，特别是基于Http协议的通信，一般的服务端动态脚本语言都有库支持Json的编码与解码。但很少有听过Json被C++使用来作为通信的格式，不过去了http://www.json.org/上面看了，已经有很多C++的库来支持Json的编码和解码，因为一个小东西要用到，最后使用的是Jsoncpp这个库。

看到Jsoncpp的主页上介绍说，Jsoncpp是Json数据格式的编码解码器，提供reader和writer来进行解码和编码。下面就简要的介绍Jsoncpp里头的玩意：

1.Reader

该库中的Reader类用来将字串或者流载入解析器。是的后期可以用Reader里面的解析方法来解码Json字串为C++认识的数据。可以用 Json::Reader来声明一个Reader实例。Reader中最常用的就是一个parse方法，该方法用来将载入的json字串解析为C++格式的数据。

2.Value

这是该库中的核心类，用于存储各样格式的数据，可以包括int,double,short,char *,string,bool,object,array等几乎所有格式的数据。该库的编码和解码的核心功能都是用Value类实现的。就用以上的 Reader的parse方法来说，需要传入一个Value类别的引用值，就是用来存储Json数据的根值，并且可以用这个根值来存取其他的所有值。

3.Writer

这是该库的一个虚类，没有真正的实现encode的功能。需要重载里头的方法来实现真正的encode功能

4.FastWriter

这是该库中真正实现encode功能的类，用来实现将Value编码称为Json串.

我暂时用到的是以上的这些类，该库还提供处理Json字串的注释，提供style来格式化Json字串是的更容易人阅读等功能，这些都没有用到，等以后用到了再来分享。下面用一段简短的代码来看以上这些Jsoncpp的基本功能:

C++语言:

01

21 string encode_game_play_msg(string token,int game_id,vector<piece> piece_array){

22 Json::Value root;

23 Json::Value var;

24

25 //apply “token” and “game_id” value to json struct

26 var["token"] = token;

27 var["game_id"] = game_id;

28

29 Json::Value pieces;//store all pieces

30 for (int i=0;i < piece_array.size();i++)

31 {

32 Json::Value piece_ex;//here it store just one piece

33

34 //next 4 lines to apply piece value to json struct

35 piece_ex["letter"] = piece_array[i].letter;

36 piece_ex["wild"] = piece_array[i].wild;

37 piece_ex["x"] = piece_array[i].x;

38 piece_ex["y"] = piece_array[i].y;

39 pieces.append(piece_ex);//ok,yes we just have apply One piece ,then push back to the array

40 }

41 var["piece_array"] = pieces;//yes,store pieces in var [Value]

42 root.append(var);

43

44 Json::FastWriter writer;

45 return writer.write(var);//generate json string:),here all is done

46 }

上面这段代码还是相对用到了jsoncpp的大部分编码功能的，用来将数据编码称为json字符串，下面会仔细的分析这段代码

1.首先请看注释中的!IN部分，这是这个函数的传入参数。有三个一个是string类型的token，一个是int类型的game_id，一个是 array，用来存储所有的piece。看!OUT部分就是所要输出的json格式的字符串。用后面的输出可以看到，这个Json字符串中有一个大的根 object，里头有三样东西，1.token,2.game_id,3.piece_array。

2.encode过程

首先之前已经说过，Value在Jsoncpp中是核心类，Reader和Writer都是用Value的功能。以上代码中有[]操作符来赋值给 Value，Value应该是类似一个map结构的数据仓库，用来用树存储所有的数据，最后转换后来编码称为Json格式的字符串。在编码数组的过程中 Value提供了一个append函数用来附加到Value里面，千万记得我前面说过，Value可以直接存数组。当然，Value的[]操作符不能直接的用数组作为参数，如果能这样就牛了。C++这等编译语言是做不到这么动态的，所以可以看到代码里面其实是Value的嵌套，用Value来实现一个数组元素的赋值，因为数组元素不是一个简单的编译器支持的内部类型，所以需要解开来赋值。

3.encode

最后直接用FastWriter来实现编码输出，这样一个典型的Jsoncpp的编码Json的过程。

再来看一段解码json串的代码

C++语言:

01

30 game_info decode_lobby_data_return_msg(string lobby_data_return_msg){

31 Json::Value root;

32 Json::Reader reader;

33 game_info gi;

34 bool parsedOk = false;

35 parsedOk = reader.parse(lobby_data_return_msg,root,false);//decoding…

36 if (!parsedOk)//decoded failed

37 {

38 cout<<“parsed error!\n“<<reader.getFormatedErrorMessages()<<endl;

39 gi.id = -1000;//game id = -1000,means parsed error!

40 return gi;

41 }

42

43 Json::Value game = root["game"];

44

49 gi.id = game["id"].asInt();

50 gi.creator_id = game["creator_id"].asInt();

51 gi.user_max = game["user_max"].asInt();

52

53 Json::Value template_r = game["template"];

54 gi.template_r.id = template_r["id"].asInt();

55

56 Json::Value users = game["user_array"];//because user_array is a array ,so we must get its element by [for] circle,please see [for] circle below

57 for (int index=0;index < users.size();index++)

58 {

59

63 user_info u;

64 u.id = users[index]["id"].asInt();

65 u.name = users[index]["name"].asString();

66 gi.user_array.push_back(u);

67 }

68

69 return gi;

70 }

这是一段典型的解码json字符串的代码，注释中已经非常明白的写出了该函数的输入和输出，下面简要的分析一下这段代码

1.parse，这个函数在上面的介绍中已经写过，是用来解码字串称为Value格式的数据的函数，然后是要判断函数的返回值，如果返回为 false，那么说明json字串解码错误。

2.当解码成功以后，就是要操作返回的Value值。这里对于如何取Value里头的值，Jsoncpp的Value类提供了两个方法，一个是 get函数，第二个是[]操作符，我个人觉得还是[]好用，传入的参数的json里头的key，你就可以把key所对应的value取出来

3.当提取出来的是数组时，需要逐个提取里面的元素，然后再用Value的转换功能来实现值的提取。Value提供asXXX函数来转换值。

以上的是简要的介绍了Jsoncpp里头的编码和解码功能。