保存 XmlDocument 时，它会忽略 XmlDeclaration (UTF8) 中的编码并使用 UTF16答案

【问题标题】：When saving an XmlDocument, it ignores the encoding in the XmlDeclaration (UTF8) and uses UTF16保存 XmlDocument 时，它会忽略 XmlDeclaration (UTF8) 中的编码并使用 UTF16
【发布时间】：2010-11-02 03:04:46
【问题描述】：

我有以下代码：

var doc = new XmlDocument();

XmlDeclaration xmlDeclaration = doc.CreateXmlDeclaration("1.0", "UTF-8", null);
doc.AppendChild(xmlDeclaration);

XmlElement root = doc.CreateElement("myRoot");
doc.AppendChild(root);
root.InnerText = "myInnerText";

StringWriter sw = new StringWriter();
doc.Save(sw);
Console.WriteLine(sw.ToString());

Console.WriteLine();

MemoryStream ms = new MemoryStream();
doc.Save(ms);
Console.WriteLine(Encoding.ASCII.GetString(ms.ToArray()));

这是输出：

<?xml version="1.0" encoding="utf-16"?>
<myRoot>myInnerText</myRoot>

???<?xml version="1.0" encoding="UTF-8"?>
<myRoot>myInnerText</myRoot>

基本上它的作用是创建一个 xml 文件，并将编码设置为 utf8，但是当它将它保存到 stringwriter 时，它会忽略我的编码并使用 utf16。但是，当使用内存流时，它使用 utf8（带有额外的 BOM 字符）

这是为什么？为什么它不尊重我的 utf-8 显式编码设置？

非常感谢

【问题讨论】：

只是好奇，您是否尝试在编码中给出 null/string.empty 并查看？？
如果我这样做，stringwriter 仍然是 utf16，并且 memorystream 在其声明中没有编码。
例如。它看起来像这样：

标签： c# xml

【解决方案1】：

因为您所做的只是设置一个表示它是 UTF-8 的 XML 元素，因此您实际上并没有将它保存为 UTF-8。您需要将输出流设置为使用 UTF-8，如下所示：

var doc = new XmlDocument();
XmlElement root = doc.CreateElement("myRoot");
doc.AppendChild(root);
root.InnerText = "myInnerText";
using(TextWriter sw = new StreamWriter("C:\\output.txt", false, Encoding.UTF8)) //Set encoding
{
    doc.Save(sw);
}

一旦你这样做了，你甚至不必添加 XML 声明。它自己计算出来。如果要将其保存到 MemoryStream，请使用包装 MemoryStream 的 StreamWriter。

【讨论】：

好的，现在说得通了。谢谢
因此 xml 编写器会覆盖您放入 xml 声明中的任何内容，具体取决于它保存到的内容，是流、文本编写器或文件。
XML 声明就它而言只是一个元素（尽管是一个奇怪的元素）。它声明了它是如何保存的，而不是它应该如何保存。这就是为什么当它被保存时它会为你放在那里。
谢谢，它可以工作.. 但是如果你在 Windows 中，默认的编码 UTF8 会放在文件的开头，BOM 标记和某些系统会拒绝使用 UTF-8-BOM 的文件。 danielwertheim 在这篇很棒的文章 UTF-8 BOM adventures in C# 中解释了所有内容以及如何在 Windows 中编写没有 BOM 的 UTF-8。

【解决方案2】：

我使用下面的方法，它把它写得很漂亮 and 为 UTF-8

public static string Beautify(XmlDocument doc)
{
    string xmlString = null;
    using (MemoryStream ms = new MemoryStream()) {
        XmlWriterSettings settings = new XmlWriterSettings {
            Encoding = new UTF8Encoding(false),
            Indent = true,
            IndentChars = "  ",
            NewLineChars = "\r\n",
            NewLineHandling = NewLineHandling.Replace
        };
        using (XmlWriter writer = XmlWriter.Create(ms, settings)) {
            doc.Save(writer);
        }
        xmlString = Encoding.UTF8.GetString(ms.ToArray());
    }
    return xmlString;
}

这样称呼：

File.WriteAllText(fileName, Utilities.Beautify(xmlDocument));

【讨论】：

【解决方案3】：

从the MSDN我们可以看到...

TextWriter 上的编码决定了写出的编码（XmlDeclaration 节点的编码被 TextWriter 的编码代替）。如果 TextWriter 上没有指定编码，则保存 XmlDocument 时不带编码属性。

如果您想使用 XmlDeclaration 中的编码，您需要使用流来保存文档。

【讨论】：

所以基本上你是说 C# 在将文档保存到文本编写器时会忽略 xmldeclaration？