# cpp-serialization

**Repository Path**: CJyoungNeverGivesUp/cpp-serialization

## Basic Information

- **Project Name**: cpp-serialization
- **Description**: C++对象序列化、反序列化，
使用C11与rapidJson，自动完成序列化与反序列化，支持动态数组，可扩展类型，
Header-only，包含头文件即可直接使用，无其他依赖。
- **Primary Language**: C++
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2022-11-03
- **Last Updated**: 2022-11-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# cpp-serialization

#### 介绍
- C++对象序列化、反序列化，支持Array
- 使用C11与rapidJson，自动完成可扩展类型的序列化与反序列化，
- Header-only，包含头文件即可直接使用，无其他依赖。

#### 软件架构
借助C++11新特性 + 宏 + rapidjson，
可扩展对象类型，支持动态数据

#### 安装教程

1.  复制source中的文件到你的工程
2.  include "serialize.hpp"
3.  即可使用

#### 使用说明

1.  简单对象使用如下：

```
    PropertyObject<int> my("Speed",10);
    my.Set(333);
    std::string str = my.Serialize(); //序列化

    PropertyObject<int> my2("Speed", 0);
    bool bSuccess = my2.DeSerialize(str );
    int nSpeed = my2.Get();
    
    // 可以通过name来区分判断json数据
    std::string name = my2.GetName();
```


2.  继承SerializeBase类可实现对象组合用法，支持动态数组，详见example文件夹

```
// 定义一个类（需继承自SerializeBase）

class CarInfo: public SerializeBase
{
public:
	GroupName(CarInfo);

	Property(Speed, int, 0);
	Property(volume, int, 0);
	Property(Light, bool, false);
	Property(Temp, float, 0.f);
	Property(Name, std::string, "Mengziqing");

	PropertyArray(ArrayInt, int);
}

// Serialize
CarInfo obj;
std::string nameSpace = obj.GetGroupName();
obj.SetSpeed(28);
obj.AddArrayInt(22);
obj.AddArrayInt(66);
std::string strJson = test.ToSerializeString();

// DeSerialize
CarInfo recieveObj;
bool bSuccess = recieveObj.FromSerializeString(strJson);
std::vector<int> vecInt = recieveObj.GetArrayInt();
int speed =  recieveObj.GetSpeed();
```

3.  宏的使用 
- GroupName：为类提供一个命名空间，在生成json时会作为root对象的名称，不提供则为空。
- Property：定义一个属性
- PropertyArray：定义一个属性数组

4.  数据类型支持扩展

除了支持基本的bool,int,long,float,double,string类型外，还通过以下方式扩展

```
class PropertyObjectCustom : public PropertyBase
{
public:
        // 按保存的结构实现序列化接口
        virtual std::string Serialize() override {...}
 
        // 按保存的结构实现反序列化接口
        virtual bool DeSerialize(std::string& data) override {...}

private:
	StructCustom m_data;
}
```
请参照example目录下的extend.cpp

5.  未来的版本将考虑以下特性：
- 支持属性发生改变时发出PropertyChanged事件
- SetProperty后自动调用发送json字符串的回调
- 支持配置只发送变化的数据……





#### 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request
5.  管理员审核通过合并