C++ Json到对象的自动序列化和反序列化工作

研究的意义

曾写过一些java和C#的代码，对这种动态语言做的注解和反射等印象深刻，因为太好用了，后来转战C/C++开发，发现这些静态语言虽然有很多优势（优势不谈自己查），但也会因为编写代码时由于没有好的解决办法会有很多重复切繁琐的工作，比如Json数据转实体对象，按照C/C++开发的方式就是编译N个类然后为每个类提供一个toJson和fromJson的方法，有时候在网络通信的过程中会用到大量不同格式的Json数据，就要编写很多的实体类，重复的完成每个类的序列化方法，虽然不难，但繁琐麻烦。

解决办法

为了解决序列化繁琐的问题，我查阅了大量的资料，也自己实践了很多办法，但都没有很有效的办法，像C#或是Java那些定义一个与Json数据格式一致的实体类，添加一个注解等就完成序列化数据到对象中。反正最后大概知道只有谷歌工程师为了偷懒完成了这一过程，但没有找到开源公布出来的库或是代码，最后在多次试验后，找到了解决办法。

解决思路

1. 由于没有反射功能，类需要手动创建
2. 由于类的成员无法动态添加，任何类也无法提前感知类有哪些成员，所以使用带参宏完成所有类创建工作
3. 使用nlohmann/json库完成字符串到Json对象的序列化，字开发JsonSerialize类完成Json到自定义对象序列化工作
4. 由于是初版，有些问题的解决比较暴力，希望有更好解决办法的高手可以提供全新的解决思路
5. 代码开源在git中，地址：https://gitee.com/qin_git/json-serialization.git

测试代码1：简单json序列化

接下来完成演示简单Json序列化代码，例如：序列化此数据为对象===>{“type”:“fruit”, “name”:“apple”,“age”:10,“array”:[100,200,300]}

//1.生成与Json对象一致的对象
//序列化对象
class Test : public JsonSerialize {       //必须继承与JsonSerialize对象
    JSERIALIZE_BEGIN(Test)			//必须以此开头，会为其生成构造函数和拷贝构造等
    JSERIALIZE_DEF_BASICTYPE(Test,string,type)		//定义成员变量，基本的数据如int\char\bool\string等使用此宏，成员名要于接受json的key相等
    JSERIALIZE_DEF_BASICTYPE(Test,string,name)
    JSERIALIZE_DEF_BASICTYPE(Test,int,age)
    JSERIALIZE_DEF_BASICLIST(Test,int,array)		  //接受的array成员数据位json数组，需要使用此宏，该宏会为类生成一个vector<int> array成员变量
    JSERIALIZE_END(Test)			//必须以此结尾，会为类生成SerializeJson和DeSerializeJson函数
};

//1.使用nlohmann/json库完成字符串到json的序列化工作
	json j = json::parse("{\"type\":\"fruit\", \"name\":\"apple\",\"age\":10,\"array\":[100,200,300]}");

//2.使用Test类完成json到对象的序列化工作
	//定义Test对象
    Test t;
    //序列化j为Test对象
    t.SerializeJson(j);

//3.输出序列化结果
	cout << "type : " << t.type << endl;
    cout << "name : " << t.name << endl;
    cout << "age : " << t.age << endl;
    for(int item : t.array){
        cout << "array : " << item << endl;
    }

以上代码输出结果：

	type : fruit
	name : apple
	age : 10
	array : 100
	array : 200
	array : 300

接下来演示对象到Json的反序列化 ：

	Test t2;
    t2.name = "abcd";
    t2.type = "typeTest";
    t2.age = 100;
    t2.array = {500,600,700};
    cout << "反序列化t2 : " << to_string(t2.DeSerialize()) << endl;

以上代码输出结果:

	反序列化t2 : {"age":100,"array":[500,600,700],"name":"abcd","type":"typeTest"}

测试代码2：复杂json序列化

接下来完成演示复杂Json序列化代码，例如：序列化此数据为对象===>{“id”:20,“name”:“zhangsan”,“son”:{“id”:50,“name”:“lisi”},“objectList”:[{“indexID”: “1”,“testData”: “95100000000000991”},{“indexID”: “2”,“testData”: “95100000000000992”}]}

可以看到这个json中有普通成员，有对象成员，有对象集合成员，使用我写的序列化依然可以完成正反序列

1.定义三个序列化对象，提示从Person类看起

class Object : public JsonSerialize{
    JSERIALIZE_BEGIN(Object)
    JSERIALIZE_DEF_BASICTYPE(Object,string,indexID)
    JSERIALIZE_DEF_BASICTYPE(Object,string,testData)
    JSERIALIZE_END(Object)
};

class Son : public JsonSerialize{
    JSERIALIZE_BEGIN(Son)
    JSERIALIZE_DEF_BASICTYPE(Son,int,id)
    JSERIALIZE_DEF_BASICTYPE(Son,string,name)
    JSERIALIZE_END(Son)
};

class Person : public JsonSerialize {
    JSERIALIZE_BEGIN(Person)
    JSERIALIZE_DEF_BASICTYPE(Person,int,id)			
    JSERIALIZE_DEF_BASICTYPE(Person,string,name)
    JSERIALIZE_DEF_OBJECTTYPE(Person,Son,son)		//接受json中的son对象，对象成员使用此宏定义
    JSERIALIZE_DEF_OBJECTLIST(Person,Object,objectList)	//接受json中的objectList对象数组，对象数组使用此宏定义
    JSERIALIZE_END(Person)
};

2.使用nlohmann/json库完成字符串到Json对象的序列化

json j = json::parse("{\"id\":20,\"name\":\"zhangsan\",\"son\":{\"id\":50,\"name\":\"lisi\"},\"objectList\":[{\"indexID\": \"1\",\"testData\": \"95100000000000991\"},{\"indexID\": \"2\",\"testData\": \"95100000000000992\"}]}");

3.使用定义的序列化对象完成序列化工作

Person person;
person.SerializeJson(j);

//输出序列化结果
cout << "person id : " << person.id << endl;
cout << "person name : " << person.name << endl;

cout << "person son id : " << person.son.id << endl;
cout << "person son name : " << person.son.name << endl;

for(auto item : person.objectList){
    cout << "person object indexID : " << item.indexID << endl;
    cout << "person object testData : " << item.testData << endl;
}

4. 以上代码输出结果：

person id : 20
person name : zhangsan
person son id : 50
person son name : lisi
person object indexID : 1
person object testData : 95100000000000991
person object indexID : 2
person object testData : 95100000000000992

5.反序列化

Person person2;
person2.id = 1000;
person2.name = "zhaoliu";
person2.son.id = 2000;
person2.son.name = "qianqi";
for(int i = 0 ; i <= 3; i++){
    Object object;
    object.indexID = "obj" + to_string(i);
    object.testData = "testdata"+ to_string(i);
    person2.objectList.push_back(object);
}

//输出反序列化结果
cout << "person2 Desrialize : " << to_string(person2.DeSerialize()) << endl;

6.以上代码输出结果：

person2 Desrialize : {"id":1000,"name":"zhaoliu","objectList":[{"indexID":"obj0","testData":"testdata0"},{"indexID":"obj1","testData":"testdata1"},{"indexID":"obj2","testData":"testdata2"},{"indexID":"obj3","testData":"testdata3"}],"son":{"id":2000,"name":"qianqi"}}

结语

以上代码皆在git中有提供，详细可查看git中的main.cpp代码，欢迎审阅源代码后有优化的建议提供，一起学习成长，感谢！