web-dev-qa-db-ja.com

オブジェクトを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表現を取得する方法

c#xml-serialization
238
user462166

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

以下のようにref変数を使用するのではなく、私は文字列を返すようにmineを変更しました。

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

以下の関数は、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];
    }
}
36
Ben Gripka

以下のような関数を使用して、あらゆるオブジェクトからシリアライズされた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;
    }
}

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

28
Imrul

拡張クラス：

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){...}

28
Aleksandr Albert

オブジェクトを直列化するには、次のようにします。

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

また、XmlSerializerを機能させるには、パラメータのないコンストラクタが必要です。

17
Rox

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にシリアライズしてからストリームをFileに書き込むことをお勧めします。このケースは、複雑なカスタムシリアル化がある場合に特に重要です。あなたはすべてのケースをテストすることはできません。

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

クラスの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;
    }
}
6
Cody Gray

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

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

これを行う方法についてのよいチュートリアルです

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

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

2
Dev Try

私の作業コード戻り値 utf8 xml enable空のネームスペース。

// 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" />
2
dev-siberia

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);
    }
}
1
Tyler Kalosza

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

あるいは、このメソッドをオブジェクトに追加することもできます。

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