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

原文链接：http://hi.baidu.com/tibelf/item/6be2accd177b3d0dc710b295

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的基本功能:

string encode_game_play_msg(string token, int game_id, vector<piece> piece_array) {
    Json::Value root;
    Json::Value var;
    
    // apply “token” and “game_id” value to json struct
    var["token"] = token;
    var["game_id"] = game_id;
    
    // store all pieces
    Json::Value pieces;
    for (int i = 0; i < piece_array.size(); i ++) {
        // here it store just one piece
        Json::Value piece_ex;
        
        // next 4 lines to apply piece value to json struct
        piece_ex["letter"] = piece_array[i].letter;
        piece_ex["wild"] = piece_array[i].wild;
        piece_ex["x"] = piece_array[i].x;
        piece_ex["y"] = piece_array[i].y;
        
        // ok, yes we just have apply One piece, then push back to the array
        pieces.append(piece_ex);
    }
    
    // yes, store pieces in var [Value]
    var["piece_array"] = pieces;
    root.append(var);
    
    Json::FastWriter writer;
    // generate json string:), here all is done
    return writer.write(var);
}

上面这段代码还是相对用到了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串的代码

game_info decode_lobby_data_return_msg(string lobby_data_return_msg) {
    Json::Value root;
    Json::Reader reader;
    game_info gi;
    bool parsedOk = false;
    
    // decoding…
    parsedOk = reader.parse(lobby_data_return_msg,root,false);
    
    // decoded failed
    if (!parsedOk) {
        cout << "parsed error!\n" << reader.getFormatedErrorMessages() << endl;
        // game id = -1000, means parsed error!
        gi.id = -1000;
        return gi;
    }
    
    Json::Value game = root["game"];
    gi.id = game["id"].asInt();
    gi.creator_id = game["creator_id"].asInt();
    gi.user_max = game["user_max"].asInt();
    
    Json::Value template_r = game["template"];
    gi.template_r.id = template_r["id"].asInt();
    
    // because user_array is a array ,so we must get its element by [for] circle,please see [for] circle below
    Json::Value users = game["user_array"];
    for (int index = 0; index < users.size(); index ++) {
        user_info u;
        u.id = users[index]["id"].asInt();
        u.name = users[index]["name"].asString();
        gi.user_array.push_back(u);
    }
    return gi;
}

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

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

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

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

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