【C#】读写XML文件总结

一、XML文件

1.本质上就是一个文本文件
2.它在逻辑上是有结构的，由element和attribute组成。

二、反序列化（字节流转对象）的流程

需求1：把整个xml文件读入一个对象

我们倒着往回推，一步步看看需要什么？

0. 定义对象

我们的目的是把文件转变成对象，那这个对象具体怎么定义呢？

将 SerializableAttribute 特性应用于某个类型，以指示可对此类型进行序列化的实例。 如果尝试对没有 SerializableAttribute 特性的类型进行序列化，则会引发异常。
若要防止对字段进行序列化，请应用 NonSerializedAttribute 特性。

比如：

using System;
using System.Xml.Serialization;
//必须添加Serializable属性！

[Serializable]
public class Drive //根结点的类名必须与XML的root保持一致！
{
    [XmlElement("header")]//xml中element的名称可以和变量名不一致
    public header mHeader;
}
[Serializable]
public class header
{
    [XmlElement("road")]//必须正确添加XmlElement和XmlAttribute属性才能被正确解析
    public road[] roads;
}
[Serializable]
public class road
{
    [XmlAttribute("name")]//即使xml中有多余的元素或属性也没关系，因为是按照名称解析的
    public string name;
}

1. 输出对象

执行反序列化函数，我们可以得到具体的对象：

反序列化是读取 XML 文档并构造强类型化到该文档 (XSD) 的对象的过程。
在反序列化之前， XmlSerializer 必须使用要反序列化的对象的类型来构造。

//【1】构造XmlSerializer类的实例
XmlSerializer serializer = new XmlSerializer(typeof(OrderedItem));
//【2】执行实例的Deserialize方法，就可以得到目标对象
OrderedItem  i = (OrderedItem)serializer.Deserialize(reader);

查阅API文档，发现此方法的参数有几种，我们可以举Stream和TextReader的例子：

使用 stream 参数指定派生自类的对象 Stream ，该类旨在写入流。 派生自类的类 Stream 包括：

• BufferedStream
• FileStream
• MemoryStream
• NetworkStream
• CryptoStream

2.输出Stream/TextReader…

主要就是需要一个path作为参数

//【1】直接得到FileStream
FileStream fs = File.Open(path, FileMode.Open);
FileStream fileStream = new FileStream(path, FileMode.Open, FileAccess.Read);

//【2】直接得到TextReader
TextReader tr = File.OpenText("e:\\TextWriter.txt")
StreamReader sr = new StreamReader("c:/jamaica.txt")//继承自TextReader

//【3】先得到string，再转为bytes，创建MemoryStream
string text= File.ReadAllText(path);
var stream = new MemoryStream(Encoding.UTF8.GetBytes(text));

案例代码如下：

public Drive Func1()
{
    string path = Application.dataPath + "/XMLFiles/test.xml";
    Drive od = new Drive();
    List<road> roads;
    //创建XmlSerializer实例
    XmlSerializer serializer = new XmlSerializer(typeof(Drive));
    //打开文件，调用Deserialize函数
    using (var fs = new FileStream(path, FileMode.Open))
    {
        od = (Drive)serializer.Deserialize(fs);
    }
    roads = new List<road>(od.mHeader.roads);
    for (int i = 0; i < roads.Count; i++)
    {
        Debug.Log(roads[i].name);
    }
    return od;
}

需求2：把xml读入为一棵树

public void Func2()
{
    string path = Application.dataPath + "/XMLFiles/test.xml";
    List<MRoad> roads = new List<MRoad>();
	
	//创建XmlDocument对象
    XmlDocument doc = new XmlDocument();
    //用fs填充doc
    using (var fs = new FileStream(path, FileMode.Open))
    {
        doc.Load(fs);
    }
	//可以用类似js中dom的操作获取每个节点的内容
    XmlNode headerNode = doc.GetElementsByTagName("header")[0];
    XmlNodeList elems = headerNode.ChildNodes;
    foreach (XmlNode elem in elems)
    {
        if(elem.Name=="road")roads.Add(new MRoad() {name = elem.Attributes["name"].InnerText});
    }

    foreach (var road in roads)
    {
        Debug.Log(road.name);
    }
}

三、序列化（对象转字节）的流程

方法1：使用XmlSerializer

 string path = Application.dataPath + "/XMLFiles/w1.xml";
 Drive od = readxml.Func1();

 XmlSerializer serializer = new XmlSerializer(typeof(Drive));

 using (var fs = new FileStream(path, FileMode.Create))
 {
     serializer.Serialize(fs,od);
 }

方法2：使用XmlTextWriter

string path = Application.dataPath + "/XMLFiles/w2.xml";
List<MRoad> roads = new List<MRoad>(readxml.Func2());

XmlWriter w = new XmlTextWriter(path,null);
w.WriteStartElement("Drive");
    w.WriteStartElement("header");
    foreach (var road in roads)
    {
        w.WriteStartElement("road");
        w.WriteAttributeString("name", road.name);
        w.WriteEndElement();
    }
    w.WriteEndElement();
w.WriteEndElement();
w.Close();

四、总结

使用XmlSerializer比XmlDocument方便很多！

因为我们大多数时候并需要知道文档对象模型中每个节点的值。