オブジェクトをXMLにシリアル化する

継承した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表現を取得するにはどうすればよいですか？

XMLシリアル化にはXmlSerializerを使用する必要があります。以下はサンプルスニペットです。

 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
     }
 }

以下のように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();

次の関数を任意のオブジェクトにコピーして、System.Xml名前空間を使用して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];
    }
}

拡張クラス：

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();

それを使用したいファイルで拡張メソッドを保持している名前空間を参照するだけで機能します（私の例では次のようになります： using MyProj.Extensions;）

拡張メソッドを特定のクラス（たとえばFoo）だけに固有にしたい場合は、拡張メソッドのT引数を置き換えることができます。

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

以下のような関数を使用して、任意のオブジェクトからシリアル化された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;
    }
}

これはクライアントから呼び出すことができます。

オブジェクトをシリアル化するには、次のようにします。

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

XmlSerializerが機能するためには、パラメーターのないコンストラクターが必要であることも覚えておいてください。

まず、Ben 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();
    }
}

上記のすべての投票された答えは正しいです。これは最も単純なバージョンです。

private string Serialize(Object o)
{
    using (var writer = new StringWriter())
    {
        new XmlSerializer(o.GetType()).Serialize(writer, o);
        return writer.ToString();
    }
}

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;
    }
}

これは、これを行う方法に関する優れたチュートリアルです

System.Xml.Serialization.XmlSerializerこれを行うには、基本的にクラスを使用する必要があります。

    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ファイルとして目的の場所に保存できます。

私の仕事のコード。空の名前空間を有効にする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 URLを返します。

<?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" />

私はC＃を使用してオブジェクトをXMLにシリアル化する簡単な方法があります。それは非常にうまく機能し、再利用性が高いです。私はこれが古いスレッドであることを知っていますが、誰かが役立つと思うかもしれないので、投稿したかったのです。

これが私がメソッドを呼び出す方法です：

var objectToSerialize = new MyObject();
var xmlString = objectToSerialize.ToXmlString();

作業を行うクラスは次のとおりです。

注：これらは拡張メソッドであるため、静的クラスに存在する必要があります。

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

public static class XmlTools
{
    public static string ToXmlString<T>(this T input)
    {
        using (var writer = new StringWriter())
        {
            input.ToXml(writer);
            return writer.ToString();
        }
    }

    private static void ToXml<T>(this T objectToSerialize, StringWriter writer)
    {
        new XmlSerializer(typeof(T)).Serialize(writer, objectToSerialize);
    }
}

上記のソリューションに基づいて、オブジェクトをシリアル化および逆シリアル化するために使用できる拡張クラスが提供されます。その他のXML属性は自由に設定できます。

次のように使用してください：

        string s = new MyObject().Serialize(); // to serialize into a string
        MyObject b = s.Deserialize<MyObject>();// deserialize from a string



internal static class Extensions
{
    public static T Deserialize<T>(this string value)
    {
        var xmlSerializer = new XmlSerializer(typeof(T));

        return (T)xmlSerializer.Deserialize(new StringReader(value));
    }

    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();
            }
        }
    }
}

または、このメソッドをオブジェクトに追加できます。

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

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();
   }
}    

public string ObjectToXML(object input)
{
    try
    {
        var stringwriter = new System.IO.StringWriter();
        var serializer = new XmlSerializer(input.GetType());
        serializer.Serialize(stringwriter, input);
        return stringwriter.ToString();
    }
    catch (Exception ex)
    {
        if (ex.InnerException != null)
            ex = ex.InnerException;

        return "Could not convert: " + ex.Message;
    }
}

//Usage
var res = ObjectToXML(obj)

次のクラスを使用する必要があります。

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