Serializacja obiektu jako XML UTF-8 w .NET

Prawidłowe usuwanie obiektów zostało usunięte dla zwięzłości, ale jestem zszokowany, jeśli jest to najprostszy sposób zakodowania obiektu jako UTF-8 w pamięci. Musi być łatwiejszy sposób, prawda?

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

Twój kod nie umieszcza UTF-8 w pamięci, gdy odczytujesz go z powrotem w łańcuchu, więc nie jest już w UTF-8, ale z powrotem w UTF-16 (chociaż najlepiej byłoby rozważyć łańcuchy na wyższym poziomie niż jakiekolwiek kodowanie, z wyjątkiem sytuacji, gdy jest to do tego zmuszone).

Aby uzyskać rzeczywiste oktety UTF-8, możesz użyć:

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

Pominąłem tę samą dyspozycję, którą zostawiłeś. Nieznacznie preferuję następujące (z pozostawieniem normalnej utylizacji):

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

Jest to mniej więcej taka sama złożoność, ale pokazuje, że na każdym etapie istnieje rozsądny wybór zrobienia czegoś innego, z czego najpilniejszą jest serializacja do innego miejsca niż do pamięci, na przykład do pliku TCP / IP strumień, baza danych itp. Podsumowując, nie jest to aż tak szczegółowe.

Nie, możesz użyć a, StringWriteraby pozbyć się półproduktu MemoryStream. Jednak, aby wymusić na XML, musisz użyć a, StringWriterktóry zastępuje Encodingwłaściwość:

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

Lub jeśli jeszcze nie używasz C # 6:

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

Następnie:

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

Oczywiście możesz uczynić Utf8StringWriterbardziej ogólną klasę, która akceptuje dowolne kodowanie w swoim konstruktorze - ale z mojego doświadczenia wynika, że ​​UTF-8 jest zdecydowanie najczęściej wymaganym "niestandardowym" kodowaniem dla StringWriter:)

Teraz, jak mówi Jon Hanna, nadal będzie to wewnętrznie UTF-16, ale prawdopodobnie w pewnym momencie przekażesz go do czegoś innego, aby przekonwertować go na dane binarne ... w tym momencie możesz użyć powyższego ciągu, przekonwertuj go na bajty UTF-8 i wszystko będzie dobrze - ponieważ deklaracja XML określi "utf-8" jako kodowanie.

EDYCJA: Krótki, ale kompletny przykład pokazujący, jak działa:

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

Wynik:

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

Zwróć uwagę na deklarowane kodowanie „utf-8”, które, jak sądzę, było tym, czego chcieliśmy.

Bardzo dobra odpowiedź wykorzystująca dziedziczenie, pamiętaj tylko o nadpisaniu inicjalizatora

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

Znalazłem ten wpis na blogu, który bardzo dobrze wyjaśnia problem i definiuje kilka różnych rozwiązań:

(usunięto martwy link)

Zdecydowałem się na pomysł, że najlepszym sposobem na to jest całkowite pominięcie deklaracji XML w pamięci. W rzeczywistości i tak jest to UTF-16, ale deklaracja XML nie wydaje się sensowna, dopóki nie zostanie zapisana w pliku z określonym kodowaniem; i nawet wtedy deklaracja nie jest wymagana. Przynajmniej nie wydaje się przerywać deserializacji.

Jak wspomina @Jon Hanna, można to zrobić za pomocą XmlWriter utworzonego w następujący sposób:

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