C#使用XML文件的操作详解及示例_Asp.net

前言

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" rel="external nofollow" ?>

命名空间

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

文档操作

通过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>