在 C# 中使用 XML 文字吗？

Question

是否可以在 C# 代码文件中添加文字 XML 数据？我目前正在使用多行字符串文字，但如您所见，它变得混乱。有更好的方法吗？

string XML = @"<?xml version=""1.0"" encoding=""utf-8""?>
<customUI xmlns=""http://schemas.example.com/customui"">
    <toolbar id=""save"">
    </toolbar>
</customUI>";

Answer 1

XML 文字是 VB.NET 的功能，而不是 C# 的功能。

您发布的内容是您在 C# 中所能得到的最接近的内容。

不过，您可能需要考虑将嵌入的双引号替换为单引号（因为这两种类型都是有效的 XML）。

对于大量 XML，您可能需要考虑 Marc 的答案 - 使用 XML 文件（加载一次并存储在内存中），这样您就可以利用 XML 编辑器。

Answer 2

如果 XML 足够大而妨碍，请考虑使用平面 .xml 文件，从磁盘加载或作为资源嵌入。只要您只加载一次（可能在静态构造函数中），这对性能不会有任何影响。由于它将使用 IDE 的 XML 文件编辑器，因此维护起来会容易得多。而且它不会妨碍您的代码。

Answer 3

参考我的评论，我不记得在哪里看到过这个，但我终于找到了 XmlBuilder链接。

回想起来，Linq to XML 似乎是您最好的选择。它比连接 XML 字符串更干净、更快且更易于维护：

XNamespace ns = "http://schemas.example.com/customui";
XDocument doc = new XDocument(
                    new XDeclaration("1.0", "utf-8", "yes"),
                    new XElement(ns + "customUI",
                        new XElement(ns + "taskbar",
                            new XAttribute("id", "save"))
                    )
                );

var stringWriter = new StringWriter();
doc.Save(stringWriter); //Write to StringWriter, preserving the declaration (<?xml version="1.0" encoding="utf-16" standalone="yes"?>)
var xmlString = stringWriter.ToString(); //Save as string
doc.Save(@"d:\out.xml"); //Save to file

Answer 4

作为一个特殊的、非常具体的解决方案，如果您碰巧在使用 Razor 引擎的 ASP.NET 环境中工作，在 CSHTML 文件中，您可以：

Func<MyType, HelperResult> xml = @<root>
    <item>@(item.PropertyA)</item>
    <item>@(item.PropertyB)</item>
    <item>@(item.PropertyC)</item>
</root>;

通过添加扩展方法：

public static XDocument ToXDocument<T>(this Func<T, HelperResult> source, T item)
{
    return XDocument.Parse(source(item).ToHtmlString());
}

然后您可以：

XDocument document = xml.ToXDocument(new MyType() {
    PropertyA = "foo",
    PropertyB = "bar",
    PropertyC = "qux",
});

再次，特殊？ 是。具体情况？ 是。但它确实有效，并且提供了很好的智能感知。 （请注意，它还会给出一堆有效性警告，具体取决于文档验证版本）

Answer 5

我们在 C# 中最接近的方式是通过 LINQ，类似这样：

var xml = XDocument.Load(
    new StringReader(@"<Books>
    <Book author='Dan Brown'>The Da Vinci Code</Book>
    <Book author='Dan Brown'>The Lost Symbol</Book>
    </Books>"));

var query = from book in xml.Elements("Books").Elements("Book")
    where book.Attribute("author").Value == "Dan Brown"
    select book.Value;

foreach (var item in query) Console.WriteLine(item);