如何将 XPath 与 XDocument 一起使用？

Posted 2023-02-16

【中文标题】如何将 XPath 与 XDocument 一起使用？

【英文标题】：how to use XPath with XDocument?

【发布时间】：2011-09-06 18:43:17

【问题描述】：

有一个类似的问题，但在我的情况下似乎没有解决方案：Weirdness with XDocument, XPath and namespaces

这是我正在使用的 XML：

<?xml version="1.0" encoding="utf-8"?>
<Report Id="ID1" Type="Demo Report" Created="2011-01-01T01:01:01+11:00" Culture="en" xmlns="http://demo.com/2011/demo-schema">
    <ReportInfo>
        <Name>Demo Report</Name>
        <CreatedBy>Unit Test</CreatedBy>
    </ReportInfo>
</Report>

下面是我认为它应该可以工作的代码，但它没有......

XDocument xdoc = XDocument.Load(@"C:\SampleXML.xml");
XmlNamespaceManager xnm = new XmlNamespaceManager(new NameTable()); 
xnm.AddNamespace(String.Empty, "http://demo.com/2011/demo-schema");
Console.WriteLine(xdoc.XPathSelectElement("/Report/ReportInfo/Name", xnm) == null);

有人有什么想法吗？ 谢谢。

【问题讨论】：

请参阅下面的另一个答案，它不起作用，因为 XPath 1.0 实现无法处理空前缀

正如其他人所说，在将命名空间添加到 [XmlNamespaceManager] 时不要使用空前缀。我只是添加此注释，以防有人想查看一个包含多个 [xmlns] 属性（带或不带后缀）的文档的小代码示例。见这里：***.com/a/38272604/5838538

【参考方案1】：

如果您有 XDocument，则使用 LINQ-to-XML 会更容易：

var document = XDocument.Load(fileName);
var name = document.Descendants(XName.Get("Name", @"http://demo.com/2011/demo-schema")).First().Value;

如果您确定 XPath 是您需要的唯一解决方案：

using System.Xml.XPath;

var document = XDocument.Load(fileName);
var namespaceManager = new XmlNamespaceManager(new NameTable());
namespaceManager.AddNamespace("empty", "http://demo.com/2011/demo-schema");
var name = document.XPathSelectElement("/empty:Report/empty:ReportInfo/empty:Name", namespaceManager).Value;

【讨论】：

我想说在大多数情况下很难说 linq 比 xpath 更容易。例如，在这种情况下，LINQ 等效项并不是真正等效的，因为它还会在其他节点下获得“名称”节点（这些节点现在不存在，但可以通过以后更改文件格式来添加）。但是，您的解决方案肯定是正确的。

注意：使用 System.Xml.XPath；非常重要，因为 XPathSelectElement 是一种扩展方法。不要像我做的那样忽略那部分;）

XPath 仍然很有帮助，因为它允许您将父子关系上下文化。例如。如果你想去 /Banana/Banana/Banana 而不是得到每一个香蕉

"empty" 在这里有点误导和混淆。您可以使用除 XPath、String.Empty 之外的任何东西（正如提问者所发现的那样）。 “demo”更适合这个例子。

【参考方案2】：

MS 实现的 XPath 1.0 没有默认命名空间的概念。所以试试这个：

XDocument xdoc = XDocument.Load(@"C:\SampleXML.xml");
XmlNamespaceManager xnm = new XmlNamespaceManager(new NameTable()); 
xnm.AddNamespace("x", "http://demo.com/2011/demo-schema");
Console.WriteLine(xdoc.XPathSelectElement("/x:Report/x:ReportInfo/x:Name", xnm) == null);

【讨论】：

您的回答暗示 XPath 2.0 与 XPath 1.0 相比“*具有”默认命名空间的想法。我不知道这种新的 XPath 功能（我们在这里谈论的是 XPath，而不是 XSLT或 XQuery）。因此，请您在回答中明确提及您的意思吗？

我认为他在这里得到的是，如果你有一个定义命名空间的文档，你的 xpath 必须包含合格的元素，即你不能做 xnm.AddNamespace(string.Empty, "@987654321 @); 然后 xdoc.XPathSelectElement("/Report/ReportInfo/Name", xnm) - 结果总是 null

【参考方案3】：

您可以使用 Microsoft 中的示例 - 没有命名空间的您：

using System.Xml.Linq;
using System.Xml.XPath;
var e = xdoc.XPathSelectElement("./Report/ReportInfo/Name");     

应该这样做

【讨论】：

此示例之所以有效，是因为该文档没有默认命名空间。但是 OPs 文档包含一个默认命名空间“xmlns=...”，并且对不支持的 xpath 执行相同操作。您必须始终指定一个不为空的后缀。

【参考方案4】：

要在没有默认命名空间后缀的情况下工作，我会自动扩展路径。

用法：SelectElement(xdoc.Root, "/Report/ReportInfo/Name");

private static XElement SelectElement(XElement startElement, string xpathExpression, XmlNamespaceManager namespaceManager = null) 
    // XPath 1.0 does not have support for default namespace, so we have to expand our path.
    if (namespaceManager == null) 
        var reader = startElement.CreateReader();
        namespaceManager = new XmlNamespaceManager(reader.NameTable);
    
    var defaultNamespace = startElement.GetDefaultNamespace();
    var defaultPrefix = namespaceManager.LookupPrefix(defaultNamespace.NamespaceName);
    if (string.IsNullOrEmpty(defaultPrefix)) 
        defaultPrefix = "ᆞ";
        namespaceManager.AddNamespace(defaultPrefix, defaultNamespace.NamespaceName);
    
    xpathExpression = AddPrefix(xpathExpression, defaultPrefix);
    var selected = startElement.XPathSelectElement(xpathExpression, namespaceManager);
    return selected;


private static string AddPrefix(string xpathExpression, string prefix) 
    // Implementation notes:
    // * not perfect, but it works for our use case.
    // * supports: "Name~~" "~~/Name~~" "~~@Name~~" "~~[Name~~" "~~[@Name~~"
    // * does not work in complex expressions like //*[local-name()="HelloWorldResult" and namespace-uri()='http://tempuri.org/']/text()
    // * does not exclude strings like 'string' or function like func()
    var s = Regex.Replace(xpathExpression, @"(?<a>/|\[@|@|\[|^)(?<name>\w(\w|[-])*)", "$a$prefix:$name".Replace("$prefix", prefix));
    return s;

如果有人有更好的解决方案来查找元素和属性名称，请随时更改此帖子。