C++ XML 序列化器

Ling Xu — Wed, 21 Nov 2007 08:06:00 GMT

XML 序列化器

最�q�试囄��写一个C++的XML序列化器�Q�目前实��C��一些基本的功能。�ؓ了开发一个XML序列化器�Q�首先要有XML��d��器（Reader�Q�和书写器（Writer�Q�。我实现了两个简单的XML Reader和Writer�Q?/p>

    class SimpleXmlElement
    {
    public:
        enum NodeType
        {
            UNKNOWN,
            ATTRIBUTE,
            ELEMENT,
            ENDOFELEMENT
        };

    private:
        friend class SimpleXmlReader;

    public:
        NodeType GetType() const;
        const String & GetName() const;
        bool IsEmptyElement() const;

    protected:
        void Reset(NodeType type, const String & name, bool isEmptyElement);

    private:
        NodeType m_type;
        String m_name;
        bool m_isEmptyElement;
    };

    class SimpleXmlAttribute: public SimpleXmlElement
    {
        friend class SimpleXmlReader;

    public:
        const String & GetValue() const;

    protected:
        void Reset(const String & name, const String & val);

    private:
        String m_val;
    };

    class SimpleXmlReader
    {
    public:
        SimpleXmlReader();
        virtual ~SimpleXmlReader();

        virtual void Open(IStream * stream, ICharsetEncoding * encoding = NULL)
        virtual void Open(const void * buffer, SIZE_TYPE length, ICharsetEncoding * encoding = NULL);
        virtual void Open(const void * buffer, int offset, SIZE_TYPE length, ICharsetEncoding * encoding = NULL);

        virtual bool IsEndOfStream() const;
        virtual const SimpleXmlElement * GetNextElement();
        virtual const SimpleXmlAttribute * GetNextAttribute();
        virtual const String GetElementInnerText();

    };

    //-------------------------------------------------------------------------------------------
 
    class SimpleXmlWriter
    {
    public:
        SimpleXmlWriter();
        virtual ~SimpleXmlWriter();

        virtual void Open(ICharsetEncoding * encoding = NULL);
        virtual void Open(IStream * stream, ICharsetEncoding * encoding = NULL);

        virtual void EnterElement(const String & element);
        virtual void AddAttribute(const String & attribute, const String & value);
        virtual void SetElementInnerText(const String & text);
        virtual void LeaveElement();

        virtual const void * GetBuffer();
        virtual SIZE_TYPE GetLength();
    };

在这两个�c�M��Q�IStream是保存数据的��接口，ICharsetEncoding是用于字�W�集转换的编码接口�?/p>

使用�q�两个类��可以进行XML序列化了�?/p>

    class XmlSerializer;

    struct IXmlSerializable
    {
        virtual void Serialize(XmlSerializer * serializer, bool serialize) = 0;
    };

    class XmlTree;

    class XmlSerializer
    {
    public:
        XmlSerializer();
        virtual ~XmlSerializer();

        virtual void OpenSerializer(IStream * stream, ICharsetEncoding * encoding = NULL);
        virtual void OpenDeserializer(IStream * stream, ICharsetEncoding * encoding = NULL);
        virtual void Close();

        virtual void SerializeElement(const String & className, const String & elementName, bool var);
        virtual void SerializeElement(const String & className, const String & elementName, int var);
        virtual void SerializeElement(const String & className, const String & elementName, const String & var);
        virtual void SerializeElement(const String & className, const String & elementName, IXmlSerializable & var);

        virtual void SerializeAttribute(const String & className, const String & elementName, const String & attributeName, bool var);
        virtual void SerializeAttribute(const String & className, const String & elementName, const String & attributeName, int var);
        virtual void SerializeAttribute(const String & className, const String & elementName, const String & attributeName, const String & var);
        
        virtual void DeserializeElement(const String & className, const String & elementName, bool &var);
        virtual void DeserializeElement(const String & className, const String & elementName, int & var);
        virtual void DeserializeElement(const String & className, const String & elementName, String & var);
        virtual void DeserializeElement(const String & className, const String & elementName, IXmlSerializable & var);

        virtual void DeserializeAttribute(const String & className, const String & elementName, const String & attributeName, bool & var);
        virtual void DeserializeAttribute(const String & className, const String & elementName, const String & attributeName, int & var);
        virtual void DeserializeAttribute(const String & className, const String & elementName, const String & attributeName, String & var);
   };

