轻松将整个类实例写入XML文件并重新读入

我有一个名为theGarage的主类,它包含我们的客户,供应商和工作类的实例。

我想将程序数据保存到XML文件,我使用了下面的代码(只是一个片段,我有其他类的匹配代码)。 我想知道是否有一种更简单的方法来执行此操作,例如将整个theGarage类写入XML文件并将其读入,而无需像下面那样编写所有这些代码。

  public void saveToFile() { using (XmlWriter writer = XmlWriter.Create("theGarage.xml")) { writer.WriteStartDocument(); /// writer.WriteStartElement("theGarage"); writer.WriteStartElement("Customers"); foreach (Customer Customer in Program.theGarage.Customers) { writer.WriteStartElement("Customer"); writer.WriteElementString("FirstName", Customer.FirstName); writer.WriteElementString("LastName", Customer.LastName); writer.WriteElementString("Address1", Customer.Address1); writer.WriteElementString("Address2", Customer.Address2); writer.WriteElementString("Town", Customer.Town); writer.WriteElementString("County", Customer.County); writer.WriteElementString("PostCode", Customer.Postcode); writer.WriteElementString("TelephoneHome", Customer.TelephoneHome); writer.WriteElementString("TelephoneMob", Customer.TelephoneMob); //begin vehicle list writer.WriteStartElement("Vehicles"); foreach (Vehicle Vehicle in Customer.Cars) { writer.WriteStartElement("Vehicle"); writer.WriteElementString("Make", Vehicle.Make); writer.WriteElementString("Model", Vehicle.Model); writer.WriteElementString("Colour", Vehicle.Colour); writer.WriteElementString("EngineSize", Vehicle.EngineSize); writer.WriteElementString("Registration", Vehicle.Registration); writer.WriteElementString("Year", Vehicle.YearOfFirstReg); writer.WriteEndElement(); } writer.WriteEndElement(); writer.WriteEndElement(); } } } 

有更简单的序列化对象的方法,而是使用XmlSerializer 。 请参阅此处的文档

将车库序列化为文件的代码片段可能如下所示:

 var garage = new theGarage(); // TODO init your garage.. XmlSerializer xs = new XmlSerializer(typeof(theGarage)); TextWriter tw = new StreamWriter(@"c:\temp\garage.xml"); xs.Serialize(tw, garage); 

和从文件加载车库的代码:

 using(var sr = new StreamReader(@"c:\temp\garage.xml")) { garage = (theGarage)xs.Deserialize(sr); } 

如果有几个漂亮的扩展方法,那么你可以轻松地读/写这个文件。

 public static class Extensions { public static string ToXml(this object obj) { XmlSerializer s = new XmlSerializer(obj.GetType()); using (StringWriter writer = new StringWriter()) { s.Serialize(writer, obj); return writer.ToString(); } } public static T FromXml(this string data) { XmlSerializer s = new XmlSerializer(typeof(T)); using (StringReader reader = new StringReader(data)) { object obj = s.Deserialize(reader); return (T)obj; } } } 

  var xmlData = myObject.ToXml(); var anotherObject = xmlData.FromXml(); 

我刚写了一篇关于将对象数据保存到Binary,XML或Json的博客文章 。 以下是向/从XML写入和读取类实例的函数。 有关详细信息,请参阅我的博文。

需要System.Xml程序集包含在项目中。

 ///  /// Writes the given object instance to an XML file. /// Only Public properties and variables will be written to the file. These can be any type though, even other classes. /// If there are public properties/variables that you do not want written to the file, decorate them with the [XmlIgnore] attribute. /// Object type must have a parameterless constructor. ///  /// The type of object being written to the file. /// The file path to write the object instance to. /// The object instance to write to the file. /// If false the file will be overwritten if it already exists. If true the contents will be appended to the file. public static void WriteToXmlFile(string filePath, T objectToWrite, bool append = false) where T : new() { TextWriter writer = null; try { var serializer = new XmlSerializer(typeof(T)); writer = new StreamWriter(filePath, append); serializer.Serialize(writer, objectToWrite); } finally { if (writer != null) writer.Close(); } } ///  /// Reads an object instance from an XML file. /// Object type must have a parameterless constructor. ///  /// The type of object to read from the file. /// The file path to read the object instance from. /// Returns a new instance of the object read from the XML file. public static T ReadFromXmlFile(string filePath) where T : new() { TextReader reader = null; try { var serializer = new XmlSerializer(typeof(T)); reader = new StreamReader(filePath); return (T)serializer.Deserialize(reader); } finally { if (reader != null) reader.Close(); } } 

 // Write the list of salesman objects to file. WriteToXmlFile("C:\TheGarage.txt", customer); // Read the list of salesman objects from the file back into a variable. Customer customer = ReadFromXmlFile("C:\TheGarage.txt"); 

对于我的项目,我使用DataContractSerializer 。 我与XmlSerializer相比,它可以处理对同一对象的多个引用,使得数据不会在xml中重复并恢复为已保存。