序列化庫MessagePack應用（C++）

介紹

MessagePack（簡稱msgpack)是一個小巧而高效的序列化/反序列化庫，支持多種開發語言。官方網站：http://msgpack.org/ 。

下面是官方的一個簡介：

It's like JSON.
but fast and small.

MessagePack is an efficient binary serialization format. It lets you exchange data among multiple languages 
like JSON. But it's faster and smaller. Small integers are encoded into a single byte, and typical short 
strings require only one extra byte in addition to the strings themselves.

 

msgpack支持非常多的開發語言，這篇隨筆只討論在C++代碼中的調用。

 

序列化鍵值對數據

一個經常遇到的應用場景是，我們需要序列化一組鍵值對。這組鍵值對的大小是可變的，值類型也不確定，例如：

key name	key type	value type
type	string	int
ratio	string	double
msg	string	string

 

示例代碼如下：

/*
 * msgpack C++試驗：序列化/反序列化大小可變的非標准map.
 * Author: 趙子清
 * Blog: http://www.cnblogs.com/zzqcn
 *
 * */


#include <msgpack.hpp>
#include <string>
#include <cstring>
#include <iostream>
using namespace std;

int main(int argc, char** argv)
{

    msgpack::sbuffer  sbuf;
    msgpack::packer<msgpack::sbuffer>   pker(&sbuf);

    // 序列化
    pker.pack_map(3);
    pker.pack(string("type"));
    pker.pack(3);
    pker.pack(string("ratio"));
    pker.pack(2.15);
    pker.pack(string("msg"));
    pker.pack(string("hello world"));

    // 反序列化
    msgpack::unpacked  unpack;
    msgpack::unpack(&unpack, sbuf.data(), sbuf.size());

    // 直接輸出結果
    msgpack::object  obj = unpack.get();
    cout << obj << endl;

    // 訪問具體鍵值對
    msgpack::object_kv*  pkv;
    msgpack::object_kv*  pkv_end;
    msgpack::object      pk, pv;
    if(obj.via.map.size > 0)
    {
        pkv = obj.via.map.ptr;
        pkv_end = obj.via.map.ptr + obj.via.map.size;

        do
        {
            pk = pkv->key;
            pv = pkv->val;
            
            cout << pk << ", " << pv << endl;

            ++pkv;
        }
        while (pkv < pkv_end);
    }

    return 0;
}

輸出結果：

{"type"=>3, "ratio"=>2.15, "msg"=>"hello world"}
"type", 3
"ratio", 2.15
"msg", "hello world"

 

序列化自定義類型

msgpack已支持了很多的標准類型，但有時我們會自己定義新的類型，這時，我們必須對新類型做某些修改，以使msgpack可以操作它。

另外，如果你的類型中含有低層指針，則還需要進行一些處理，否則，msgpack只會進行淺拷貝，無法序列化指針所指向的內存數據。

假設我們原本的類型如下：

struct Foo
{
    int  i;
    string  str;
    char*  data;
};

那么要讓msgpack操作它，應修改為如下結構：

struct Foo
{
    int     i;
    string  str;
    // 原始指針類型，內部封裝了pack_raw和pack_raw_body方法
    msgpack::type::raw_ref  data;

    MSGPACK_DEFINE(i, str, data); 
};

下面是完整示例代碼：

/*
 * msgpack C++試驗：序列化/反序列化自定義數據結構.
 * Author: 趙子清
 * Blog: http://www.cnblogs.com/zzqcn
 * */


#include <msgpack.hpp>
#include <string>
#include <cstring>
#include <iostream>
using namespace std;


struct Foo
{
    int     i;
    string  str;
    // 原始指針類型，內部封裝了pack_raw和pack_raw_body方法
    msgpack::type::raw_ref  data;

    MSGPACK_DEFINE(i, str, data); 
};


int main(int argc, char** argv)
{
    Foo  f;
    f.i = 4;
    f.str = "hello world";
    const char* tmp = "msgpack";
    f.data.ptr = tmp;
    f.data.size = strlen(tmp) + 1;

    msgpack::sbuffer  sbuf;
    msgpack::pack(sbuf, f);

    msgpack::unpacked  unpack;
    msgpack::unpack(&unpack, sbuf.data(), sbuf.size());

    msgpack::object  obj = unpack.get();

    Foo f2;
    obj.convert(&f2);

    cout << f2.i << ", " << f2.str << ", ";
    cout << f2.data.ptr << endl;

    return 0;
}

 輸出結果：

4, hello world, msgpack