Serialisieren eines Objekts als UTF-8-XML in .NET

Die ordnungsgemäße Objektentsorgung wurde der Kürze halber entfernt, aber ich bin schockiert, wenn dies der einfachste Weg ist, ein Objekt als UTF-8 im Speicher zu codieren. Es muss einen einfacheren Weg geben, nicht wahr?

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

Ihr Code speichert UTF-8 nicht im Speicher, wenn Sie es erneut in eine Zeichenfolge zurücklesen. Daher ist es nicht mehr in UTF-8, sondern in UTF-16 (obwohl es idealerweise am besten ist, Zeichenfolgen auf einer höheren Ebene als zu berücksichtigen jede Kodierung, außer wenn sie dazu gezwungen wird).

Um die tatsächlichen UTF-8-Oktette zu erhalten, können Sie Folgendes verwenden:

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

Ich habe die gleiche Entsorgung ausgelassen, die Sie übrig haben. Ich bevorzuge leicht Folgendes (bei normaler Entsorgung):

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

Das ist ungefähr die gleiche Komplexität, zeigt aber, dass es in jeder Phase eine vernünftige Wahl gibt, etwas anderes zu tun, von dem die dringendste darin besteht, an einen anderen Ort als in den Speicher zu serialisieren, z. B. in eine Datei, TCP / IP Stream, Datenbank usw. Alles in allem ist es nicht wirklich so ausführlich.

Nein, Sie können a verwenden StringWriter, um das Zwischenprodukt loszuwerden MemoryStream. Um es jedoch in XML zu erzwingen, müssen Sie ein verwenden, StringWriterdas die EncodingEigenschaft überschreibt :

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

Oder wenn Sie C # 6 noch nicht verwenden:

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

Dann:

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

Natürlich können Sie Utf8StringWritereine allgemeinere Klasse erstellen, die jede Codierung in ihrem Konstruktor akzeptiert - aber meiner Erfahrung nach ist UTF-8 bei weitem die am häufigsten erforderliche "benutzerdefinierte" Codierung für eine StringWriter:)

Nun, wie Jon Hanna sagt, wird dies intern immer noch UTF-16 sein, aber vermutlich werden Sie es irgendwann an etwas anderes übergeben, um es in Binärdaten umzuwandeln ... an diesem Punkt können Sie die obige Zeichenfolge verwenden, Konvertieren Sie es in UTF-8-Bytes, und alles wird gut - da in der XML-Deklaration "utf-8" als Codierung angegeben wird.

EDIT: Ein kurzes, aber vollständiges Beispiel, um diese Arbeitsweise zu zeigen:

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

Ergebnis:

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

Beachten Sie die deklarierte Codierung von "utf-8", die wir meiner Meinung nach wollten.

Sehr gute Antwort mit Vererbung, denken Sie daran, den Initialisierer zu überschreiben

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

Ich habe diesen Blog-Beitrag gefunden, der das Problem sehr gut erklärt und einige verschiedene Lösungen definiert:

(toter Link entfernt)

Ich habe mich mit der Idee zufrieden gegeben, dass der beste Weg, dies zu tun, darin besteht, die XML-Deklaration im Speicher vollständig wegzulassen. Es tatsächlich ist UTF-16 an diesem Punkt sowieso, aber die XML - Deklaration scheint nicht sinnvoll , bis sie mit einer bestimmten Codierung in eine Datei geschrieben wurden; und selbst dann ist die Erklärung nicht erforderlich. Zumindest scheint es die Deserialisierung nicht zu brechen.

Wie @Jon Hanna erwähnt, kann dies mit einem XmlWriter erfolgen, der wie folgt erstellt wurde:

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