C#使用XML文件的详解及示例

简介: C#使用XML文件的详解及示例

前言

XML是 Extensible Markup Language 的简称,用于存储和传输数据的可扩展标记语言。它被应用在数据交换、数据存储、Web服务、网络协议等场景。

XML 具有可扩展性、结构化、标准化、简单易读等几个特点。

基本结构

XML 基本结构包括文档声明、根元素、子元素、属性、注释、处理指令等部分。

<?xml version="1.0" encoding="UTF-8"?>
<根元素>
  <子元素 属性="属性值">内容</子元素>
  <!-- 注释内容 -->
  <?处理指令 ?>
</根元素>

文档声明

文档声明主要用于描述XML文档的版本与编码格式,每个文档必须包含一个声明,并在文档开头。如下声明:版本1.0 编码格式为UTF-8。

<?xml version="1.0" encoding="UTF-8"?>

根元素

根元素包围文档中的所有数据,是其它元素的根,每个文档必须有一个根元素。如下示例:有一个configure根元素,其下有其它内容。

<configure>
  <Description>Fountain WinForm App</Description>
  <Files>
    <File Version="1.2.11.0" Name="log4net.dll" DateTime="2023-4-26" />
  </Files>
</configure>

子元素

子元素是文档的基本单元,它包含属性、内容等元素。如下示例:

<name>Apple</name>
<File Version="1.2.11.0" Name="log4net.dll" DateTime="2023-4-26" />

属性

元素可以有属性,用于元素的额外信息。它在开始标签中定义,以名称/键值对的形式出现。如下示例:File 元素存在Version、Name、DateTime属性。

<File Version="1.2.11.0" Name="log4net.dll" DateTime="2023-4-26" />

注释

注释为文档中添加注释或说明,以<!--开始,以-->结束。如下示例:

<configure>
  <Description>Fountain WinForm App</Description>
  <Files>
    <!-- 程序的所文件名称、版本、更新日期 -->
    <File Version="1.2.11.0" Name="log4net.dll" DateTime="2023-4-26" />
  </Files>
</configure>

处理指令

处理指令提供了关于XML处理器如何处理文档的指令。如下示例:标识 文档的样式表。

<?xml-stylesheet type="text/xsl" href="sample.xsl"?>

命名空间

用于定义文档中元素和属性的范围和作用域的机制。

文档操作

通过System.XML命名空间中的类可以完成常用的操作。下表为操作XML文档相关的类。

描述

XmlDocument

创建、修改及保存XML文档。

XmlNode

表示 XML 文档中的单个节点

XmlElement

访问元素的名称、属性和子元素。

XmlTextWriter

提供快速、非缓存的写入器。

XPathDocument

提供只读形式读取XML文档。

XPathNavigator

提供浏览、提取XML节点 数据

XmlAttribute

访问XML属性的名称和值

XmlText

访问文本内容

创建文档

通过 XmlDocument 的 CreateXmlDeclaration 对 XML 文档进行声明,再通过 CreateElement 创建 XML 元素,最后保存 XML 文件。下面通过代码进一步了解 XML 文档的创建。

using System;
using System.IO;
using System.Windows.Forms;
using System.Xml;
namespace Fountain.WinForm.XMLDemo
{
    public partial class XMLDemoForm : Form
    {
        public XMLDemoForm()
        {
            InitializeComponent();
        }
        /// <summary>
        /// 创建文档
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>
        private void ButtonCreate_Click(object sender, EventArgs e)
        {
            try
            {
                XmlDocument xmlDocument = new XmlDocument();
                // XML声明
                XmlDeclaration xmlDeclaration = xmlDocument.CreateXmlDeclaration("1.0", "utf-8", "yes");
                xmlDocument.AppendChild(xmlDeclaration);
                //创建根元素
                XmlElement rootNode = xmlDocument.CreateElement("configure");
                xmlDocument.AppendChild(rootNode);
                // 创建 Description 子元素
                XmlElement descSubElement = xmlDocument.CreateElement("Description");
                //元素内容
                descSubElement.InnerText = "Fountain WinForm App";
                rootNode.AppendChild(descSubElement);
                // 创建 Updater 子元素
                XmlElement updaterSubElement = xmlDocument.CreateElement("Updater");
                rootNode.AppendChild(updaterSubElement);
                // 创建 url 子元素
                XmlElement urlSubElement = xmlDocument.CreateElement("url");
                //中间文本
                urlSubElement.InnerText = "http://127.0.0.1/update";
                // 添加到父结点
                updaterSubElement.AppendChild(urlSubElement);
                XmlElement versionSubElement = xmlDocument.CreateElement("Version");
                //中间文本
                versionSubElement.InnerText = "3.8.0.24043";
                // 添加到父结点
                updaterSubElement.AppendChild(versionSubElement);
                // 创建 Files 子元素
                XmlElement filesSubElement = xmlDocument.CreateElement("Files");
                rootNode.AppendChild(filesSubElement);
                // 创建 File 子元素
                XmlElement fileSubElement = xmlDocument.CreateElement("File");
                // 属性
                fileSubElement.SetAttribute("Version", "1.2.11.0");
                fileSubElement.SetAttribute("Name", "log4net.dll");
                fileSubElement.SetAttribute("DateTime", DateTime.Now.ToString("yyyy-MM-dd"));
                filesSubElement.AppendChild(fileSubElement);
                // 保存文档
                xmlDocument.Save(string.Format("{0}{1}{2}", Application.StartupPath,Path.DirectorySeparatorChar, "Version.xml"));
            }
            catch (Exception ex)
            {
                MessageBox.Show(ex.Message);
            }
        }
    }
}

