.NET'te bir nesneyi UTF-8 XML olarak serileştirme

Doğru nesne imhası, kısalık için kaldırıldı, ancak bir nesneyi bellekte UTF-8 olarak kodlamanın en basit yolu buysa şok olurum. Daha kolay bir yolu olmalı değil mi?

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

Kodunuz, tekrar bir dizeye okurken UTF-8'i belleğe almaz, bu nedenle artık UTF-8'de değil, UTF-16'ya geri döner (en iyisi dizeleri daha yüksek bir düzeyde dikkate almak en iyisidir. zorunlu olduğu durumlar dışında herhangi bir kodlama).

Gerçek UTF-8 sekizlisini elde etmek için şunları kullanabilirsiniz:

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

Bıraktığın emrinin aynısını bıraktım. Aşağıdakileri biraz tercih ediyorum (normal bertaraf bırakılarak):

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

Bu, aşağı yukarı aynı miktarda karmaşıklık, ancak her aşamada başka bir şey yapmak için makul bir seçim olduğunu gösteriyor; bunlardan en acil olanı, bir dosyaya, TCP / IP'ye, bellekten başka bir yere serileştirmektir. akış, veritabanı, vb. Sonuçta, aslında o kadar ayrıntılı değil.

Hayır, StringWriterara maddeden kurtulmak için a kullanabilirsiniz MemoryStream. Ancak, bunu XML'e zorlamak StringWriteriçin Encodingözelliği geçersiz kılan a kullanmanız gerekir :

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

Veya henüz C # 6 kullanmıyorsanız:

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

Sonra:

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

Açıkçası Utf8StringWriter, yapıcısında herhangi bir kodlamayı kabul eden daha genel bir sınıf yapabilirsiniz - ancak benim deneyimime göre UTF-8, a için en sık gereken "özel" kodlamadır StringWriter:)

Şimdi Jon Hanna'nın dediği gibi, bu yine de dahili olarak UTF-16 olacaktır, ancak muhtemelen bir noktada onu ikili veriye dönüştürmek için başka bir şeye aktaracaksınız ... bu noktada yukarıdaki dizeyi kullanabilirsiniz, bunu UTF-8 bayta dönüştürürseniz her şey iyi olacaktır - çünkü XML bildirimi kodlama olarak "utf-8" i belirtir.

DÜZENLEME: Bunun işe yaradığını göstermek için kısa ama eksiksiz bir örnek:

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

Sonuç:

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

İstediğimiz "utf-8" in beyan edilen kodlamasına dikkat edin, inanıyorum.

Kalıtım kullanarak çok iyi cevap, sadece başlatıcıyı geçersiz kılmayı unutmayın

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

Sorunu çok iyi açıklayan ve birkaç farklı çözümü tanımlayan bu blog gönderisini buldum:

(ölü bağlantı kaldırıldı)

Bunu yapmanın en iyi yolunun bellekteyken XML bildirimini tamamen çıkarmak olduğu fikrine karar verdim. Aslında öyle zaten o noktada UTF-16, ancak belirli bir kodlama ile bir dosyaya yazılır kadar XML bildirimi anlamlı görünmüyor; ve o zaman bile beyan gerekli değildir. En azından serileştirmeyi bozuyor gibi görünmüyor.

@Jon Hanna'nın bahsettiği gibi, bu şu şekilde oluşturulmuş bir XmlWriter ile yapılabilir:

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