C#实战：5分钟搞定XML配置文件读写（附完整代码示例）

C#实战5分钟搞定XML配置文件读写附完整代码示例如果你正在开发一个C#桌面应用、Web服务或者需要持久化存储一些配置信息XML配置文件几乎是绕不开的技术选型。它结构清晰、可读性强而且.NET框架对XML的原生支持非常完善。但很多开发者一看到XML操作就头疼——那些繁琐的节点遍历、属性读写还有各种异常处理让人望而却步。其实C#操作XML可以非常简单。我见过不少项目里开发者为了一个简单的配置读写写了几百行代码结果还是漏洞百出。今天我就带你用最直接的方式在5分钟内掌握XML配置文件的核心操作。我会分享一套经过实战检验的代码模板你几乎可以直接复制到项目中使用同时还会告诉你那些官方文档里很少提及的“坑”和最佳实践。1. 为什么选择XML作为配置文件在JSON大行其道的今天XML似乎显得有些“过时”。但在我多年的开发经验中XML在配置管理领域依然有着不可替代的优势。特别是在企业级应用和Windows桌面程序中XML配置文件几乎是标准配置。XML配置文件的几个核心优势强类型支持XML SchemaXSD可以提供严格的类型验证这在配置复杂业务规则时非常有用注释友好XML原生支持注释你可以在配置文件中直接添加说明文字这在团队协作中特别重要层次结构清晰对于嵌套的配置项XML的树形结构比JSON的扁平结构更直观工具链成熟Visual Studio对XML有很好的智能提示支持还有各种XML编辑器和验证工具不过XML也不是万能的。对于简单的键值对配置我通常会推荐使用JSON或者INI格式。但当你的配置需要以下特性时XML是更好的选择配置项之间有明确的父子关系需要添加详细的配置说明配置结构可能随时间变化需要版本兼容需要与其他XML格式的系统进行数据交换提示在实际项目中我通常会根据配置的复杂程度来选择格式。简单的用JSON复杂的用XML极简的用环境变量。2. 5分钟快速上手创建你的第一个XML配置文件让我们从一个实际的场景开始。假设你正在开发一个桌面应用需要保存用户的偏好设置主题颜色、窗口大小、最近打开的文件列表。用XML来表示这个配置结构会很清晰。2.1 基础结构设计首先我们需要设计XML的结构。一个好的结构应该既满足当前需求又为未来扩展留有余地。这是我的建议?xml version1.0 encodingutf-8? AppConfig version1.0 UserPreferences ThemeDark/Theme WindowWidth1200/WindowWidth WindowHeight800/WindowHeight AutoSavetrue/AutoSave /UserPreferences RecentFiles File pathC:\Projects\Project1.sln lastOpened2024-04-15 / File pathC:\Docs\Report.docx lastOpened2024-04-14 / /RecentFiles /AppConfig这个设计有几个关键点根元素AppConfig包含版本属性便于后续格式升级时的兼容性处理用户偏好和最近文件分开存储逻辑清晰文件路径和最后打开时间作为属性而不是子元素这样更简洁2.2 使用XmlDocument创建配置文件在C#中创建这个配置文件最直接的方式是使用System.Xml命名空间下的XmlDocument类。下面是一个完整的创建示例using System; using System.Xml; public class ConfigManager { public void CreateConfigFile(string filePath) { try { XmlDocument doc new XmlDocument(); // 添加XML声明 XmlDeclaration xmlDeclaration doc.CreateXmlDeclaration(1.0, utf-8, null); doc.AppendChild(xmlDeclaration); // 创建根元素 XmlElement root doc.CreateElement(AppConfig); root.SetAttribute(version, 1.0); doc.AppendChild(root); // 创建UserPreferences节点 XmlElement userPrefs doc.CreateElement(UserPreferences); root.AppendChild(userPrefs); // 添加主题设置 XmlElement theme doc.CreateElement(Theme); theme.InnerText Dark; userPrefs.AppendChild(theme); // 添加窗口尺寸 XmlElement width doc.CreateElement(WindowWidth); width.InnerText 1200; userPrefs.AppendChild(width); XmlElement height doc.CreateElement(WindowHeight); height.InnerText 800; userPrefs.AppendChild(height); // 添加自动保存设置 XmlElement autoSave doc.CreateElement(AutoSave); autoSave.InnerText true; userPrefs.AppendChild(autoSave); // 创建RecentFiles节点 XmlElement recentFiles doc.CreateElement(RecentFiles); root.AppendChild(recentFiles); // 添加最近文件记录 AddRecentFile(doc, recentFiles, C:\Projects\Project1.sln, DateTime.Now.AddDays(-1)); AddRecentFile(doc, recentFiles, C:\Docs\Report.docx, DateTime.Now.AddDays(-2)); // 保存到文件 doc.Save(filePath); Console.WriteLine($配置文件已创建: {filePath}); } catch (Exception ex) { Console.WriteLine($创建配置文件失败: {ex.Message}); // 在实际项目中这里应该记录日志或抛出自定义异常 } } private void AddRecentFile(XmlDocument doc, XmlElement parent, string path, DateTime lastOpened) { XmlElement file doc.CreateElement(File); file.SetAttribute(path, path); file.SetAttribute(lastOpened, lastOpened.ToString(yyyy-MM-dd)); parent.AppendChild(file); } }这段代码有几个值得注意的地方异常处理XML文件操作可能因为权限问题、磁盘空间不足等原因失败必须进行异常处理编码指定在创建XML声明时明确指定UTF-8编码避免中文等非ASCII字符出现乱码方法封装将添加最近文件的逻辑封装成独立方法提高代码复用性2.3 更优雅的创建方式使用XmlWriter如果你需要创建大型的XML文件或者对性能有较高要求XmlWriter是更好的选择。它采用流式写入内存占用更小public void CreateConfigWithXmlWriter(string filePath) { XmlWriterSettings settings new XmlWriterSettings { Indent true, IndentChars , Encoding Encoding.UTF8 }; using (XmlWriter writer XmlWriter.Create(filePath, settings)) { writer.WriteStartDocument(); writer.WriteStartElement(AppConfig); writer.WriteAttributeString(version, 1.0); writer.WriteStartElement(UserPreferences); writer.WriteElementString(Theme, Dark); writer.WriteElementString(WindowWidth, 1200); writer.WriteElementString(WindowHeight, 800); writer.WriteElementString(AutoSave, true); writer.WriteEndElement(); // UserPreferences writer.WriteStartElement(RecentFiles); writer.WriteStartElement(File); writer.WriteAttributeString(path, C:\Projects\Project1.sln); writer.WriteAttributeString(lastOpened, DateTime.Now.AddDays(-1).ToString(yyyy-MM-dd)); writer.WriteEndElement(); // File writer.WriteEndElement(); // RecentFiles writer.WriteEndElement(); // AppConfig writer.WriteEndDocument(); } }XmlWriter的优势在于性能更好不需要在内存中构建完整的DOM树内存更省特别适合生成大型XML文件控制更细可以精确控制输出格式3. 高效读取从XML中获取配置数据创建配置文件只是第一步更重要的是如何高效、安全地读取配置。在实际项目中我见过太多因为XML读取不当导致的性能问题和内存泄漏。3.1 基础读取使用XmlDocument对于中小型配置文件XmlDocument是最简单的选择public class AppSettings { public string Theme { get; set; } public int WindowWidth { get; set; } public int WindowHeight { get; set; } public bool AutoSave { get; set; } public ListRecentFile RecentFiles { get; set; } new ListRecentFile(); } public class RecentFile { public string Path { get; set; } public DateTime LastOpened { get; set; } } public AppSettings LoadConfig(string filePath) { AppSettings settings new AppSettings(); if (!File.Exists(filePath)) { Console.WriteLine($配置文件不存在: {filePath}); return settings; // 返回默认设置 } try { XmlDocument doc new XmlDocument(); doc.Load(filePath); // 读取用户偏好 XmlNode themeNode doc.SelectSingleNode(/AppConfig/UserPreferences/Theme); if (themeNode ! null) settings.Theme themeNode.InnerText; XmlNode widthNode doc.SelectSingleNode(/AppConfig/UserPreferences/WindowWidth); if (widthNode ! null int.TryParse(widthNode.InnerText, out int width)) settings.WindowWidth width; XmlNode heightNode doc.SelectSingleNode(/AppConfig/UserPreferences/WindowHeight); if (heightNode ! null int.TryParse(heightNode.InnerText, out int height)) settings.WindowHeight height; XmlNode autoSaveNode doc.SelectSingleNode(/AppConfig/UserPreferences/AutoSave); if (autoSaveNode ! null bool.TryParse(autoSaveNode.InnerText, out bool autoSave)) settings.AutoSave autoSave; // 读取最近文件列表 XmlNodeList fileNodes doc.SelectNodes(/AppConfig/RecentFiles/File); if (fileNodes ! null) { foreach (XmlNode fileNode in fileNodes) { if (fileNode.Attributes?[path] ! null fileNode.Attributes[lastOpened] ! null) { var recentFile new RecentFile { Path fileNode.Attributes[path].Value, LastOpened DateTime.Parse(fileNode.Attributes[lastOpened].Value) }; settings.RecentFiles.Add(recentFile); } } } } catch (XmlException ex) { Console.WriteLine($XML格式错误: {ex.Message}); // 处理损坏的配置文件 } catch (Exception ex) { Console.WriteLine($读取配置文件失败: {ex.Message}); } return settings; }这里有几个关键点需要注意文件存在性检查在加载前检查文件是否存在避免不必要的异常类型安全转换使用TryParse方法进行类型转换避免格式错误导致程序崩溃空值检查每个节点和属性都要检查是否为null异常分类处理区分XML格式错误和其他异常便于问题排查3.2 使用XPath进行高级查询当配置文件结构复杂时XPath可以大大简化查询逻辑。下面是一些常用的XPath查询示例public void AdvancedXmlQuery(string filePath) { XmlDocument doc new XmlDocument(); doc.Load(filePath); // 1. 获取所有File节点 XmlNodeList allFiles doc.SelectNodes(//File); // 2. 获取最近7天内打开的文件 DateTime sevenDaysAgo DateTime.Now.AddDays(-7); string xpath $/AppConfig/RecentFiles/File[lastOpened {sevenDaysAgo:yyyy-MM-dd}]; XmlNodeList recentFiles doc.SelectNodes(xpath); // 3. 获取特定路径的文件 string targetPath C:\Projects\; XmlNode specificFile doc.SelectSingleNode($/AppConfig/RecentFiles/File[starts-with(path, {targetPath})]); // 4. 获取第一个和最后一个File节点 XmlNode firstFile doc.SelectSingleNode(/AppConfig/RecentFiles/File[1]); XmlNode lastFile doc.SelectSingleNode(/AppConfig/RecentFiles/File[last()]); }XPath的强大之处在于它的表达性但也要注意性能问题。复杂的XPath表达式在大型XML文档上可能比较慢。3.3 性能优化使用XmlReader读取大型文件如果你的配置文件很大比如包含数千个最近文件记录使用XmlDocument可能会消耗大量内存。这时应该使用XmlReaderpublic ListRecentFile ReadLargeConfigWithXmlReader(string filePath) { var recentFiles new ListRecentFile(); using (XmlReader reader XmlReader.Create(filePath)) { RecentFile currentFile null; while (reader.Read()) { if (reader.NodeType XmlNodeType.Element reader.Name File) { currentFile new RecentFile(); // 读取属性 while (reader.MoveToNextAttribute()) { if (reader.Name path) currentFile.Path reader.Value; else if (reader.Name lastOpened) currentFile.LastOpened DateTime.Parse(reader.Value); } // 回到元素节点 reader.MoveToElement(); } else if (reader.NodeType XmlNodeType.EndElement reader.Name File) { if (currentFile ! null) { recentFiles.Add(currentFile); currentFile null; } } } } return recentFiles; }XmlReader的工作方式是只读、只进的它不会在内存中构建整个文档树而是像游标一样逐个节点读取。这种方式的内存效率极高但代码相对复杂一些。4. 动态修改安全更新XML配置配置文件很少是静态的。用户更改设置、应用记录新信息都需要更新配置文件。但XML修改操作有几个常见的陷阱需要避免。4.1 基本修改操作让我们看看如何安全地修改配置文件public bool UpdateUserTheme(string filePath, string newTheme) { if (!File.Exists(filePath)) return false; try { XmlDocument doc new XmlDocument(); // 加载时保留格式 XmlReaderSettings settings new XmlReaderSettings { IgnoreWhitespace false }; using (XmlReader reader XmlReader.Create(filePath, settings)) { doc.Load(reader); } // 查找Theme节点 XmlNode themeNode doc.SelectSingleNode(/AppConfig/UserPreferences/Theme); if (themeNode null) { // 如果节点不存在创建它 XmlNode userPrefs doc.SelectSingleNode(/AppConfig/UserPreferences); if (userPrefs null) { // 连UserPreferences节点都不存在需要创建整个结构 return CreateMissingStructure(doc, filePath, newTheme); } themeNode doc.CreateElement(Theme); themeNode.InnerText newTheme; userPrefs.AppendChild(themeNode); } else { // 节点存在直接修改 themeNode.InnerText newTheme; } // 保存修改 XmlWriterSettings writerSettings new XmlWriterSettings { Indent true, IndentChars , Encoding Encoding.UTF8 }; using (XmlWriter writer XmlWriter.Create(filePath, writerSettings)) { doc.Save(writer); } return true; } catch (Exception ex) { Console.WriteLine($更新配置失败: {ex.Message}); return false; } }这个修改操作考虑了多种情况配置文件不存在目标节点不存在父节点也不存在保存时保留原有格式4.2 并发修改的安全处理在多线程环境或可能被多个进程访问的情况下直接修改配置文件可能导致数据损坏。这里有几个解决方案方案一使用文件锁public bool SafeUpdateWithFileLock(string filePath, ActionXmlDocument updateAction) { try { using (FileStream stream new FileStream(filePath, FileMode.Open, FileAccess.ReadWrite, FileShare.Read)) { // 尝试获取文件锁 stream.Lock(0, stream.Length); XmlDocument doc new XmlDocument(); doc.Load(stream); // 执行更新操作 updateAction(doc); // 重置流位置并保存 stream.Seek(0, SeekOrigin.Begin); stream.SetLength(0); // 清空文件 XmlWriterSettings settings new XmlWriterSettings { Indent true, IndentChars , Encoding Encoding.UTF8 }; using (XmlWriter writer XmlWriter.Create(stream, settings)) { doc.Save(writer); } stream.Unlock(0, stream.Length); return true; } } catch (IOException ex) when (ex.Message.Contains(另一个进程正在使用此文件)) { // 文件被占用稍后重试 Thread.Sleep(100); return SafeUpdateWithFileLock(filePath, updateAction); } catch (Exception ex) { Console.WriteLine($安全更新失败: {ex.Message}); return false; } }方案二使用临时文件public bool SafeUpdateWithTempFile(string filePath, ActionXmlDocument updateAction) { string tempFile filePath .tmp; string backupFile filePath .bak; try { // 1. 加载原文件 XmlDocument doc new XmlDocument(); doc.Load(filePath); // 2. 执行更新 updateAction(doc); // 3. 保存到临时文件 doc.Save(tempFile); // 4. 备份原文件 if (File.Exists(backupFile)) File.Delete(backupFile); File.Move(filePath, backupFile); // 5. 用临时文件替换原文件 File.Move(tempFile, filePath); // 6. 清理可选 File.Delete(backupFile); return true; } catch (Exception ex) { // 恢复备份 if (File.Exists(backupFile) !File.Exists(filePath)) { File.Move(backupFile, filePath); } Console.WriteLine($使用临时文件更新失败: {ex.Message}); return false; } finally { // 清理临时文件 if (File.Exists(tempFile)) File.Delete(tempFile); } }临时文件方案的优势在于即使更新过程中程序崩溃原文件仍然完好无损。4.3 批量更新优化如果需要更新多个配置项频繁保存文件会影响性能。这时可以使用批量更新模式public class ConfigBatchUpdater : IDisposable { private readonly string _filePath; private XmlDocument _document; private bool _isModified false; public ConfigBatchUpdater(string filePath) { _filePath filePath; _document new XmlDocument(); if (File.Exists(filePath)) { _document.Load(filePath); } else { // 创建初始结构 InitializeNewDocument(); } } public void SetValue(string xpath, string value) { XmlNode node _document.SelectSingleNode(xpath); if (node null) { // 创建缺失的节点 node CreateMissingNodes(xpath); } if (node ! null node.InnerText ! value) { node.InnerText value; _isModified true; } } public void SaveChanges() { if (_isModified) { // 使用原子操作保存 SafeUpdateWithTempFile(_filePath, doc { // 这里实际上不需要做任何事情因为我们已经有了完整的文档 // 这个方法会被临时文件方案的updateAction调用 }); // 重新加载文档确保内存中的副本与文件同步 _document.Load(_filePath); _isModified false; } } public void Dispose() { SaveChanges(); } // 其他辅助方法... }使用方式using (var updater new ConfigBatchUpdater(config.xml)) { updater.SetValue(/AppConfig/UserPreferences/Theme, Light); updater.SetValue(/AppConfig/UserPreferences/WindowWidth, 1400); updater.SetValue(/AppConfig/UserPreferences/WindowHeight, 900); // 所有修改会在Dispose时自动保存 }这种模式特别适合在应用关闭时一次性保存所有配置变更。5. 实战技巧与常见问题处理在实际项目中仅仅会基本的CRUD操作是不够的。下面分享一些我积累的实战技巧和常见问题的解决方案。5.1 配置验证与默认值配置文件可能被用户手动修改导致格式错误或值不合理。我们需要进行验证并提供合理的默认值public class ConfigValidator { public AppSettings ValidateAndFixConfig(string filePath) { var settings new AppSettings(); if (!File.Exists(filePath)) { return GetDefaultSettings(); } try { // 尝试加载并验证 XmlDocument doc new XmlDocument(); doc.Load(filePath); // 验证必需节点 if (!ValidateRequiredNodes(doc)) { Console.WriteLine(配置文件缺少必需节点使用默认值); return GetDefaultSettings(); } // 验证并修复各个配置项 settings.Theme ValidateTheme(doc); settings.WindowWidth ValidateWindowSize(doc, WindowWidth, 800, 3840); settings.WindowHeight ValidateWindowSize(doc, WindowHeight, 600, 2160); settings.AutoSave ValidateBoolean(doc, AutoSave, true); settings.RecentFiles ValidateRecentFiles(doc); // 如果修复了配置保存修复后的版本 if (SaveFixedConfigIfNeeded(doc, filePath)) { Console.WriteLine(配置文件已修复并保存); } return settings; } catch (XmlException) { // XML格式错误创建新的配置文件 Console.WriteLine(配置文件格式错误创建新的配置文件); CreateDefaultConfig(filePath); return GetDefaultSettings(); } } private string ValidateTheme(XmlDocument doc) { XmlNode node doc.SelectSingleNode(/AppConfig/UserPreferences/Theme); if (node null) return Dark; string theme node.InnerText.Trim(); string[] validThemes { Dark, Light, Blue, Green }; return validThemes.Contains(theme) ? theme : Dark; } private int ValidateWindowSize(XmlDocument doc, string nodeName, int min, int max) { XmlNode node doc.SelectSingleNode($/AppConfig/UserPreferences/{nodeName}); if (node null) return min; if (int.TryParse(node.InnerText, out int value)) { return Math.Clamp(value, min, max); } return min; } }5.2 配置版本迁移随着应用迭代配置格式可能需要升级。良好的版本管理可以避免用户配置丢失public class ConfigMigrator { public bool MigrateConfig(string filePath) { if (!File.Exists(filePath)) return false; try { XmlDocument doc new XmlDocument(); doc.Load(filePath); // 获取当前版本 XmlAttribute versionAttr doc.DocumentElement?.Attributes?[version]; string currentVersion versionAttr?.Value ?? 1.0; // 根据版本执行迁移 switch (currentVersion) { case 1.0: MigrateFromV1ToV2(doc); currentVersion 2.0; break; case 2.0: MigrateFromV2ToV3(doc); currentVersion 3.0; break; default: // 已经是最新版本 return true; } // 更新版本号 if (doc.DocumentElement ! null) { if (versionAttr null) { versionAttr doc.CreateAttribute(version); doc.DocumentElement.Attributes.Append(versionAttr); } versionAttr.Value currentVersion; } // 保存迁移后的配置 doc.Save(filePath); return true; } catch (Exception ex) { Console.WriteLine($配置迁移失败: {ex.Message}); return false; } } private void MigrateFromV1ToV2(XmlDocument doc) { // V1到V2的迁移逻辑 // 例如将Theme的值从Black改为Dark XmlNode themeNode doc.SelectSingleNode(/AppConfig/UserPreferences/Theme); if (themeNode ! null themeNode.InnerText Black) { themeNode.InnerText Dark; } // 添加新的配置项 XmlNode userPrefs doc.SelectSingleNode(/AppConfig/UserPreferences); if (userPrefs ! null) { XmlElement autoUpdate doc.CreateElement(AutoUpdate); autoUpdate.InnerText true; userPrefs.AppendChild(autoUpdate); } } }5.3 性能对比与选择建议不同的XML操作方式有不同的适用场景。下面是一个简单的对比表格操作方式适用场景优点缺点内存占用XmlDocument中小型配置文件需要频繁随机访问API简单易用支持XPath查询整个文档加载到内存大文件性能差高XmlReader大型文件顺序读取内存效率高速度快只能向前读取不能随机访问低XmlWriter生成大型XML文件内存效率高控制精细只能写入不能修改低XDocument (LINQ to XML)需要LINQ查询代码简洁语法简洁LINQ集成好.NET Framework 3.5性能略差于XmlDocument中等我的选择建议对于小于1MB的配置文件使用XmlDocument最简单直接对于1MB-10MB的配置文件考虑使用XDocument获得更好的代码可读性对于大于10MB的配置文件必须使用XmlReader/XmlWriter如果需要复杂的查询XDocument的LINQ语法更优雅如果需要最大性能XmlReader/XmlWriter是最佳选择5.4 错误处理的最佳实践XML操作可能失败的原因有很多文件被占用、磁盘空间不足、格式错误、权限问题等。下面是一个完整的错误处理策略public class RobustConfigManager { private readonly string _configPath; private readonly string _backupPath; private readonly ILogger _logger; public RobustConfigManager(string configPath, ILogger logger) { _configPath configPath; _backupPath configPath .backup; _logger logger; } public AppSettings LoadConfigWithRetry(int maxRetries 3) { for (int attempt 1; attempt maxRetries; attempt) { try { return LoadConfigInternal(); } catch (IOException ex) when (attempt maxRetries) { _logger.Warning($第{attempt}次加载配置失败文件被占用等待后重试: {ex.Message}); Thread.Sleep(100 * attempt); // 指数退避 } catch (XmlException ex) { _logger.Error($XML格式错误: {ex.Message}); if (File.Exists(_backupPath)) { _logger.Info(尝试从备份恢复配置); RestoreFromBackup(); continue; // 重试 } else { _logger.Info(无可用备份创建默认配置); CreateDefaultConfig(); return GetDefaultSettings(); } } catch (UnauthorizedAccessException ex) { _logger.Error($权限不足: {ex.Message}); throw; // 权限问题无法自动恢复 } catch (Exception ex) { _logger.Error($未知错误: {ex.Message}); if (attempt maxRetries) throw; } } return GetDefaultSettings(); } private void RestoreFromBackup() { try { File.Copy(_backupPath, _configPath, true); _logger.Info(配置已从备份恢复); } catch (Exception ex) { _logger.Error($恢复备份失败: {ex.Message}); CreateDefaultConfig(); } } private void CreateBackup() { try { if (File.Exists(_configPath)) { File.Copy(_configPath, _backupPath, true); } } catch (Exception ex) { _logger.Warning($创建备份失败: {ex.Message}); // 备份失败不应阻止主操作 } } }这个错误处理策略包含了重试机制对于临时性错误如文件被占用自动重试备份恢复配置文件损坏时从备份恢复优雅降级所有恢复尝试都失败时使用默认配置详细日志记录所有错误和恢复操作便于排查问题在实际项目中我发现很多配置相关的问题都可以通过良好的错误处理来避免。特别是备份机制它能在用户误操作或程序异常时保护用户数据。XML配置文件操作看似简单但要做好却需要考虑到很多细节。从基本的读写操作到并发安全再到错误恢复和版本迁移每一个环节都可能影响用户体验。我建议在项目初期就建立完善的配置管理机制这会在后续维护中节省大量时间。