將對象序列化爲XML

Question

我有一個繼承的C＃類。我已經成功「構建」了這個對象。但我需要將對象序列化爲XML。有沒有簡單的方法來做到這一點？

它看起來像類已設置了序列化，但我不知道如何讓XML表示。我的類定義是這樣的：

[System.CodeDom.Compiler.GeneratedCodeAttribute("xsd", "4.0.30319.1")] 
[System.SerializableAttribute()] 
[System.Diagnostics.DebuggerStepThroughAttribute()] 
[System.ComponentModel.DesignerCategoryAttribute("code")] 
[System.Xml.Serialization.XmlTypeAttribute(AnonymousType = true, Namespace = "http://www.domain.com/test")] 
[System.Xml.Serialization.XmlRootAttribute(Namespace = "http://www.domain.com/test", IsNullable = false)] 
public partial class MyObject 
{ 
    ... 
} 

這是我想我能做到，但它不工作：

MyObject o = new MyObject(); 
// Set o properties 
string xml = o.ToString(); 

我如何獲得此對象的XML表示？

Answer 1

你必須使用XmlSerializer的用於XML序列化。以下是一個示例代碼片段。

XmlSerializer xsSubmit = new XmlSerializer(typeof(MyObject)); 
var subReq = new MyObject(); 
var xml = ""; 

using(var sww = new StringWriter()) 
{ 
    using(XmlWriter writer = XmlWriter.Create(sww)) 
    { 
     xsSubmit.Serialize(writer, subReq); 
     xml = sww.ToString(); // Your XML 
    } 
} 

Answer 2

Here is a good tutorial on how to do this

你應該基本上是用System.Xml.Serialization.XmlSerializer類來做到這一點。

Answer 3

序列化一個對象，這樣做：

using (StreamWriter myWriter = new StreamWriter(path, false)) 
{ 
    XmlSerializer mySerializer = new XmlSerializer(typeof(your_object_type)); 
    mySerializer.Serialize(myWriter, objectToSerialize); 
} 

還記得那對XmlSerializer的工作，你需要一個參數的構造函數。

Answer 4

它比調用類的ToString方法更復雜一點，但不多。

這裏有一個簡單的插入式功能，您可以使用序列化的任何類型的對象。它返回一個包含序列化XML內容的字符串：

public string SerializeObject(object obj) 
{ 
    System.Xml.XmlDocument xmlDoc = new System.Xml.XmlDocument(); 
    System.Xml.Serialization.XmlSerializer serializer = new System.Xml.Serialization.XmlSerializer(obj.GetType()); 
    using (System.IO.MemoryStream ms = new System.IO.MemoryStream()) { 
     serializer.Serialize(ms, obj); 
     ms.Position = 0; 
     xmlDoc.Load(ms); 
     return xmlDoc.InnerXml; 
    } 
} 

Answer 5

您可以使用下面的函數從任何對象獲取序列化的XML。

public static bool Serialize<T>(T value, ref string serializeXml) 
{ 
    if (value == null) 
    { 
     return false; 
    } 
    try 
    { 
     XmlSerializer xmlserializer = new XmlSerializer(typeof(T)); 
     StringWriter stringWriter = new StringWriter(); 
     XmlWriter writer = XmlWriter.Create(stringWriter); 

     xmlserializer.Serialize(writer, value); 

     serializeXml = stringWriter.ToString(); 

     writer.Close(); 
     return true; 
    } 
    catch (Exception ex) 
    { 
     return false; 
    } 
} 

您可以從客戶端調用此函數。

Answer 6

下面的函數可以被複制到任何對象添加一個XML使用System.Xml命名空間保存功能。

/// <summary> 
/// Saves to an xml file 
/// </summary> 
/// <param name="FileName">File path of the new xml file</param> 
public void Save(string FileName) 
{ 
    using (var writer = new System.IO.StreamWriter(FileName)) 
    { 
     var serializer = new XmlSerializer(this.GetType()); 
     serializer.Serialize(writer, this); 
     writer.Flush(); 
    } 
} 

要從保存的文件創建對象，請添加以下函數，並用要創建的對象類型替換[ObjectType]。

/// <summary> 
/// Load an object from an xml file 
/// </summary> 
/// <param name="FileName">Xml file name</param> 
/// <returns>The object created from the xml file</returns> 
public static [ObjectType] Load(string FileName) 
{ 
    using (var stream = System.IO.File.OpenRead(FileName)) 
    { 
     var serializer = new XmlSerializer(typeof([ObjectType])); 
     return serializer.Deserialize(stream) as [ObjectType]; 
    } 
} 

Answer 7

我修改了mine來返回一個字符串，而不是像下面那樣使用ref變量。

public static string Serialize<T>(this T value) 
{ 
    if (value == null) 
    { 
     return string.Empty; 
    } 
    try 
    { 
     var xmlserializer = new XmlSerializer(typeof(T)); 
     var stringWriter = new StringWriter(); 
     using (var writer = XmlWriter.Create(stringWriter)) 
     { 
      xmlserializer.Serialize(writer, value); 
      return stringWriter.ToString(); 
     } 
    } 
    catch (Exception ex) 
    { 
     throw new Exception("An error occurred", ex); 
    } 
} 

它的用法是這樣的：

var xmlString = obj.Serialize(); 

Answer 8

擴展類：

using System.IO; 
using System.Xml; 
using System.Xml.Serialization; 

