在.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摆脱中间体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 });