Сериализация объекта как UTF-8 XML в .NET

Правильная утилизация объекта удалена для краткости, но я шокирован, если это самый простой способ кодировать объект как 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. поток, база данных и т. д. В общем, это не так уж и много подробностей.

Нет, вы можете использовать a, StringWriterчтобы избавиться от промежуточного звена 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 является наиболее часто требуемой "пользовательской" кодировкой для a StringWriter:)

Теперь, как говорит Джон Ханна, внутренне это все еще будет 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 });