共用Windows下C++庫之序列化組件

簡介:

什麼是序列化？簡單來說，序列化就是將對象執行個體的狀態轉換為可保持或傳輸的格式的過程。與序列化相對的是還原序列化，它根據流重構對象。這兩個過程結合起來，可以輕鬆地儲存和傳輸資料。

對象序列化還原序列化通常用於：

1. 將Object Storage Service於硬碟上

2. 在網路上傳送對象的位元組序列

這是一個簡易的序列化組件，代碼不足500行，支援對內建類型、使用者自訂類型、STL容器。

這裡是介紹序列化的Wiki。

這裡是boost的序列化庫。

這裡是Protobuf，強烈建議沒有學習過的同學研究下。

：

CSDN資源

特點：

1. 介面簡單，易於整合，方便維護。
2. 基於Policy-based設計模式
3. 採用C++流式方式方便易用
4. 擴充性強（針對使用者自訂類型，輸出目標）
5. 編譯期對使用者自訂類型偵錯

目標：

1. 用戶端代碼介面簡潔，使使用者代碼短小便捷（滿足）
2. 指標的深度儲存與恢複，儲存指標所指記憶體或恢複資料到指標所指向地區，且能正確處理多個指標（滿足）
3. 對STL容器的支援，能正確處理嵌套容器（滿足）
4. 支援多種儲存方式（目前僅支援檔案與記憶體）
5. 非入侵式實現，不需要從某個特定的類派生或實現特定的成員函數（需要友元函數或者另一個名字空間的自由函數）

內部原理：

Tutorial：

1. 基礎資料測試，char類型資料記憶體緩衝區，寫入任意類實值型別資料，再重新沖讀取，判斷值是否一致

 

void TestBasic(){char buf[1024] = {0};utility::serialize::Serialize os(buf);int b1 = 1;long b2 = 1L;long long b3 = 1LL;double b4 = 1.111;char b5 = 'a';char b6[] = "bc";wchar_t b7 = L'c';wchar_t b8[] = L"Yu";os << b1;os << b2;os << b3;os << b4;os << b5;os << b6;os << b7;os << b8;std::string b9("測試1");std::wstring b10(L"測試2");os << b9;os << b10;char *b11 = "asd";wchar_t *b12 = L"bbb";os << b11 << b12;utility::serialize::Serialize in(buf);int a1 = 0;long a2 = 0L;long long a3 = 0LL;double a4 = 0.0;char a5 = 0;char a6[1024] = {0};wchar_t a7 = L'';wchar_t a8[1024] = {0};std::string a9;std::wstring a10;in >> a1;in >> a2;in >> a3;in >> a4;in >> a5;in >> a6;in >> a7;in >> a8;in >> a9;in >> a10;char tmp1[4] = {0};wchar_t tmp2[4] = {0};char *a11 = tmp1;wchar_t *a12 = tmp2;in >> a11 >> a12;assert(b1 == a1);assert(b2 == a2);assert(b3 == a3);assert(b4 == a4);assert(b5 == a5);assert(strcmp(b6, a6) == 0);assert(b7 == a7);assert(wcscmp(b8, a8) == 0);assert(b9 == a9);assert(b10 == a10);assert(strcmp(b11, a11) == 0);assert(wcscmp(b12, a12) == 0);}

2. 基礎資料測試，wchar_t類型資料記憶體緩衝區，測試目的與測試範例1相同

 

void TestUnicode(){wchar_t buf[1024] = {0};utility::serialize::SerializeW os(buf);int b1 = 1;long b2 = 1L;long long b3 = 1LL;double b4 = 1.111;char b5 = 'a';char b6[] = "bc";wchar_t b7 = L'c';wchar_t b8[] = L"Yu";os << b1;os << b2;os << b3;os << b4;os << b5;os << b6;os << b7;os << b8;std::string b9("測試1");std::wstring b10(L"測試2");os << b9;os << b10;char *b11 = "asd";wchar_t *b12 = L"bbb";os << b11 << b12;utility::serialize::SerializeW in(buf);int a1 = 0;long a2 = 0L;long long a3 = 0LL;double a4 = 0.0;char a5 = 0;char a6[1024] = {0};wchar_t a7 = L'';wchar_t a8[1024] = {0};std::string a9;std::wstring a10;in >> a1;in >> a2;in >> a3;in >> a4;in >> a5;in >> a6;in >> a7;in >> a8;in >> a9;in >> a10;char tmp1[4] = {0};wchar_t tmp2[4] = {0};char *a11 = tmp1;wchar_t *a12 = tmp2;in >> a11 >> a12;assert(b1 == a1);assert(b2 == a2);assert(b3 == a3);assert(b4 == a4);assert(b5 == a5);assert(strcmp(b6, a6) == 0);assert(b7 == a7);assert(wcscmp(b8, a8) == 0);assert(b9 == a9);assert(b10 == a10);assert(strcmp(b11, a11) == 0);assert(wcscmp(b12, a12) == 0);}

3. 數群組類型資料測試，針對數組提供單獨測試案例

 

void TestArray(){char buf[1024] = {0};utility::serialize::Serialize os(buf);char a1[] = "1234";unsigned char a2[] = "QWER";short a3[] = {1, 2, 3, 4};int a4[] = {5, 6, 7, 8};long a5[] = {10, 10, 10, 10};unsigned long long a6[] = {100LL, 100LL, 100LL};os << a1;os << a2;os << a3 << a4 << a5 << a6;char b1[5] = {0};unsigned char b2[5] = {0};short b3[4] = {0};int b4[4] = {0};long b5[4] = {0};unsigned long long b6[3] = {0};os >> b1 >> b2 >> b3 >> b4 >> b5 >> b6;assert(strcmp(b1, a1) == 0);assert(memcmp(b2, a2, _countof(a2)) == 0);assert(memcmp(b3, a3, _countof(a3)) == 0);assert(memcmp(b4, a4, _countof(a4)) == 0);assert(memcmp(b5, a5, _countof(a5)) == 0);assert(memcmp(b6, a6, _countof(a6)) == 0);}

