在 C# 中，将字符串格式化为 XML 的最佳方法是什么？

Question

我正在用 C# 创建一个轻量级编辑器，并且想知道将字符串转换为格式良好的 XML 字符串的最佳方法。 我希望 C# 库中有一个公共方法，如“public bool FormatAsXml(string text, out string formattedXmlText)”，但这不可能那么容易，不是吗？

非常具体地说，“SomeMethod”方法必须是什么才能产生以下输出？

string unformattedXml;
string formattedXml;

unformattedXml = "<?xml version=\"1.0\"?><book><author>Lewis, C.S.</author><title>The Four Loves</title></book>"
formattedXml = SomeMethod(unformattedXml);

Console.WriteLine(formattedXml);

输出：

<?xml version="1.0"?>
  <book id="123">
    <author>Lewis, C.S.</author>
    <title>The Four Loves</title>
  </book>

Answer 1

string unformattedXml = "<?xml version=\"1.0\"?><book><author>Lewis, C.S.</author><title>The Four Loves</title></book>";
string formattedXml = XElement.Parse(unformattedXml).ToString();
Console.WriteLine(formattedXml);

输出：

<book>
  <author>Lewis, C.S.</author>
  <title>The Four Loves</title>
</book>

Xml 声明不是由 ToString() 输出，而是由 Save() 输出...

  XElement.Parse(unformattedXml).Save(@"C:\doc.xml");
  Console.WriteLine(File.ReadAllText(@"C:\doc.xml"));

输出：

<?xml version="1.0" encoding="utf-8"?>
<book>
  <author>Lewis, C.S.</author>
  <title>The Four Loves</title>
</book>

Answer 2

不幸的是，它不像 FormatXMLForOutput 方法那么简单，这是 Microsoft 在这里讨论的；）

无论如何，从 .NET 2.0 开始，推荐的方法是使用 XMlWriterSettingsClass 来设置格式，而不是直接在XmlTextWriter 对象。 请参阅此 MSDN 页面了解更多详细信息。 它说：

“在 .NET Framework 2.0 版本中，建议的做法是使用 XmlWriter.Create 方法和 XmlWriterSettings 类创建 XmlWriter 实例。这使您可以充分利用此版本中引入的所有新功能。更多信息，请参阅创建 XML 编写器”

以下是推荐方法的示例：

XmlWriterSettings settings = new XmlWriterSettings();
settings.Indent = true;
settings.IndentChars = ("    ");
using (XmlWriter writer = XmlWriter.Create("books.xml", settings))
{
    // Write XML data.
    writer.WriteStartElement("book");
    writer.WriteElementString("price", "19.95");
    writer.WriteEndElement();
    writer.Flush();
}

Answer 3

使用新的 System.Xml.Linq 命名空间 (System.Xml.Linq Assembly)，您可以使用以下内容：

string theString = "<nodeName>blah</nodeName>";
XDocument doc = XDocument.Parse(theString);

您还可以使用以下内容创建片段：

string theString = "<nodeName>blah</nodeName>";
XElement element = XElement.Parse(theString);

如果字符串还不是 XML，您可以执行如下操作

string theString = "blah";
//creates <nodeName>blah</nodeName>
XElement element = new XElement(XName.Get("nodeName"), theString); 

：最后一个示例是 XElement 将对提供的字符串进行 XML 编码。

我强烈推荐新的 XLINQ 类。 与大多数现有的 XmlDocument 相关类型相比，它们的重量更轻，并且更易于使用。

Answer 4

假设您只是想重新格式化 XML 文档以将新节点放在新行上并添加缩进，那么，如果您使用 .NET 3.5 或更高版本，那么最好的解决方案是使用 XDocument 解析然后输出，如下所示：

string unformattedXml;
string formattedXml;

unformattedXml = "<?xml version=\"1.0\"?><book><author>Lewis, C.S.</author><title>The Four Loves</title></book>";
formattedXml = System.Xml.Linq.XDocument.Parse(unformattedXml).ToString();

Console.WriteLine(formattedXml);

整齐胡？

然后，这应该重新格式化 XML 节点。

要使用以前版本的框架来执行此操作需要更多的跑腿工作，因为没有内置函数来重新计算空白。

事实上，使用 Linq 之前的类来完成此操作将是：

string unformattedXml;
string formattedXml;

unformattedXml = "<?xml version=\"1.0\"?><book><author>Lewis, C.S.</author><title>The Four Loves</title></book>";
System.Xml.XmlDocument doc = new System.Xml.XmlDocument();
doc.LoadXml(unformattedXml);
System.Text.StringBuilder sb = new System.Text.StringBuilder();
System.Xml.XmlWriter xw = System.Xml.XmlTextWriter.Create(sb, new System.Xml.XmlWriterSettings() { Indent = true });
doc.WriteTo(xw);
xw.Flush();
formattedXml = sb.ToString();
Console.WriteLine(formattedXml);

Answer 5

听起来您想将 XML 加载到 XmlTextWriter 对象并设置格式和缩进属性：

writer.Formatting = Formatting.Indented;
writer.Indentation = 1;
writer.IndentChar = '\t';

Answer 6

Jason 的方法是最简单的。 方法如下：

private static string FormatXmlString(string xmlString)
{
    System.Xml.Linq.XElement element = System.Xml.Linq.XElement.Parse(xmlString);
    return element.ToString();
}

Answer 7

如果您只需要转义 XML 字符，以下内容可能有用：

string myText = "This & that > <> <";
myText = System.Security.SecurityElement.Escape(myText);

Answer 8

在 Framework 4.0 中，它很简单。

var unformattedXml = "<?xml version=\"1.0\"?><book><author>Lewis, C.S.</author><title>The Four Loves</title></book>";
var xdoc = System.Xml.Linq.XDocument.Parse(unformattedXml);
var formattedXml = (xdoc.Declaration != null ? xdoc.Declaration + "\r\n" : "") + xdoc.ToString();
Console.WriteLine(formattedXml);

这会添加所需的缩进，并维护 Xml 声明。

<?xml version="1.0"?>
<book>
  <author>Lewis, C.S.</author>
  <title>The Four Loves</title>
</book>

Answer 9

该字符串是有效的 XML 吗？ 您的意思是如何将 XML 字符串转换为 XML 文档？ 如果是这样，请执行以下操作：

XmlDocument xml = new XmlDocument();

xml.LoadXml( YourString );

Answer 10

System.Xml.Linq.XElement.ToString() 自动格式化！

XElement formattedXML = new XElement.Parse(unformattedXmlString);
Console.WriteLine(formattedXML.ToString());