运行结果:

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<configure>
  <Description>Fountain WinForm App</Description>
  <Updater>
    <url>http://127.0.0.1/update</url>
    <Version>3.8.0.24043</Version>
  </Updater>
  <Files>
    <File Version="1.2.11.0" Name="log4net.dll" DateTime="2024-04-13" />
  </Files>
</configure>

读取文档

通过 XmlDocument 的 Load 对 XML 文档进行加载XML文件,然后通过 SelectSingleNode 得到指定的节点元素,再通过 GetAttribute 得到具体的属性值。下面通过代码进一步了解 XML 文档的读取。

using System;
using System.IO;
using System.Text;
using System.Windows.Forms;
using System.Xml;
namespace Fountain.WinForm.XMLDemo
{
    public partial class XMLDemoForm : Form
    {
        public XMLDemoForm()
        {
            InitializeComponent();
        }
        /// <summary>
        /// 读取文档
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>
        private void ButtonRead_Click(object sender, EventArgs e)
        {
            try
            {
                XmlDocument xmlDocument = new XmlDocument();
                xmlDocument.Load(string.Format("{0}{1}{2}", Application.StartupPath, Path.DirectorySeparatorChar, "Version.xml"));
                // 获取 Files
                XmlNode XmlNode = xmlDocument.SelectSingleNode("configure");
                // 得到根节点的所有子节点
                XmlNodeList xmlNodeList = XmlNode.ChildNodes;
                StringBuilder stringBuilder = new StringBuilder();
                // 循环读取
                foreach (XmlNode xmlNode in xmlNodeList)
                {
                    // 判断节点是否有子节点
                    if (xmlNode.ChildNodes.Count>0)
                    {
                        foreach (XmlNode subXmlNode in xmlNode.ChildNodes)
                        {
                            stringBuilder.AppendLine(string.Format("{0}:{1}", subXmlNode.Name, subXmlNode.InnerText));
                            // 读取元素属性
                            if (subXmlNode.Attributes!=null && subXmlNode.Attributes.Count>0)
                            {
                                for (int i = 0; i < subXmlNode.Attributes.Count;i++)
                                {
                                    stringBuilder.AppendLine(string.Format("{0}:{1} 属性{2}={3}",
                                        subXmlNode.Name, 
                                        subXmlNode.InnerText,
                                        subXmlNode.Attributes[i].Name,
                                        subXmlNode.Attributes[i].Value));
                                }
                            }
                        }
                        continue;
                    }
                    stringBuilder.AppendLine(string.Format("{0}:{1}", xmlNode.Name,xmlNode.InnerText));
                }
                // MessageBox.Show(stringBuilder.ToString());
                Console.WriteLine(stringBuilder.ToString());
            }
            catch (Exception ex)
            {
                MessageBox.Show(ex.Message);
            }
        }
    }
}

运行结果:

#text:Fountain WinForm App
url:http://127.0.0.1/update
Version:3.8.0.24043
File:
File: 属性Version=1.2.11.0
File: 属性Name=log4net.dll
File: 属性DateTime=2024-04-13

修改文档

通过 XmlDocument 的 Load 对 XML 文档进行加载XML文件,然后读取到元素节点,对元素节点进行删除、变属性值、元素文本等,最后保存 XML 文件。下面通过代码进一步了解 XML 文档的修改。

using System;
using System.IO;
using System.Text;
using System.Windows.Forms;
using System.Xml;
namespace Fountain.WinForm.XMLDemo
{
    public partial class XMLDemoForm : Form
    {
        public XMLDemoForm()
        {
            InitializeComponent();
        }
        /// <summary>
        ///  修改文档
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>
        private void ButtonModify_Click(object sender, EventArgs e)
        {
            try
            {
                XmlDocument xmlDocument = new XmlDocument();
                xmlDocument.Load(string.Format("{0}{1}{2}", Application.StartupPath, Path.DirectorySeparatorChar, "Version.xml"));
                // 获取根元素
                XmlNode rootNode = xmlDocument.DocumentElement;
                // 获取主信息 
                XmlNodeList xmlNodeList = rootNode.SelectNodes("Updater");
                foreach (XmlNode xmlNodeUpdate in xmlNodeList)
                {
                    XmlNodeList xmlNodeMainInfo = xmlNodeUpdate.ChildNodes;
                    foreach (XmlNode xmlMainInfo in xmlNodeMainInfo)
                    {
                        if ("url".Equals(xmlMainInfo.Name,StringComparison.OrdinalIgnoreCase))
                        {
                            // 删除 url 元素节点
                            xmlNodeUpdate.RemoveChild(xmlMainInfo);
                            break;
                        }
                    }
                }
                // 循环读取
                foreach (XmlNode xmlNode in xmlNodeList)
                {
                    if (xmlNode.ChildNodes.Count > 0)
                    {
                        foreach (XmlNode subXmlNode in xmlNode.ChildNodes)
                        {
                            if (subXmlNode.Attributes != null && subXmlNode.Attributes.Count > 0)
                            {
                                for (int i = 0; i < subXmlNode.Attributes.Count; i++)
                                {
                                    if ("DateTime".Equals(subXmlNode.Attributes[i].Name,StringComparison.OrdinalIgnoreCase))
                                    {
                                        // 修改元素节点属性
                                        subXmlNode.Attributes[i].Value = DateTime.Now.ToString("yyyy-MM-dd");
                                    }
                                }
                            }
                        }
                        continue;
                    }
                }
                xmlDocument.Save(string.Format("{0}{1}{2}", Application.StartupPath, Path.DirectorySeparatorChar, "Version.xml"));
            }
            catch (Exception ex)
            {
                MessageBox.Show(ex.Message);
            }
        }
    }
}

