dsmarshal 序列化与反序列化项目

一个跨平台的结构体对象序列化与反序列化实现,且源码为HeaderOnly方式,方便朋友们使用。

github地址:https://github.com/kdjie/dsmarshal

例子:

#include <stdio.h>
#include <stdlib.h>

// 引用头文件
#include <dsmarshal/dspacket.h>

int main(int argc, char* argv[])
{
    using namespace dakuang;

    // 定义待序列化的结象结构,要求继承Marshallable
    struct SUser : public Marshallable
    {
        std::string strName;
        int nAge;
        std::vector<std::string> vecBooks;

        // 实现结构内部序列化
        virtual void marshal(DSPack & p) const
        {
            p << strName << nAge << vecBooks;
        }
        // 实现结构内部反序列化
        virtual void unmarshal(const DSUnpack & up)
        {
            up >> strName >> nAge >> vecBooks;
        }

        void show()
        {
            printf("name:[%s] \n", strName.c_str());
            printf("age:[%d] \n", nAge);
            printf("books: \n");
            for (std::vector<std::string>::iterator iter = vecBooks.begin(); iter != vecBooks.end(); ++iter)
            {
                printf("\t %s \n", (*iter).c_str());
            }
        }
    };

    // 定义对象
    SUser stUser1;
    stUser1.strName = "abc123";
    stUser1.nAge = 20;
    stUser1.vecBooks.push_back("a");
    stUser1.vecBooks.push_back("b");
    stUser1.vecBooks.push_back("c");

    // 序列化对象
    std::string strStream;
    Object2String(stUser1, strStream);

    printf("marshal stream size:[%d] \n", strStream.size());

    // 反序列化对象
    SUser stUser2;
    String2Object(strStream, stUser2);

    printf("unmarshal object: \n");
    stUser2.show();

    return 0;
}
编译:

g++ -o test test.cpp -Idsmarshal库所在目录

主要类及方法:

DSPackBuffer

本类为序列化压包缓冲区,内部实现为按块自动分配内存,每块的大小默认为4K。

主要方法:
char * data();
返回缓冲区指针。

size_t size() const;
返回缓冲区数据长度。

void reserve(size_t nSize);
扩充内部容量为指定大小。

void resize(size_t nSize);
扩充或改变缓冲区数据长度为指定大小。

void append(const char * pData, size_t nSize);
向缓冲区尾部插入指定长度的数据。

void append(const char * pData);
向缓冲区尾部插入以C风格结尾的数据。

void replace(size_t nPos, const char * pData, size_t nSize);
替换缓冲区指定位置、指定长度的内存。

DSPack

本类为序列化压包操作实现,但是自己不管理缓冲区,需要在定义时指定DSPackBuffer缓冲区对象。

主要方法:
DSPack(DSPackBuffer & pb, size_t off = 0);
定义序列化压包操作对象。

char * data();
返回本对象指向的缓冲区数据指针。

size_t size();
返回本对象指向的缓冲区数据长度。

DSPack & push(const void * pData, size_t nSize);
向本对象指向的缓冲区压入指定长度的数据。

DSPack & push(const void * pData);
向本对象指向的缓冲区压入以C风格结尾的数据。

DSPack & push_uint8(uint8_t u8);
DSPack & push_uint16(uint16_t u16);
DSPack & push_uint32(uint32_t u32);
DSPack & push_uint64(uint64_t u64);
向本对象指向的缓冲区压入不同类型的整型数据。

DSPack & push_string(const void * pData, size_t nSize);
向本对象指向的缓冲区压入定长度的字符串,但限制最大长度为64K。

DSPack & push_string32(const void * pData, size_t nSize);
向本对象指向的缓冲区压入指定长度的字符串,但限制最大长度为0xFFFFFF。

DSPack & push_string(const void * pData);
向本对象指向的缓冲区压入以C风格结尾的字符串,但限制最大长度为64K。

DSPack & push_string(const std::string & str);
向本对象指向的缓冲区压入std::string的字符串,但限制最大长度为64K。

DSUnpack

本类为反序列化解包操作实现,需要在定义时给定一段缓存区。

主要方法:
DSUnpack(const void * pData, size_t nSize);
定义反序列化解包操作对象。

void reset(const void * pData, size_t nSize) const;
重置解包缓存区。

const char * data();
返回待解包的缓存区地址。

size_t size() const;
返回待解包的缓存区长度。

bool empty() const;
检查待解包的数据长度是否为空。

void finish() const;
检查是否完成解包。

uint8_t pop_uint8(bool bPeek = false) const;
uint16_t pop_uint16(bool bPeek = false) const;
uint32_t pop_uint32(bool bPeek = false) const;
uint64_t pop_uint64(bool bPeek = false) const;
从缓冲区解出指定类型的整数,如果bPeek为true,表示仅查看。

const char * pop_fetch_ptr(size_t nSize) const;
从缓冲区解出指定长度的数据。

std::string pop_fetch_string(size_t nSize) const;
从缓冲区解出指定长度的字符串。

std::string pop_string() const;
从缓冲区解出以push_string()方式压入的字符串。

std::string pop_string32() const;
从缓冲区解出以push_string32()方式压入的字符串。

Marshallable

本类为抽像基类,主要定义了序列化与反序列化的方法。

主要方法:
virtual void marshal(DSPack &) const = 0;
virtual void unmarshal(const DSUnpack &) = 0;

Marshallable对象序列化与反序列化

定义了两个方法:
inline void Object2String(const Marshallable & obj, std::string & str);
将对象序列化为字符串流。

inline bool String2Object(const std::string & str, Marshallable & obj);
从字序串流反序列化对象。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,126评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,254评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,445评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,185评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,178评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,970评论 1 284
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,276评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,927评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,400评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,883评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,997评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,646评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,213评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,204评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,423评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,423评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,722评论 2 345

推荐阅读更多精彩内容