项目总结之xml序列化与反序列化

最近几乎做到的每个项目都用到了XML反序列化为实体的功能，因为这个功能用来配置参数或者读取数据都很方便，只需要定义出和XML文档结构一致的实体就可以超快转换数据（读取或者生成XML）。

读取

先找个XML文件来吧！为了比较有突出的说明，这里我用SVN导出的信息xml作为读取模板。
首先从SVN中导出详细列表XML文件：

D:\WORK\SVN>svn list -R --username Test --password test --xml https://LAPTOP-08GBIJJ9/svn/分析软件/ > D:/12.xml

XML文件导出后的结构如下：按照这个xml文件的结构就可以定义实体了

[System.Xml.Serialization.XmlRoot("lists")]
public class SvnFileEntity
{
    [System.Xml.Serialization.XmlElement("list")]
    public SvnFileListEntity ListEntity { get; set; }
    public SvnFileEntity()
    {
        ListEntity = new SvnFileListEntity();
    }
}
public class SvnFileListEntity
{
    [System.Xml.Serialization.XmlAttribute("path")]
    public string Path { get; set; }
    [System.Xml.Serialization.XmlElement("entry")]
    public List<SvnFileEntryEntity> ListSvnFileEntryEntity { get; set;}
    public SvnFileListEntity()
    {
        ListSvnFileEntryEntity = new List<SvnFileEntryEntity>();
    }
}
public class SvnFileEntryEntity
{
     [System.Xml.Serialization.XmlAttribute("kind")]
     public string Kind { get; set; }
     [System.Xml.Serialization.XmlElement("name")]
     public string Name { get; set; }
     [System.Xml.Serialization.XmlElement("commit")]
     public SvnCommitEntity CommitEntity { get; set; }
     public SvnFileEntryEntity()
     {
         CommitEntity = new SvnCommitEntity();
     }
}
public class SvnCommitEntity
{
     [System.Xml.Serialization.XmlAttribute("revision")]
     public int Revision { get; set; }
     [System.Xml.Serialization.XmlElement("author")]
     public string Author { get; set; }
     [System.Xml.Serialization.XmlElement("date")]
     public string Date { get; set; }
}

对应xml文件结构的实体就完成了，无非就是对应节点声明对应变量或者数组。但是需要注意的是每个声明上必须注明对应xml文件的结构类型。如代码中所明的 [System.Xml.Serialization.XmlElement(“date”)]是xml哪个属性哪个元素？这样在序列化读取时才可以准确的找到对应节点和属性。
当然对于xml文件结构简单的，也不是非得声明对应的节点或者属性，但是实体的结构和名称就必须完全匹配xml文档。
例如我写一个很简单的：

public class ProcessEntity
{
    public Item[] ProcessItems { get; set; }
}
public class Item
{
    public string ProcessName
    {
        get;set;
    }
    public string ProcessID
    {
        get;set;
    }
    public string ProcessPath
    {
        get;set;
    }
}

如上就是对应xml文档完全结构一致的实体
下面几行代码就可以转换读取：

using System.Xml.Serialization;
public void ReadXml(string filepath)
{
     if (!File.Exists(filepath)) return -1;            
     XmlSerializer sz = new XmlSerializer(typeof(SvnFileEntity));
     using (FileStream fileStream = new FileStream(filepath, FileMode.Open, FileAccess.Read))
     {
         SvnFileEntity pList = (SvnFileEntity)sz.Deserialize(fileStream);
     }
}

生成xml

序列化生成xml文档其实重要的也是对实体的建立，只是相对于上面的实体还需要再类外声明一个可序列化操作[Serializable]例如：

 [Serializable]
 [System.Xml.Serialization.XmlRoot("lists")]
 public class SvnFileEntity
 {
     [System.Xml.Serialization.XmlElement("list")]
     public SvnFileListEntity ListEntity { get; set; }
     public SvnFileEntity()
     {
        ListEntity = new SvnFileListEntity();
     }
}

然后操作序列化：

 public void serialize_to_xml(string path, object obj) 
 {
     XmlSerializer serializer = new XmlSerializer(obj.GetType());
     //serialize
     using (StringWriter writer = new StringWriter()) {
        serializer.Serialize(writer, obj);
        content = writer.ToString();
     }
     //save to file
     using (StreamWriter stream_writer = new StreamWriter(path)) {
         stream_writer.Write(content);
     }
}