#define BEGIN_XML_SERIALIZER_BASE(className, baseClassName)   \
    virtual void Serialize(XmlSerializer * serializer, bool serialize) \
    {                                                                  \
        const String __className = TEXT(#className);                    \
                                                                       \
        if (IsTypeDerivedFrom::Yes)      \
        {                                                               \
            baseClassName::Serialize(serializer, serialize);            \
        }

#define BEGIN_XML_SERIALIZER(className) \
    virtual void Serialize(XmlSerializer * serializer, bool serialize) \
    {                                                                  \
        const String __className = TEXT(#className);                    

#define END_XML_SERIALIZER()    \
    }

#define XML_ELEMENT(var)        \
        if (serialize)          \
        {                       \
            serializer->SerializeElement(__className, TEXT(#var), var); \
        }   \
        else \
        {   \
            serializer->DeserializeElement(__className, TEXT(#var), var);   \
        }

#define XML_ATTRIBUTE(element, var)      \
        if (serialize)          \
        {                       \
            serializer->SerializeAttribute(__className, TEXT(#element), TEXT(#var), var); \
        }   \
        else \
        { \
            serializer->DeserializeAttribute(__className, TEXT(#element), TEXT(#var), var); \
        }

有一个模板类 IsTypeDerivedFrom用于判断�c�d��T是否从类型U�z��。如果是�Q�那么Yes=1�Q�否则Yes=0�?/p>

��Z��序列化一个类�Q�首先从 IXmlSerializable 接口�z��Q�实际上如果�q�个�c�M��作�ؓ其它序列化类的基�cȝ��化，也可以不用从该接口派生）�Q�然后��?BEGIN_XML_SERIALIZER �Q�对于单独的�c�）或�?BEGIN_XML_SERIALIZER_BASE�Q�对于需要序列化基类的情况）开始定义序列化器。例如：

class ClassA: public IXmlSerializable
{
public:
    BEGIN_XML_SERIALIZER(ClassA)
        XML_ELEMENT(m_data)
        XML_ATTRIBUTE(m_data, m_value)
        XML_ELEMENT(m_bool)
        XML_ELEMENT(m_s)
    END_XML_SERIALIZER();

    ClassA()
        : m_data(0),
          m_value(1),
          m_bool(false),
          m_s(TEXT("Hello"))
    {
    }

    void Reset()
    {
        m_data = -1;
        m_value = 0;
        m_bool = true;
        m_s = TEXT("");
    }

private:
    int m_data;
    int m_value;
    bool m_bool;
    String m_s;
};

class ClassC: public ClassA
{
public:
    BEGIN_XML_SERIALIZER_BASE(ClassC, ClassA)
        XML_ELEMENT(m_data)
        XML_ATTRIBUTE(m_data, m_value)
        XML_ELEMENT(m_bool)
        XML_ELEMENT(m_s)
        XML_ELEMENT(m_a)
    END_XML_SERIALIZER();

    ClassC()
        : m_data(0),
          m_value(1),
          m_bool(false),
          m_s(TEXT("Hello"))
    {
    }

    void Reset()
    {
        m_data = -1;
        m_value = 0;
        m_bool = true;
        m_s = TEXT("");
    }

private:
    int m_data;
    int m_value;
    bool m_bool;
    String m_s;
    ClassA m_a;
};

执行下面的代码：

XmlSerializer serializer;
MemoryStream ms;

ms.Open();
serializer->OpenSerializer(&ms);

ClassC c;

c.Serialize(&serializer, true);

serializer.Close();

const char * buf = static_cast(ms.GetBuffer());

�q�样 buf 中就包含了序列化以后的XML文本�Q�如下：

 
  false
  0
  Hello
 
    false
    0
    Hello
   
  false
  0
  Hello

实际的序列化后的文本是不包含�~�进的，上面�q�样只是��Z��便于��览�?/p>

使用 c.Serialize(&serializer, false) 可以执行反序列化�Q�即�?XML 文本生成对应的对象�?/p>

【限制�?/p>

目前��没有实现对数组的序列化�Q�对于指针，考虑不做序列化，原因在于涉及到内存的分配以及动态多态等问题不是很好解决�?br>

Ling Xu 2007-11-21 16:06 发表评论

亚洲国产美女精品久久久久∴,国产精品日本欧美一区二区三区,黑人一区二区

C++ XML 序列化器