在 .NET 中使用 XmlReader 取消转义 XML 实体？

Question

我正在尝试对 .NET (C#) 中的字符串中的 XML 实体进行转义，但我似乎无法使其正常工作。

例如，如果我有字符串 AT&T，则应将其转换为 AT&T。

一种方法是使用 HttpUtility.HtmlDecode()，但那是针对 HTML 的。

所以我对此有两个问题：

1. 使用 HttpUtility.HtmlDecode() 解码 XML 实体安全吗？

2. 如何使用 XmlReader（或类似的东西）来执行此操作？我已尝试以下操作，但总是返回空字符串：

   静态字符串 ReplaceEscapes(字符串文本)
   {
       StringReader 阅读器 = new StringReader(text);
   
       XmlReaderSettings 设置 = new XmlReaderSettings();
   
       settings.ConformanceLevel = ConformanceLevel.Fragment;
   
       使用 (XmlReader xmlReader = XmlReader.Create(阅读器, 设置))
       {
           返回 xmlReader.ReadString();
       }
   }
   

Answer 1

HTML 转义和 XML 密切相关。正如您所说， HttpUtility 两者都有HtmlEncode 和 HtmlDecode 方法。这些也将在 XML 上运行，因为只有少数实体需要转义：<、>、\、HTML 和 XML 中的 ' 和 &。

使用 HttpUtility 类的缺点是您需要对 System.Web dll 的引用，这还带来了许多您可能不想要的其他内容。

特别是对于 XML，SecurityElement 类具有转义方法将进行编码，但没有相应的 Unescape 方法。因此，您有几个选择：

1. 使用 HttpUtility.HtmlDecode() 并提供对 System.Web 的引用

2. 推出您自己的解码方法来处理特殊字符（因为只有少数 - 请查看 Reflector 中的 SecurityElement 的静态构造函数以查看完整列表）

3. 使用（hacky）解决方案，例如：

。

    public static string Unescape(string text)
    {
        XmlDocument doc = new XmlDocument();
        string xml = string.Format("<dummy>{0}</dummy>", text);
        doc.LoadXml(xml);
        return doc.DocumentElement.InnerText;
    }

就我个人而言，如果我已经引用了 System.Web，我会使用 HttpUtility.HtmlDecode()，如果没有，我会使用自己的引用。我不喜欢您的 XmlReader 方法，因为它是 Disposable，这通常表明它正在使用需要处置的资源，因此可能是一项成本高昂的操作。

Answer 2

您的＃2解决方案可以工作，但您需要在ReadStringxmlReader.Read();（或xmlReader.MoveToContent();） >。

我想 #1 也是可以接受的，即使存在像 ® 这样的边缘情况，它是一个有效的 HTML 实体，但不是一个 XML 实体 - 你的 unescaper 应该用它做什么？作为正确的 XML 解析器抛出异常，还是像 HTML 解析器那样返回“®”？

Answer 3

这有效：

using (XmlReader xmlReader = XmlReader.Create(reader, settings))
{
    if (xmlReader.Read())
    {
       return xmlReader.ReadString();
    }
}

Answer 4

我发现如果您的输入文本以某些空白字符（例如回车符）结尾，则最上面的答案有一个小错误。

字符串“测试 ”失去了它的尾随空白。

如果将问题中的解决方案与 adrianbanks 的包装标签结合起来，您将得到以下有效的结果。

public static string UnescapeUnicode(string line)
    {
        using (StringReader reader = new StringReader("<a>" + line + "</a>"))
        {
            using (XmlReader xmlReader = XmlReader.Create(reader))
            {
                xmlReader.MoveToContent();
                return xmlReader.ReadElementContentAsString();
            }
        }
    }

Answer 5

这也有效，并且代码最少：

    public static string DecodeString(string encodedString)
    {
        if (string.IsNullOrEmpty(formattedText))
            return string.Empty;
        XmlTextReader xtr = new XmlTextReader(encodedString, XmlNodeType.Element, null);
        if (xtr.Read())
            return xtr.ReadString();
        throw new Exception("Error decoding xml string : " + encodedString);
    }

Update1：​​嗯，如果encodeString是“”，那么xtr.Read()返回false，似乎它不起作用。

Update2：添加了解决方法

Update3：这似乎工作得更好

    public static string DecodeString(string encodedString)
    {
        XmlTextReader xtr = new XmlTextReader(encodedString, XmlNodeType.Element, null);
        xtr.MoveToContent();
        return xtr.Value;
    }