namespace MyProj.Extensions 
{ 
    public static class XmlExtension 
    { 
     public static string Serialize<T>(this T value) 
     { 
      if (value == null) return string.Empty; 

      var xmlSerializer = new XmlSerializer(typeof(T)); 

      using (var stringWriter = new StringWriter()) 
      { 
       using (var xmlWriter = XmlWriter.Create(stringWriter,new XmlWriterSettings{Indent = true})) 
       { 
        xmlSerializer.Serialize(xmlWriter, value); 
        return stringWriter.ToString(); 
       }  
      } 
     } 
    } 
} 

用法：

Foo foo = new Foo{MyProperty="I have been serialized"}; 

string xml = foo.Serialize(); 

只是引用該命名空間牽着你的擴展方法在你想要的文件o使用它，它會工作（在我的例子中，它將是：using MyProj.Extensions;）

請注意，如果您想使擴展方法僅針對特定類（例如，Foo），您可以將T參數在擴展方法中，例如。

public static string Serialize(this Foo value){...}

Answer 9

或者你可以將這個方法添加到您的對象：

public void Save(string filename) 
    { 
     var ser = new XmlSerializer(this.GetType()); 
     using (var stream = new FileStream(filename, FileMode.Create)) 
      ser.Serialize(stream, this); 
    } 

Answer 10

我將開始與本Gripka副本答案：

public void Save(string FileName) 
{ 
    using (var writer = new System.IO.StreamWriter(FileName)) 
    { 
     var serializer = new XmlSerializer(this.GetType()); 
     serializer.Serialize(writer, this); 
     writer.Flush(); 
    } 
} 

我這個代碼之前使用。但現實表明，這個解決方案有點問題。通常，大多數程序員只是在載入時序列化保存和反序列化設置。這是一個樂觀的情景。一旦序列化失敗，由於某種原因，文件被部分寫入，XML文件不完整，並且是無效的。因此，XML反序列化不起作用，您的應用程序可能會在開始時崩潰。如果文件不是很大，我建議首先將對象序列化爲MemoryStream，然後將流寫入文件。如果有一些複雜的自定義序列化，這種情況尤其重要。你永遠不能測試所有的情況。

public void Save(string fileName) 
{ 
    //first serialize the object to memory stream, 
    //in case of exception, the original file is not corrupted 
    using (MemoryStream ms = new MemoryStream()) 
    { 
     var writer = new System.IO.StreamWriter(ms);  
     var serializer = new XmlSerializer(this.GetType()); 
     serializer.Serialize(writer, this); 
     writer.Flush(); 

     //if the serialization succeed, rewrite the file. 
     File.WriteAllBytes(fileName, ms.ToArray()); 
    } 
} 

在現實世界中的場景應該與損壞的序列號文件數的反序列化，它的某個時候發生。 Ben Gripka提供的加載功能很好。

public static [ObjectType] Load(string fileName) 
{ 
    using (var stream = System.IO.File.OpenRead(fileName)) 
    { 
     var serializer = new XmlSerializer(typeof([ObjectType])); 
     return serializer.Deserialize(stream) as [ObjectType];   
    }  
} 

它可以被一些恢復場景包裝。它適用於設置文件或其他可以在出現問題時刪除的文件。

public static [ObjectType] LoadWithRecovery(string fileName) 
{ 
    try 
    { 
     return Load(fileName); 
    } 
    catch(Excetion) 
    { 
     File.Delete(fileName); //delete corrupted settings file 
     return GetFactorySettings(); 
    } 
} 

Answer 11

string FilePath = ConfigurationReader.FileLocation; //Getting path value from web.config    
    XmlSerializer serializer = new XmlSerializer(typeof(Devices)); //typeof(object) 
      MemoryStream memStream = new MemoryStream(); 
      serializer.Serialize(memStream, lstDevices);//lstdevices : I take result as a list. 
      FileStream file = new FileStream(folderName + "\\Data.xml", FileMode.Create, FileAccess.ReadWrite); //foldername:Specify the path to store the xml file 
      memStream.WriteTo(file); 
      file.Close(); 

您可以創建並存儲結果作爲在所需位置xml文件。

Answer 12

我的工作代碼。返回utf8 xml啓用空名稱空間。

// override StringWriter 
public class Utf8StringWriter : StringWriter 
{ 
    public override Encoding Encoding => Encoding.UTF8; 
} 

private string GenerateXmlResponse(Object obj) 
{  
    Type t = obj.GetType(); 

    var xml = ""; 

    using (StringWriter sww = new Utf8StringWriter()) 
    { 
     using (XmlWriter writer = XmlWriter.Create(sww)) 
     { 
      var ns = new XmlSerializerNamespaces(); 
      // add empty namespace 
      ns.Add("", ""); 
      XmlSerializer xsSubmit = new XmlSerializer(t); 
      xsSubmit.Serialize(writer, obj, ns); 
      xml = sww.ToString(); // Your XML 
     } 
    } 
    return xml; 
} 

示例返回響應Yandex的API金說Aviso網址：

<?xml version="1.0" encoding="utf-8"?><paymentAvisoResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" performedDatetime="2017-09-01T16:22:08.9747654+07:00" code="0" shopId="54321" invoiceId="12345" orderSumAmount="10643" /> 

Answer 13

這是一個基本的代碼，這將有助於序列化的C＃對象轉換爲XML：

using System; 

public class clsPerson 
{ 
    public string FirstName; 
    public string MI; 
    public string LastName; 
} 

class class1 
{ 
    static void Main(string[] args) 
    { 
     clsPerson p=new clsPerson(); 
     p.FirstName = "Jeff"; 
     p.MI = "A"; 
     p.LastName = "Price"; 
     System.Xml.Serialization.XmlSerializer x = new System.Xml.Serialization.XmlSerializer(p.GetType()); 
     x.Serialize(Console.Out, p); 
     Console.WriteLine(); 
     Console.ReadLine(); 
    } 
}