.NETでオブジェクトをUTF-8 XMLとしてシリアル化する

適切なオブジェクトの破棄は簡潔にするために削除されましたが、これがオブジェクトをメモリ内でUTF-8としてエンコードする最も簡単な方法であるとは驚きです。より簡単な方法がなければなりませんか？

var serializer = new XmlSerializer(typeof(SomeSerializableObject));

var memoryStream = new MemoryStream();
var streamWriter = new StreamWriter(memoryStream, System.Text.Encoding.UTF8);

serializer.Serialize(streamWriter, entry);

memoryStream.Seek(0, SeekOrigin.Begin);
var streamReader = new StreamReader(memoryStream, System.Text.Encoding.UTF8);
var utf8EncodedXml = streamReader.ReadToEnd();

コードは、再度文字列に読み込むときにUTF-8をメモリに格納しないため、UTF-8ではなく、UTF-16に戻ります（理想的には、より高いレベルの文字列を検討するのが最善ですが）強制する場合を除いて、任意のエンコーディング）。

実際のUTF-8オクテットを取得するには、次を使用できます。

var serializer = new XmlSerializer(typeof(SomeSerializableObject));

var memoryStream = new MemoryStream();
var streamWriter = new StreamWriter(memoryStream, System.Text.Encoding.UTF8);

serializer.Serialize(streamWriter, entry);

byte[] utf8EncodedXml = memoryStream.ToArray();

私はあなたが残したのと同じ処分を省略しました。私は次のことをわずかに好みます（通常の処分は残します）：

var serializer = new XmlSerializer(typeof(SomeSerializableObject));
using(var memStm = new MemoryStream())
using(var  xw = XmlWriter.Create(memStm))
{
  serializer.Serialize(xw, entry);
  var utf8 = memStm.ToArray();
}

これはほぼ同じ量の複雑さですが、すべての段階で何か他のことを実行するための合理的な選択があることを示しています。最も差し迫っているのは、ファイルやTCP / IPなどのメモリ以外の場所にシリアル化することです。ストリーム、データベースなど。全体としては、それほど冗長ではありません。

いいえ、StringWriter中間体を取り除くためにa を使用できますMemoryStream。ただし、強制的にXMLにするにはStringWriter、Encodingプロパティをオーバーライドするを使用する必要があります。

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

または、まだC＃6を使用していない場合：

public class Utf8StringWriter : StringWriter
{
    public override Encoding Encoding { get { return Encoding.UTF8; } }
}

次に：

var serializer = new XmlSerializer(typeof(SomeSerializableObject));
string utf8;
using (StringWriter writer = new Utf8StringWriter())
{
    serializer.Serialize(writer, entry);
    utf8 = writer.ToString();
}

明らかUtf8StringWriterに、コンストラクターで任意のエンコードを受け入れるより一般的なクラスにすることができますが、私の経験では、UTF-8は、StringWriter:)で最も一般的に必要な「カスタム」エンコードです。

これでJon Hannaが言うように、これは内部的にはまだUTF-16ですが、おそらく別の場所にそれを渡してバイナリデータに変換します... その時点で上記の文字列を使用できます。それをUTF-8バイトに変換します。XML宣言では "utf-8"がエンコードとして指定されるため、すべて順調です。

編集：これが機能していることを示す短いが完全な例：

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

public class Test
{    
    public int X { get; set; }

    static void Main()
    {
        Test t = new Test();
        var serializer = new XmlSerializer(typeof(Test));
        string utf8;
        using (StringWriter writer = new Utf8StringWriter())
        {
            serializer.Serialize(writer, t);
            utf8 = writer.ToString();
        }
        Console.WriteLine(utf8);
    }


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

結果：

<?xml version="1.0" encoding="utf-8"?>
<Test xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <X>0</X>
</Test>

「utf-8」の宣言されたエンコーディングに注意してください。これは、私たちが望んでいたものだと思います。

継承を使用した非常に良い答え、初期化子をオーバーライドすることを忘れないでください

public class Utf8StringWriter : StringWriter
{
    public Utf8StringWriter(StringBuilder sb) : base (sb)
    {
    }
    public override Encoding Encoding { get { return Encoding.UTF8; } }
}

私は問題を非常によく説明し、いくつかの異なる解決策を定義するこのブログ投稿を見つけました：

（デッドリンクは削除されました）

私は、それを行うための最良の方法は、メモリ内でXML宣言を完全に省略することであるという考えに落ち着きました。いずれにせよ実際にはその時点では UTF-16ですが、XML宣言は、特定のエンコーディングでファイルに書き込まれるまで意味がありません。それでも、宣言は必要ありません。少なくとも、逆シリアル化を壊すことはないようです。

@Jon Hannaが言及しているように、これは次のように作成されたXmlWriterで実行できます。

XmlWriter writer = XmlWriter.Create (output, new XmlWriterSettings() { OmitXmlDeclaration = true });