C# 如何确保写入的xml文件格式正确且关闭了所有流

畫卷琴夢 2025-11-04 00:00:00 次阅读

使用XmlWriter配合using语句可确保XML格式正确且流自动关闭。通过设置XmlWriterSettings的Indent、Encoding等属性优化输出，并利用XDocument加载验证文件合法性，避免手动调用Close或Flush，实现安全可靠的XML写入。

在 C# 中写入 XML 文件时，确保格式正确并正确关闭所有流的关键是使用合适的类和遵循正确的资源管理实践。以下是一些核心建议和示例代码，帮助你实现这一点。

使用 XmlWriter 配合 using 语句

XmlWriter 是写入格式良好 XML 的推荐方式，它能自动处理转义字符、标签闭合和编码。配合 using 语句可确保即使发生异常，流也会被正确关闭。

示例代码：

using System;
using System.Xml;
var settings = new XmlWriterSettings
{
Indent = true,                    // 格式化输出（缩进）
IndentChars = "  ",               // 缩进空格
NewLineChars = "\r\n",            // 换行符
Encoding = System.Text.Encoding.UTF8,
CloseOutput = true                // 确保底层流也被关闭
};
using (var writer = XmlWriter.Create("output.xml", settings))
{
writer.WriteStartDocument();
writer.WriteStartElement("Root");
writer.WriteElementString("Name", "张三");
writer.WriteElementString("Age", "30");
writer.WriteEndElement();
writer.WriteEndDocument();
} // writer 在此处自动 Dispose，流被关闭
避免手动调用 Close 或 Flush
不要手动调用 Close() 或 Flush()，因为 using 块会自动调用 Dispose()，后者已包含这些操作。重复调用可能导致异常或未定义行为。
验证生成的 XML 格式
如果需要额外确保 XML 格式正确，可以在写入后读取文件并尝试加载到 XDocument 或 XmlDocument 中进行验证。
验证示例：
try
{
    var doc = XDocument.Load("output.xml"); // 如果格式错误会抛出异常
    Console.WriteLine("XML 格式正确");
}
catch (XmlException ex)
{
    Console.WriteLine("XML 格式错误: " + ex.Message);
}

关键要点总结

始终使用 XmlWriter 写入 XML，设置 Indent = true 保证可读性
用 using 包裹 XmlWriter，确保流一定被释放
配置 XmlWriterSettings 明确指定编码、换行和缩进
避免直接操作 FileStream，让 XmlWriter 内部管理
必要时通过 XDocument 加载验证输出是否合法

基本上就这些。只要用好 using 和 XmlWriter，C# 能可靠地写出格式正确且流安全关闭的 XML 文件。