C++中struct序列化为xml的简易实现

刺瞎我的狗眼！！！

听说C#有一个功能，能自动将一个struct的对象序列化成xml，也能将xml反序列化成对应的struct对象，C++木有，好吧，我承认，C++木有的东西还很多。。。。。。

把struct序列化为xml有虾米好处呢？想了半天，想到的我都用不上，唯一的好处，打发最近无聊的时间。

 

时间有限，不能整复杂了，免得收不了场，一切从简。

比如有struct定义如下：

struct Test

{

    int nItem;

    bool bItem;

}

 

这样一个最基本的struct定义，序列化为xml，基本效果应该为：

<struct>

    <item>

        <type>int</type>

        <name>nItem</name>

        <value>123</value>

    </item>

    <item>

        <type>bool</type>

        <name>bItem</name>

        <value>false</value>

    </item>

</struct>

 

要做到这一点，指望运行时是不可能的了，伟大的C++在这方面提供的支持实在惨不忍睹，忽略不计。

现代编程语言貌似都有点往脚本化的方向靠，运行时能获取到几乎所有类，对象的原始数据，C++要做也不是不可以，

只是稍微麻烦一点点（也许仅仅是对我而言，最痛恨字符串解析，好吧，我承认我不会正则表达式。。。）。

一个可行的办法就是，在C++编译器工作之前，人肉获取一份需要保留的类定义信息，有了这个信息，什么java，ruby的反射

之类的问题简直易如反掌，只是不知道做来有啥用。。。。。。也许下次蛋疼的时候会做一个C++的反射（比上次的好）

 

简易实现方法：

1. 解析包含了struct定义的header文件

    1.1 过滤comments

    1.2 过滤#ifndef，#endif，#pragma之类用不上的标记

    1.3 识别简单的#define LENGTH 16这样的标记

    1.4 获取struct定义，生成一个类似符号表的string数组

2. 根据解析得到的string数组，生成一个包含了package和unpackage方法的header文件

3. 需要将struct转换为xml的代码里，包含生成的header，调用Package和UnPackge

 

A: 过滤comments

过滤掉//, /**/包含的内容，这里可用的方法很多了，我用的方法，因为闲，所以比较重量级了

一个略显虚胖的FSM，ICommentState。根据传入的一个一个字节，判断当前状态，将非comments写入一个buffer。

 

B: 过滤不需要的符号

还是简单起见，暂时不支持在struct中定义constructor，destructor和operator

直接过滤#ifndef， #endif， #elif， #pragma， typedef所在的位置

 

C: 查找#define LENGTH 16这样的语句，之后替换所有使用LENGTH为16（我知道有bug，替换[LENGTH]更安全）

 

D: 获取struct的基本信息，包括struct的name，item的type和name

 

到目前为止，一个简单的struct是能够被解析出来的，但是：

1. union是8可能被支持的，太麻烦了。

其实要支持union也不是不可以，只是这里要做的话，会产生一个跟支持char data[1]同样的问题 -- 字节对齐和内存

        复制，还有烦人的符号解析。。。。。。这个是主要问题

        pack(1)可以解决字节对齐的问题，那么还剩下一个内存复制了。

假设支持char data[1]这种写法，就不得不跟支持char*一样，限制使用一个特定命名的length对象，这还不是大问题，

因为char*就是这样实现的，最关键的是struct的大小不固定了，要把数据完整的复制过来，就不得不去掉struct的类型，

进行字节拷贝，之后再强制转型，这个在C语言里面没有任何问题，但是至于C++的话。。。。。。只能说看你怎么用了， 小心驶得万年船，妥协的理由总是很多的。

2. struct的成员函数也是不被支持的，理由一样，还是太麻烦了

当然，无法过滤掉成员函数肯定是一个无法容忍的硬伤，谁爱做谁做

3. 只支持少量基本数据类型，不支持float，甚至连unsigned符号都不支持，理由同上

 

4. 不支持unicode

5. 支持char*，支持char数组

 

剩下的就是生成Package和UnPackge方法供外部调用了，又一个体力活

 

E: Package的生成

Package的生成相对更直接一些，从struct对象到string。

原型： string Package(const StructType& item) // StructType在生成的时候被替换为struct的name

Package方法进行一些字符串处理，将数据打包成xml，这里又是一个偷懒的做法，如果是遇到数组的打包，

