当前位置: 首页 > news >正文

.NET 使用 XPath 来读写 XML 文件

XPath 是 XML 路径语言(XML Path Language),用来确定XML文档中某部分位置的语言。无论是什么语言什么框架,几乎都可以使用 XPath 来高效查询 XML 文件。

本文将介绍 .NET 中的 XPath 相关类型的使用。


本文读写的 XML 文件会以 文章末尾的代码 - 假设的 XML 文件 作为示例。

关于 XPath 语法,可以阅读 XML 的 XPath 语法 了解更多。

一切从这里开始

.NET 中支持 XPath 的 XML 文档类有两种读取方法,一种是 XPathDocument,以只读的方式读取;另一种是 XmlDocument,不止可以读,还可以编辑。

// 得到 walterlv.xml 文档在内存中的快速只读表示形式。
var xPathDocument = new XPathDocument("walterlv.xml");
// 以可读可写的方式打开 walterlv.xml 文件。
var xmlDocument = new XmlDocument();  
xmlDocument.Load("walterlv.xml"); 

如果要确定 XML 的文件编码,需要使用 XmlTextReader 来读 XML 文件;它的基类 XmlReader 没有提供编码信息。XmlTextReader 作为参数传入 XPathDocument 的构造函数或 XmlDocument.Load 方法中即可。

无论是 XPathDocument 还是 XmlDocument,因为都实现了 IXPathNavigable,所以都有 CreateNavigator(); 方法,调用能得到 XPathNavigator 对象。不过前者的 CanEditfalse,后者的 CanEdittrue

var navigator1 = xPathDocument.CreateNavigator();
var navigator2 = xmlDocument.CreateNavigator();

上手 XPath

路径查询

XPathNavigator 对象提供了下面两种通用的 XPath 表达式的使用检索方法。

  • Select
  • SelectSingleNode

比如希望检索本文末尾的 XML 文件中的 id,使用 /package/metadata/id 即可检索。

当然,事实上这个 XML 文件是不能这样检索出来 id 的,因为它带有命名空间。

带有命名空间的检索需要使用到 XmlNamespaceManager 类,并写成下面这样:

var namespaceManager = new XmlNamespaceManager(new NameTable());
namespaceManager.AddNamespace("d", "http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd");
navigator.Select("/d:package/d:metadata/d:id", namespaceManager);

这里其实略微奇怪,因为命名 packageid 等都在默认的命名空间下,我们却必须显式加一个命名空间前缀。微软对此的解释是如果不指定命名空间前缀,默认都是 null,而不是 XML 声明的那个默认命名空间。这里是原文:

XPath treats the empty prefix as the null namespace. In other words, only prefixes mapped to namespaces can be used in XPath queries. This means that if you want to query against a namespace in an XML document, even if it is the default namespace, you need to define a prefix for it.

路径检索的语法也有很多种,可以参考我的另一篇文章 XML 的 XPath 语法。

为了提升性能,XPathNavigator 额外提供了这些方法,用于替代 XPath 中的部分对应的语法:

  • SelectChildren
  • SelectAncestors
  • SelectDescendants

XPath 函数调用

CompileEvaluate 提供了复杂的 XPath 函数调用。比如下面我们把几种 url 都拼接在一起得到一个新字符串。

XPathExpression query = navigator.Compile("concat(//licenseUrl/text(), //projectUrl/text(), //iconUrl/text())");
string urls = (string) navigator.Evaluate(query);

节点匹配

Matches 用来检查当前的节点是否满足某个条件。比如下面的例子便是检查当前节点的父节点是否是 group 并且其 targetFramework 属性为 .NETStandard2.0。显然,符合这个条件的只有最后的那个 dependency 节点。

navigator.Matches("../group/@targetFramework='.NETStandard2.0'");

XPath 导航

XPathNavigator 可以在节点、属性中间移动,以便能够不止从根节点进行查询。

  • MoveTo
  • MoveToChild
  • MoveToFirst
  • MoveToFirstChild
  • MoveToFollowing
  • MoveToId
  • MoveToNext
  • MoveToParent
  • MoveToPrevious
  • MoveToRoo
  • MoveToAttribute
  • MoveToFirstAttribute
  • MoveToNextAttribute
  • MoveToNamespace
  • MoveToFirstNamespace
  • MoveToNextNamespace

在导航到需要的节点或者属性后,可以使用 navigator.OuterXml 拿到节点的所有 XML 字符串。也可以使用下面这些方法拿到节点内部的值。

  • ValueAsBoolean
  • ValueAsDateTime
  • ValueAsDouble
  • ValueAsInt
  • ValueAsLong
  • ValueAs

编辑 XML

由于我们要编辑 XML 数据,所以加载 XML 文件的方式不能是 XPathDocument 了,得是 XmlDocument

插入使用 Insert 相关的方法,删除使用 Delete 相关的方法。而修改数据使用 SetValue

保存 XML 到文件

保存 XML 使用 XmlDocumentSave 或者 WriteTo 方法即可。


假设的 XML 文件

