XDocument.Save() 删除我的 
实体

Question

我编写了一个工具来使用 C# 和 Linq-to-XML 修复一些 XML 文件（即插入一些丢失的属性/值）。该工具将现有 XML 文件加载到 XDocument 对象中。然后，它向下解析节点以插入丢失的数据。之后，它调用 XDocument.Save() 将更改保存到另一个目录。

除了一件事之外，所有这些都很好：XML 文件中文本中的任何 
 实体都将替换为新行字符。当然，该实体代表一个新行，但我需要在 XML 中保留该实体，因为另一个使用者需要它。

有没有办法保存修改后的 XDocument 而不丢失 
 实体？

谢谢。

Answer 1


实体在 XML 中技术上称为“数字字符引用”，它们在原始文档加载到 XDocument 中时得到解析。这使得您的问题很难解决，因为在加载 XDocument 后，无法区分已解析的空白实体和无关紧要的空白（通常用于为纯文本查看器格式化 XML 文档）。因此，以下内容仅适用于您的文档没有任何无关紧要的空格的情况。

System.Xml 库允许通过设置 XmlWriterSettings 类的 NewLineHandling 属性设置为 Entitize。但是，在文本节点内，这只会将 \r 实体化为 ，而不是将 \n 实体化为 。 #xA;。

最简单的解决方案是从 XmlWriter 类派生并覆盖其 WriteString 方法手动将空白字符替换为其数字字符实体。 WriteString 方法也恰好是 .NET 将不允许出现在文本节点中的字符实体化的地方，例如语法标记 &、< ;、>，分别实体化为&、<、>。

由于 XmlWriter 是抽象的，我们将从 XmlTextWriter 派生，以避免必须实现前一个类的所有抽象方法。这是一个快速而肮脏的实现：

public class EntitizingXmlWriter : XmlTextWriter
{
    public EntitizingXmlWriter(TextWriter writer) :
        base(writer)
    { }

    public override void WriteString(string text)
    {
        foreach (char c in text)
        {
            switch (c)
            {
                case '\r':
                case '\n':
                case '\t':
                    base.WriteCharEntity(c);
                    break;
                default:
                    base.WriteString(c.ToString());
                    break;
            }
        }
    }
}

如果打算在生产环境中使用，您需要删除 c.ToString() 部分，因为它的效率非常低。您可以通过批处理原始 text 中不包含任何您想要实体化的字符的子字符串，并将它们一起输入到单个 base.WriteString 调用中来优化代码。

警告：以下简单的实现将不起作用，因为基本 WriteString 方法会将任何 & 字符替换为 & ，从而导致 \r 扩展为 。

    public override void WriteString(string text)
    {
        text = text.Replace("\r", "
");
        text = text.Replace("\n", "
");
        text = text.Replace("\t", "	");
        base.WriteString(text);
    }

最后，要将您的 XDocument 保存到目标文件或流中，只需使用以下代码片段：

using (var textWriter = new StreamWriter(destination))
using (var xmlWriter = new EntitizingXmlWriter(textWriter))
    document.Save(xmlWriter);

希望这会有所帮助！

编辑：作为参考，这里是重写的 WriteString 方法的优化版本：

public override void WriteString(string text)
{
    // The start index of the next substring containing only non-entitized characters.
    int start = 0;

    // The index of the current character being checked.
    for (int curr = 0; curr < text.Length; ++curr)
    {
        // Check whether the current character should be entitized.
        char chr = text[curr];
        if (chr == '\r' || chr == '\n' || chr == '\t')
        {
            // Write the previous substring of non-entitized characters.
            if (start < curr)
                base.WriteString(text.Substring(start, curr - start));

            // Write current character, entitized.
            base.WriteCharEntity(chr);

            // Next substring of non-entitized characters tentatively starts
            // immediately beyond current character.
            start = curr + 1;
        }
    }

    // Write the trailing substring of non-entitized characters.
    if (start < text.Length)
        base.WriteString(text.Substring(start, text.Length - start));
}

Answer 2

如果您的文档包含无关紧要的空格，您希望将其与 实体区分开来，则可以使用以下（更简单）的解决方案：转换 code> 字符临时引用另一个字符（文档中尚不存在），执行 XML 处理，然后将该字符转换回输出结果中。在下面的示例中，我们将使用私有字符U+E800。

static string ProcessXml(string input)
{
    input = input.Replace("
", "");
    XDocument document = XDocument.Parse(input);
    // TODO: Perform XML processing here.
    string output = document.ToString();
    return output.Replace("\uE800", "
");
}

请注意，由于 XDocument 将数字字符引用解析为相应的 Unicode 字符，因此 "" 实体将被解析为 '\uE800' 在输出中。

通常，您可以安全地使用 Unicode“专用区域”(U+E000–U+F8FF) 中的任何代码点。如果您想更加安全，请检查该字符是否已存在于文档中；如果是这样，请从上述范围中选择另一个字符。由于您只是暂时在内部使用该角色，因此使用哪一个并不重要。在极不可能的情况下，所有专用字符都已存在于文档中，则抛出异常；然而，我怀疑这在实践中是否会发生。