数组中出现元素数据为0的情况，直接把0替换为^符号，如果传递的是一个正则表达式，如果用了^，那么。。。。。。

 

F: UnPackage的生成

稍微麻烦一点点，首先要从xml中获取struct的name，之后根据name调用对应的UnPackage方法，如有lalala，

那么就调用char* UnPackagelalala(string strXml)，这里实在是没有更好的返回值可以用了，这个数据的转型

也只能由用户自行完成。

UnPackage把item一条一条从xml中取出，得到itemtype，itemname，value

当然，除了value是在运行时获得的，itemtype和itemname在struct解析的时候都已经得到了

所以，一个简单的模板函数，根据我们需要的类型特化，很简单就能完成从string到value的转换。

 

G: 一点小结

。

 

H: 具体实现

 

1. struct定义文件： teststruct.h

之所以会是现在看到的这个文件，是因为除了定义struct外，还承担了提供基本测试内容的功能，所以不好看

#ifndef _TEST_STRUCT_H #define _TEST_STRUCT_H // lalala /* hahaha /*/ #pragma pack(push) #pragma pack(1) #define TEST_DEFINE 32 struct lalala { char test[32]; char test2[TEST_DEFINE]; int nHahaha; int szTestLength; char* szTest; //int szTest2Length; //char szTest2[1]; I don't think we really need this expression }; struct TestStruct { int nTest; // hahaha bool bTest; /*hhhddd*/ long /*//jajd*/lTest; char cTest; //char* pTest; }; struct TestStruct2 { int nTest; int nTest2; bool bTest; long lTest; char cTest; }; struct TestStruct3 { int nTest; int nTest2; int nTest3; bool bTest; long lTest; char cTest; }; #pragma pack(pop) #endif 

 

 

2. StructData.h

#ifndef _STRUCT_DATA_H #define _STRUCT_DATA_H #include <string> #include <vector> using namespace std; class CStructData { public: CStructData(char* pData, int nLength); ~CStructData(); public: const vector<string>& Parse(); private: char* m_pData; int m_nLength; vector<string> m_vecValues; }; #endif 

 

3. StructData.cpp

#include "StructData.h" #include <memory.h> #include <stdio.h> #include <string.h> CStructData::CStructData(char* pData, int nLength) { m_pData = new char[nLength + 1]; memcpy(m_pData, pData, nLength); m_pData[nLength] = 0; m_nLength = nLength; } CStructData::~CStructData() { delete[] m_pData; } enum ACTION { GET_STRUCT_NAME, GET_ITEM_TYPE, GET_ITEM_NAME, GET_ENDING }; #define COMMON_VALID_CHARACTER / (data >= 'a' && data <= 'z') / || (data >= 'A' && data <= 'Z') / || (data >= '0' && data <= '9') / || data == '_' #define COMMON_ENDING_CHARACTER / (data == ' ' || data == 0x9) #define SET_STRING_PROCESS() / if (nItemStart == -1) / nItemStart = nPos; / nItemEnd = nPos; #define START_NEXT_ACTION(nextAction) / action = nextAction; / string strValue = string(m_pData + nItemStart, nItemEnd - nItemStart + 1); / m_vecValues.push_back(strValue); / nItemStart = -1; / nItemEnd = -1; // const vector<string>& CStructData::Parse() { ACTION action = GET_STRUCT_NAME; int nItemStart = -1; int nItemEnd = -1; for (int nPos = 0; nPos < m_nLength; nPos++) { char data = m_pData[nPos]; switch (action) { case GET_STRUCT_NAME: { if (COMMON_VALID_CHARACTER) { SET_STRING_PROCESS(); } else if (COMMON_ENDING_CHARACTER) { if (nItemStart != -1) { START_NEXT_ACTION(GET_ITEM_TYPE); } } break; } case GET_ITEM_TYPE: { if (COMMON_VALID_CHARACTER || data == '*' || data == '[' || data == ']') { SET_STRING_PROCESS(); } else if (COMMON_ENDING_CHARACTER) { if (nItemStart != -1) { START_NEXT_ACTION(GET_ITEM_NAME); } } break; } case GET_ITEM_NAME: { if (COMMON_VALID_CHARACTER || data == '[' || data == ']') { SET_STRING_PROCESS(); } else if (COMMON_ENDING_CHARACTER || data == ';') { if (nItemStart != -1) { //START_NEXT_ACTION(GET_ITEM_TYPE); action = GET_ITEM_TYPE; string