4.自訂資料類型測試，如果自訂資料（非POD類型資料）沒有提供operator<<或operator>>，則由編譯期錯誤

 

struct CustomType{int age_;TCHAR class_[64];std::wstring name_;CustomType(): age_(0){std::fill(class_, class_ + _countof(class_), 0);}CustomType(int age, LPCTSTR cla, LPCTSTR name): age_(age), name_(name){_tcscpy(class_, cla);}};bool operator==(const CustomType &lhs, const CustomType &rhs){return lhs.age_ == rhs.age_ && _tcscmp(lhs.class_, rhs.class_) == 0 &&lhs.name_ == rhs.name_;}utility::serialize::Serialize &operator<<(utility::serialize::Serialize &os, const CustomType &type){os << type.age_ << type.class_ << type.name_;return os;}utility::serialize::Serialize &operator>>(utility::serialize::Serialize &os, CustomType &type){os >> type.age_ >> type.class_ >> type.name_;return os;}void TestClass(){char buf[1024];CustomType customType(10, _T("一年級一班"), _T("王小五"));utility::serialize::Serialize os(buf);os << customType;CustomType dst1, dst2;os >> dst1;os << &customType;os >> dst2;CustomType arr[2] = {CustomType(10, _T("一年級一班"), _T("王小五")),CustomType(11, _T("2年級2班"), _T("王小2"))};os << arr;CustomType brr[2];os >> brr;assert(dst1 == customType); assert(dst2 == customType);for(size_t i = 0; i != _countof(arr); ++i){assert(arr[i] == brr[i]);}};

5. STL容器測試，支援嵌套容器的序列化

void TestContainer(){char buf[1024] = {0};utility::serialize::Serialize os(buf);std::vector<int> a1(10);std::fill(a1.begin(), a1.end(), 10);os << a1;std::vector<int> b1;os >> b1;assert(std::equal(a1.begin(), a1.end(), b1.begin()));std::list<std::string> a2;a2.push_back("chenyu");a2.push_back("test");os << a2;std::list<std::string> b2;os >> b2;assert(std::equal(a2.begin(), a2.begin(), b2.begin()));std::deque<std::wstring> a3;a3.push_back(L"test1");a3.push_back(L"test2");os << a3;std::deque<std::wstring> b3;os >> b3;assert(std::equal(a3.begin(), a3.begin(), b3.begin()));std::set<long> a4;a4.insert(1L);a4.insert(10L);a4.insert(100L);os << a4;std::set<long> b4;os >> b4;assert(std::equal(a4.begin(), a4.begin(), b4.begin()));std::map<std::string, long> a5;a5.insert(std::make_pair("123", 1L));a5.insert(std::make_pair("1234", 10L));a5.insert(std::make_pair("12345", 100L));os << a5;std::map<std::string, long> b5;os >> b5;assert(std::equal(a5.begin(), a5.begin(), b5.begin()));std::multiset<long> a6;a6.insert(1L);a6.insert(10L);a6.insert(10L);a6.insert(10L);a6.insert(100L);a6.insert(100L);os << a6;std::set<long> b6;os >> b6;assert(std::equal(a6.begin(), a6.begin(), b6.begin()));std::multimap<std::string, long> a7;a7.insert(std::make_pair("123", 1L));a7.insert(std::make_pair("123", 1L));a7.insert(std::make_pair("1234", 10L));a7.insert(std::make_pair("1234", 100L));a7.insert(std::make_pair("1234", 1000L));a7.insert(std::make_pair("12345", 100L));os << a7;std::multimap<std::string, long> b7;os >> b7;assert(std::equal(a7.begin(), a7.begin(), b7.begin()));typedef std::map<std::pair<std::string, long>, std::vector<std::wstring>> VecMap;VecMap a8;std::vector<std::wstring> vec;vec.push_back(L"Test");vec.push_back(L"asd");a8.insert(std::make_pair(std::make_pair("10", 10), vec));a8.insert(std::make_pair(std::make_pair("11", 101), vec));a8.insert(std::make_pair(std::make_pair("11", 1011), vec));os << a8;VecMap b8;os >> b8;assert(std::equal(a8.begin(), a8.begin(), b8.begin()));}

 

6. 基礎資料測試，以File為緩衝區，類似測試範例1

void TestFile(){utility::serialize::FileSerialize file("test.txt");int a1 = 10;long a2 = 10L;char a3 = 'c';char a4[] = "chenyu";wchar_t a5[] = L"chenyu";file << a1 << a2 << a3 << a4 << a5;int b1 = 0;long b2 = 0L;char b3 = 0;char b4[1024] = {0};wchar_t b5[1024] = {0};file >> b1 >> b2 >> b3 >> b4 >> b5;assert(a1 == b1);assert(a2 == b2);assert(a3 == b3);assert(strcmp(a4, b4) == 0);assert(wcscmp(a5, b5) == 0);}

 

 

未來的版本變化：

1. 缺乏多線程間同步支援，這個也是理念導致。竊以為，在序列化中，同步應該是使用者層的事情，即需要使用者指定是否需要同步。當然，也可以遵照policy-based的設計方式，提供模板參數，以達到編譯器選擇是否需要同步。
2. 僅支援對象（包括內建類型）的序列化，不支援遠端程序呼叫。以後也不考慮（複雜）
3. 借鑒Protobuf與boost serialize的優勢，本著簡單易用小巧的原則擴充。

：

CSDN資源