<?xml version="1.0" encoding="utf-8"?>
<package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd">
  <metadata>
    <id>MSTestEnhancer</id>
    <version>1.6.0</version>
    <authors>walterlv</authors>
    <owners>walterlv</owners>
    <requireLicenseAcceptance>false</requireLicenseAcceptance>
    <licenseUrl>https://github.com/easiwin/MSTestEnhancer/blob/master/LICENSE</licenseUrl>
    <projectUrl>https://easiwin.github.io/mstest-enhancer</projectUrl>
    <iconUrl>https://easiwin.github.io/mstest-enhancer/icon.png</iconUrl>
    <description>MSTestEnhancer helps you to write unit tests without naming any method. You can write method contract descriptions instead of writing confusing test method name when writing unit tests.</description>
    <releaseNotes>Support passing null into WithArgument method.</releaseNotes>
    <copyright>Copyright (c) 2018 dotnet职业技术学院</copyright>
    <repository type="git" url="https://github.com/easiwin/MSTestEnhancer.git" />
    <dependencies>
      <group targetFramework=".NETFramework4.5">
        <dependency id="MSTest.TestFramework" version="1.2.0" exclude="Build,Analyzers" />
        <dependency id="System.ValueTuple" version="4.4.0" exclude="Build,Analyzers" />
      </group>
      <group targetFramework=".NETFramework4.7">
        <dependency id="MSTest.TestFramework" version="1.2.0" exclude="Build,Analyzers" />
      </group>
      <group targetFramework=".NETStandard2.0">
        <dependency id="MSTest.TestFramework" version="1.2.0" exclude="Build,Analyzers" />
      </group>
    </dependencies>
  </metadata>
</package>

参考资料

  • 使用 XPath 导航选择节点 - Microsoft Docs
  • Process XML Data Using the XPath Data Model - Microsoft Docs
  • XPath Queries and Namespaces - Microsoft Docs
  • .NET(C#):使用XPath查询带有命名空间(有xmlns)的XML - Mgen
  • .net - How to use XPath with XElement or LINQ? - Stack Overflow

相关文章:

  • 像黑客一样!Chrome 完全键盘操作指南(原生快捷键 + Vimium 插件)
  • 如何在 .NET 库的代码中判断当前程序运行在 Debug 下还是 Release 下
  • 在制作跨平台的 NuGet 工具包时,如何将工具(exe/dll)的所有依赖一并放入包中
  • WPF 使用 WindowChrome,在自定义窗口标题栏的同时最大程度保留原生窗口样式(类似 UWP/Chrome)
  • 理解 Roslyn 中的红绿树(Red-Green Trees)
  • (1/2) 为了理解 UWP 的启动流程,我从零开始创建了一个 UWP 程序
  • (2/2) 为了理解 UWP 的启动流程,我从零开始创建了一个 UWP 程序
  • .NET/C# 使窗口永不获得焦点
  • .NET/C# 使用 SpanT 为字符串处理提升性能
  • WPF 应用完全模拟 UWP 的标题栏按钮
  • 让控制台支持 ANSI 转义序列,输出下划线、修改颜色或其他控制
  • 在 GitHub 公开仓库中隐藏自己的私人邮箱地址
  • Win32 程序在启动时激活前一个启动程序的窗口
  • C#/.NET 读取或修改文件的创建时间和修改时间
  • 通过解读 WPF 触摸源码,分析 WPF 插拔设备触摸失效的问题(问题篇)
  • 【159天】尚学堂高琪Java300集视频精华笔记(128)
  • Apache Zeppelin在Apache Trafodion上的可视化
  • flutter的key在widget list的作用以及必要性
  • golang 发送GET和POST示例
  • Promise面试题2实现异步串行执行
  • unity如何实现一个固定宽度的orthagraphic相机
  • vuex 笔记整理
  • 复杂数据处理
  • 看图轻松理解数据结构与算法系列(基于数组的栈)
  • 学习笔记TF060:图像语音结合,看图说话
  • MPAndroidChart 教程:Y轴 YAxis
  • ​Spring Boot 分片上传文件
  • # 飞书APP集成平台-数字化落地
  • #pragam once 和 #ifndef 预编译头
  • (02)Cartographer源码无死角解析-(03) 新数据运行与地图保存、加载地图启动仅定位模式
  • (bean配置类的注解开发)学习Spring的第十三天
  • (附源码)ssm基于jsp高校选课系统 毕业设计 291627
  • (附源码)计算机毕业设计SSM疫情下的学生出入管理系统
  • (三)Pytorch快速搭建卷积神经网络模型实现手写数字识别(代码+详细注解)
  • (一)使用IDEA创建Maven项目和Maven使用入门(配图详解)
  • (原+转)Ubuntu16.04软件中心闪退及wifi消失
  • (原創) 博客園正式支援VHDL語法著色功能 (SOC) (VHDL)
  • (转)VC++中ondraw在什么时候调用的
  • (转)总结使用Unity 3D优化游戏运行性能的经验
  • ***通过什么方式***网吧
  • ... 是什么 ?... 有什么用处?
  • .jks文件(JAVA KeyStore)
  • .NET的微型Web框架 Nancy
  • .net和php怎么连接,php和apache之间如何连接
  • @Conditional注解详解
  • @RunWith注解作用
  • [ 转载 ] SharePoint 资料
  • [\u4e00-\u9fa5] //匹配中文字符
  • []sim300 GPRS数据收发程序
  • [1159]adb判断手机屏幕状态并点亮屏幕
  • [ABC294Ex] K-Coloring
  • [AIGC] 开源流程引擎哪个好,如何选型?
  • [BT]BUUCTF刷题第9天(3.27)
  • [BZOJ5250][九省联考2018]秘密袭击(DP)
  • [C#]winform部署yolov9的onnx模型