C# XML序列化方法及常用特性总结分析

本文实例总结了c# xml序列化方法及常用特性。分享给大家供大家参考，具体如下：

c#对象xml序列化（一）：序列化方法和常用特性

.net framework提供了对应的system.xml.seriazliation.xmlserializer负责把对象序列化到xml，和从xml中反序列化为对象。serializer的使用比较直观，需要多注意的是xml序列化相关的attribute，怎么把这些attribute应用到我们的对象，以及对象公共属性上面去，生成满足预期格式的xml。

这里列出了最常用的方法和特性，涵盖日常大部分的转换工作，希望大家在工作中快速上手。为了给大家直观的印象，这里给出具体的使用代码，为了节省篇幅，代码异常处理没有添加，各位同学使用的时候酌情添加。

1. serializer方法

下面的方法封装了xmlserializer的调用，这里列出了参数最全的一个版本，具体使用的时候需适当添加重载：

public static class xmlserializer
{
  public static void savetoxml(string filepath, object sourceobj, type type, string xmlrootname)
  {
    if (!string.isnullorwhitespace(filepath) && sourceobj != null)
    {
      type = type != null ? type : sourceobj.gettype();
      using (streamwriter writer = new streamwriter(filepath))
      {
        system.xml.serialization.xmlserializer xmlserializer = string.isnullorwhitespace(xmlrootname) ?
          new system.xml.serialization.xmlserializer(type) :
          new system.xml.serialization.xmlserializer(type, new xmlrootattribute(xmlrootname));
        xmlserializer.serialize(writer, sourceobj);
      }
    }
  }
  public static object loadfromxml(string filepath, type type)
  {
    object result = null;
    if (file.exists(filepath))
    {
      using (streamreader reader = new streamreader(filepath))
      {
        system.xml.serialization.xmlserializer xmlserializer = new system.xml.serialization.xmlserializer(type);
        result = xmlserializer.deserialize(reader);
      }
    }
    return result;
  }
}

2. 序列化常用attribute讲解说明：

[xmlrootattribute("mycity", namespace="abc.abc", isnullable=false)]   // 当该类为xml根节点时，以此为根节点名称。
public class city
[xmlattribute("areaname")]  // 表现为xml节点属性。<... areaname="..."/>
public string name
[xmlelementattribute("areaid", isnullable = false)]  // 表现为xml节点。<areaid>...</areaid>
public string id
[xmlarrayattribute("areas")]  // 表现为xml层次结构，根为areas，其所属的每个该集合节点元素名为类名。<areas><area ... /><area ... /></areas>
public area[] areas
[xmlelementattribute("area", isnullable = false)]  // 表现为水平结构的xml节点。<area ... /><area ... />...
public area[] areas
[xmlignoreattribute]  // 忽略该元素的序列化。

3. 详细举例说明

这里用简单的城市，区域和街区作为例子，具体示范一下上面的规则。

[xmlrootattribute("mycity", namespace = "abc.abc", isnullable = false)]
public class city
{
  [xmlattribute("cityname")]
  public string name
  {
    get;
    set;
  }
  [xmlattribute("cityid")]
  public string id
  {
    get;
    set;
  }
  [xmlarrayattribute("areas")]
  public area[] areas
  {
    get;
    set;
  }
}
[xmlrootattribute("myarea")]
public class area
{
  [xmlattribute("areaname")]
  public string name
  {
    get;
    set;
  }
  [xmlelementattribute("areaid", isnullable = false)]
  public string id
  {
    get;
    set;
  }
  [xmlelementattribute("street", isnullable = false)]
  public string[] streets
  {
    get;
    set;
  }
}

根据以上类型，我们mock一些数据，然后用步骤1给出的util方法输出：

static void main(string[] args)
{
  area area1 = new area();
  area1.name = "pudong";
  area1.id = "pd001";
  area1.streets = new string [] { "street 001", "street 002" };
  area area2 = new area();
  area2.name = "xuhui";
  area2.id = "xh002";
  area2.streets = new string [] { "street 003", "street 004" };
  city city1 = new city();
  city1.name = "shanghai";
  city1.id = "sh001";
  city1.areas = new area[] { area1, area2 };
  xmlserializer.savetoxml(@"c:\temp\xml\output003.xml", city1);
}

最终输出的xml为：

<?xml version="1.0" encoding="utf-8"?>
<mycity xmlns:xsi="http://www.w3.org/2001/xmlschema-instance"
xmlns:xsd="http://www.w3.org/2001/xmlschema"
cityname="shanghai" cityid="sh001" xmlns="abc.abc">
 <areas>
  <area areaname="pudong">
   <areaid>pd001</areaid>
   <street>street 001</street>
   <street>street 002</street>
  </area>
  <area areaname="xuhui">
   <areaid>xh002</areaid>
   <street>street 003</street>
   <street>street 004</street>
  </area>
 </areas>
</mycity>

下面我们开始具体分析结果，其中包含一些很有用的结论和注意事项：

1. xml的版本，编码，以及命名空间xmlns:xsi，xmlns:xsd为framework自动添加。
2. 因为我们用city对象作为根节点，所以根节点名称为我们定义的"mycity"。
但是，注意！这里指的是用city自身直接做根节点，如果是city集合比如city[]，此时，该名称失效，系统会自动生成名称arrayofcity作为根节点名称(arrayof+类名)，或者我们手动指定名称，这个就是在给大家的savetoxml（）方法中，参数xmlrootname的作用。
3. 如果以city为根节点并在xmlrootattribute特性中给定名称，同时也手动指定了xmlrootname，系统会以手动指定的名称为准。
4. areaname，areaid，同为area类的公共属性，一个被解释成属性，一个被解释成子节点。
areas集合被解释成了层次结构，streets集合被解释成了水平结构。
这两组区别最能体现不同序列化attribute的用法。

ps：小编这里再来为大家推荐几款关于xml操作的在线工具供大家免费使用。相信在以后开发中可以用的到：

在线xml格式化/压缩工具：

在线xml/json互相转换工具：

xml代码在线格式化美化工具：

html/xml转义字符对照表：

更多关于c#相关内容感兴趣的读者可查看本站专题：《c#中xml文件操作技巧汇总》、《c#常见控件用法教程》、《winform控件用法总结》、《c#数据结构与算法教程》、《c#面向对象程序设计入门教程》及《c#程序设计之线程使用技巧总结》

希望本文所述对大家c#程序设计有所帮助。