Home

Kapok FAQ

1.Kapok的特点

简单，易用，header-only，只需要引用Kapok.hpp即可，高效，初步测试性能和messagepack相当。 它是纯c++14实现，因此需要支持C++14的编译器。

2.主要功能

对对象进行自动化的序列化和反序列化，用起来非常简单，先来看个序列化/反序列化一个tuple的例子吧。

//序列化  
Serializer sr;  
auto tp = std::make_tuple(10, 12, string("test"));
sr.Serialize(tp);

//反序列化
DeSerializer dr;
std::tuple<int, int, string> p;
dr.Parse(sr.GetString());
dr.Deserialize(p);

看起来是不是很简单！ 再看一个序列化一个自定义对象的例子。

struct Person
{
	int age;
	string name;
	string city;

	META(age, name, city)
};

Person p = { 18, "bb", "aa" };
//序列化
Serializer sr;
sr.Serialize(p);

//反序列化
DeSerializer dr;
Person person;
dr.Parse(sr.GetString());
dr.Deserialize(person);

一样的很简单，结构这里需要一个宏定义META，这个META的作用就是获取对象的元信息，有了这个元信息我们就可以很方便的实现序列化和反序列化了。 更多使用示例在这里。

3.应用场景

Kapok除了不支持指针之外所有的对象都支持，支持结构体的无限嵌套。这里说一下为什么不支持指针呢，因为对象中有指针的话存在两个问题：

• 1.这个指针如果是动态数组的话，c++中无法获取这个数组的长度；
• 2.指针还涉及到内存管理，我希望Kapok专注于序列化和/反序列化，暂时不考虑内存管理。

4.结构体必须有一个宏定义是否具有侵入性？

看起来每个序列化/反序列化的对象都要带一个宏定义似乎侵入性较强，但这种侵入性是完全无害的，因为它只是定义了一个额外的函数而已，这个函数只会在序列化/反序列化的时候才会用到，不会对当前对象造成任何影响，还有一点是因为c++没有反射，必须要通过某种方法来获取对象的元信息，纵观目前所有的序列化方案，只有这种方式是最简洁的，用户做最少的事情即可，这也是我选择这种方式的原因。

5.Kapok是如何实现序列化/反序列化的

Kapok的最底层是用到了rapidjson, 用它来实现对基本类型的序列化，对它做了一个简单的封装以便供上层使用，上面层就是序列化\反序列化实现层，主要是实现对对象元信息的解析和自动化的打包和解包。下面是Kapok序列化的一个示意图：

6.Kapok的性能如何

初步测试对一个tuple进行序列化/反序列化一万次，发现Kapok的耗时和messagepack相当。

7.Kapok是否支持多语言

暂时不支持，先把c++版本做好再说，如果要支持多语言的话，需要用其它语言进行重写，比较麻烦，暂时不考虑多语言。