c# - 字符串转义为 XML 属性

Question

我看过string escape into XML并发现它非常有用。

我想做类似的事情:转义要在 XML 属性中使用的字符串。

字符串可能包含\r\n。XmlWriter 类产生类似于\r\n ->

我目前使用的解决方案包括 XmlWriter 和 StringBuilder，而且相当丑陋。

有什么提示吗？

编辑1:
抱歉让 LarsH 失望了，我的第一个方法是

public static string XmlEscapeAttribute(string unescaped)
{
    XmlDocument doc = new XmlDocument();
    XmlAttribute attr= doc.CreateAttribute("attr");
    attr.InnerText = unescaped;
    return attr.InnerXml;
}

它不起作用。 XmlEscapeAttribute("Foo\r\nBar") 将导致 "Foo\r\nBar"

我使用 .NET Reflector 来了解 XmlTextWriter 如何转义属性。它使用内部的 XmlTextEncoder 类...

我目前使用的方法是这样的:

public static string XmlEscapeAttribute(string unescaped)
{
    if (String.IsNullOrEmpty(unescaped)) return unescaped;

    XmlWriterSettings settings = new XmlWriterSettings();
    settings.OmitXmlDeclaration = true;
    StringBuilder sb = new StringBuilder();
    XmlWriter writer = XmlWriter.Create(sb, settings);

    writer.WriteStartElement("a");
    writer.WriteAttributeString("a", unescaped);
    writer.WriteEndElement();
    writer.Flush();
    sb.Length -= "\" />".Length;
    sb.Remove(0, "<a a=\"".Length);

    return sb.ToString();
}

它很丑而且可能很慢，但它确实有效:XmlEscapeAttribute("Foo\r\nBar") 将导致 "Foo Bar"

编辑2:

SecurityElement.Escape(unescaped);

也不行。

Edit3(最终版):

使用 Lars 提供的所有非常有用的评论，我的最终实现如下所示:

注意:.Replace("\r", " ").Replace("\n", " "); 不是有效 XMl 所必需的。这只是一种美容措施!

    public static string XmlEscapeAttribute(string unescaped)
    {

        XmlDocument doc = new XmlDocument();
        XmlAttribute attr= doc.CreateAttribute("attr");
        attr.InnerText = unescaped;
        // The Replace is *not* required!
        return attr.InnerXml.Replace("\r", "
").Replace("\n", "
");
    }

事实证明这是有效的 XML，并且将被任何符合标准的 XMl 解析器解析:

<response message="Thank you,
LarsH!" />

Answer 1

修改你引用的方案，怎么样

public static string XmlEscape(string unescaped)
{
    XmlDocument doc = new XmlDocument();
    var node = doc.CreateAttribute("foo");
    node.InnerText = unescaped;
    return node.InnerXml;
}

我所做的只是将 CreateElement() 更改为 CreateAttribute()。属性节点类型确实具有 InnerText 和 InnerXml 属性。

我没有测试它的环境，但我很想知道它是否有效。

更新:或者更简单地说，使用 SecurityElement.Escape() 正如您链接到的问题的另一个答案中所建议的那样。这将转义引号，因此适合用于属性文本。

更新 2:请注意为了使 XML 格式正确，回车符和换行符不需要在属性值中转义。如果你因为其他原因希望它们被转义，你可以使用 String.replace() 来实现，例如

SecurityElement.Escape(unescaped).Replace("\r", "
").Replace("\n", "
");

或

return node.InnerXml.Replace("\r", "
").Replace("\n", "
");