运行结果:

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<configure>
  <Description>Fountain WinForm App</Description>
  <Updater>
    <Version>3.8.0.24043</Version>
  </Updater>
  <Files>
    <File Version="1.2.11.0" Name="log4net.dll" DateTime="2024-04-13" />
  </Files>
</configure>

小结

以上 XML 文档相关内容及在C#中如何实现对文件创建、修改、读取的操作。

目录
相关文章
|
10月前
|
Android开发 开发者
Android自定义View之不得不知道的文件attrs.xml(自定义属性)
本文详细介绍了如何通过自定义 `attrs.xml` 文件实现 Android 自定义 View 的属性配置。以一个包含 TextView 和 ImageView 的 DemoView 为例,讲解了如何使用自定义属性动态改变文字内容和控制图片显示隐藏。同时,通过设置布尔值和点击事件,实现了图片状态的切换功能。代码中展示了如何在构造函数中解析自定义属性,并通过方法 `setSetting0n` 和 `setbackeguang` 实现功能逻辑的优化与封装。此示例帮助开发者更好地理解自定义 View 的开发流程与 attrs.xml 的实际应用。
291 2
Android自定义View之不得不知道的文件attrs.xml(自定义属性)
|
XML 前端开发 Java
讲解SSM的xml文件
本文详细介绍了SSM框架中的xml配置文件,包括springMVC.xml和applicationContext.xml,涉及组件扫描、数据源配置、事务管理、MyBatis集成以及Spring MVC的视图解析器配置。
343 1
|
10月前
|
存储 监控 算法
基于 C# 的局域网计算机监控系统文件变更实时监测算法设计与实现研究
本文介绍了一种基于C#语言的局域网文件变更监控算法,通过事件驱动与批处理机制结合,实现高效、低负载的文件系统实时监控。核心内容涵盖监控机制选择(如事件触发机制)、数据结构设计(如监控文件列表、事件队列)及批处理优化策略。文章详细解析了C#实现的核心代码,并提出性能优化与可靠性保障措施,包括批量处理、事件过滤和异步处理等技术。最后,探讨了该算法在企业数据安全监控、文件同步备份等场景的应用潜力,以及未来向智能化扩展的方向,如文件内容分析、智能告警机制和分布式监控架构。
261 3
|
开发框架 安全 .NET
掌握 LINQ:通过示例解释 C# 中强大的 LINQ的集运算
通过本文的示例,我们详细介绍了C#中LINQ的强大集合运算功能。LINQ提供了一种简洁、灵活和类型安全的方式来查询和操作数据集合,从而大大提高了代码的可读性和可维护性。希望本文能帮助读者更好地掌握和应用LINQ,提高开发效率。
344 13
基于 C# 编写的 Visual Studio 文件编码显示与修改扩展插件
基于 C# 编写的 Visual Studio 文件编码显示与修改扩展插件
381 9
|
Java Maven
maven项目的pom.xml文件常用标签使用介绍
第四届人文,智慧教育与服务管理国际学术会议(HWESM 2025) 2025 4th International Conference on Humanities, Wisdom Education and Service Management
1219 8
|
XML JavaScript Java
java与XML文件的读写
java与XML文件的读写
195 3
|
存储 C#
【C#】大批量判断文件是否存在的两种方法效率对比
【C#】大批量判断文件是否存在的两种方法效率对比
500 1
|
XML Java 数据格式
Spring5入门到实战------7、IOC容器-Bean管理XML方式(外部属性文件)
这篇文章是Spring5框架的实战教程,主要介绍了如何在Spring的IOC容器中通过XML配置方式使用外部属性文件来管理Bean,特别是数据库连接池的配置。文章详细讲解了创建属性文件、引入属性文件到Spring配置、以及如何使用属性占位符来引用属性文件中的值。
Spring5入门到实战------7、IOC容器-Bean管理XML方式(外部属性文件)

相关课程

更多