.NET 使用 XPath 来读写 XML 文件

.NET 使用 XPath 来读写 XML 文件

发布于 2018-06-24 13:10 更新于 2018-09-01 00:02

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>

参考资料

本文会经常更新,请阅读原文: https://walterlv.com/post/read-write-xml-using-xpath-in-dotnet.html ,以避免陈旧错误知识的误导,同时有更好的阅读体验。

本作品采用 知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议 进行许可。欢迎转载、使用、重新发布,但务必保留文章署名 吕毅 (包含链接: https://walterlv.com ),不得用于商业目的,基于本文修改后的作品务必以相同的许可发布。如有任何疑问,请 与我联系 (walter.lv@qq.com)

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏积累沉淀

java事物处理

事物处理 什么是事物:个人认为事物,就是对数据库进行一组操作动作的集合,如果一组处理步骤要么全发生,要么一步也不执行,称这组处理步骤为一个事物。当所...

29190
来自专栏恰童鞋骚年

.NET单元测试的艺术-1.入门

开篇:最近在看Roy Osherove的《单元测试的艺术》一书,颇有收获。因此,将其记录下来,并分为四个部分分享成文,与各位Share。本篇作为入门,介绍了单元...

12320
来自专栏祝威廉

Kafka Zero-Copy 使用分析

Kafka 我个人感觉是性能优化的典范。而且使用Scala开发,代码写的也很漂亮的。重点我觉得有四个

27620
来自专栏owent

pbc的一个陈年老BUG

近期跟了一下pbc的lua-binding的一个老BUG,起源是我们客户端报了一个奇怪的问题,我们游戏里的某些功能的optional字段,服务器并没有下发数据,...

15320
来自专栏iOS技术

YYCache 源码剖析:一览亮点

YYCache 作为当下 iOS 圈最流行的缓存框架,有着优越的性能和绝佳的设计。笔者花了些时间对其“解剖”了一番,发现了很多有意思的东西,所以写下本文分享一下...

54350
来自专栏岑玉海

hbase源码系列(六)HMaster启动过程

  这一章是server端开始的第一章,有兴趣的朋友先去看一下hbase的架构图,我专门从网上弄下来的。   按照HMaster的run方法的注释,我们可以了解...

63790
来自专栏小灰灰

RabbitMQ基础教程之基本使用篇

19020
来自专栏张泽旭的专栏

基于spring boot sftp文件上传

对sftp文件上传将行封装,实现连接的单例模式,完成线程安全的改进,sftp文件上传下载失败的重试。

46510
来自专栏北京马哥教育

爬虫框架Scrapy的第一个爬虫示例入门教程

豌豆贴心提醒,本文阅读时间8分钟 我们使用dmoz.org这个网站来作为小抓抓一展身手的对象。 首先先要回答一个问题。 问:把网站装进爬虫里,总共分几步? ...

37380
来自专栏信安之路

HCTF2017的三个WriteUp

解决方法就是先 undefine 掉函数,再右键选择 Code,最后 Create function 就可以正常反编译了。

13100

扫码关注云+社区

领取腾讯云代金券