序列化库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