在 C# 中使用带有默认命名空间的 Xpath

Question

我有一个带有默认命名空间的 XML 文档。 我正在使用 XPathNavigator 使用 Xpath 选择一组节点，如下所示：

XmlElement myXML = ...;  
XPathNavigator navigator = myXML.CreateNavigator();
XPathNodeIterator result = navigator.Select("/outerelement/innerelement");

我没有收到任何结果：我假设这是因为我没有指定名称空间。 如何在我的选择中包含名称空间？

Answer 1

首先 - 你不需要导航器； SelectNodes / SelectSingleNode 应该足够了。

但是，您可能需要一个名称空间管理器 - 例如：

XmlElement el = ...; //TODO
XmlNamespaceManager nsmgr = new XmlNamespaceManager(
    el.OwnerDocument.NameTable);
nsmgr.AddNamespace("x", el.OwnerDocument.DocumentElement.NamespaceURI);
var nodes = el.SelectNodes(@"/x:outerelement/x:innerelement", nsmgr);

Answer 2

您可能想尝试 XPath Visualizer 工具来帮助您完成任务。

XPathVisualizer 是免费的，易于使用。

重要提示：如果您使用的是 Windows 7/8，并且看不到“文件”、“编辑”和“帮助”菜单项，请按 ALT 键。

Answer 3

对于任何寻求快速破解解决方案的人来说，尤其是在您了解 XML 并且不需要担心名称空间等的情况下，您可以通过简单地绕过这个烦人的小“功能”将文件读取为字符串并替换攻击性属性：

XmlDocument doc = new XmlDocument();
string fileData = File.ReadAllText(fileName);
fileData = fileData.Replace(" xmlns=\"", " whocares=\"");
using (StringReader sr = new StringReader(fileData))
{
   doc.Load(sr);
}

XmlNodeList nodeList = doc.SelectNodes("project/property");

我发现这比处理单个文件时需要默认名称空间前缀的所有其他无意义的操作更容易。 希望这可以帮助。

Answer 4

在带有命名空间的 XML 上使用 .NET 中的 XPath（通过导航器或 SelectNodes/SelectSingleNode）时，您需要：

• 提供您自己的 XmlNamespaceManager

• 和为 XPath 表达式中命名空间中的所有元素添加前缀。

后者是（从下面链接的 MS 源代码解释）：因为 XPath 1.0 忽略默认名称空间规范 (xmlns="some_namespace")。 因此，当您使用不带前缀的元素名称时，它假定命名空间为空。

这就是为什么 XPath 的 .NET 实现会忽略 XmlNamespaceManager 中带有前缀 String.Empty 的命名空间，并始终使用 null 命名空间。

请参阅 XmlNamespaceManager 和 UndefinedXsltContext 不'处理默认命名空间以获取更多信息。

我发现这个“功能”非常不方便，因为您无法通过简单地添加默认命名空间声明来使旧的 XPath 命名空间感知，但这就是它的工作原理。

Answer 5

您可以使用 XPath 语句而不使用 XmlNamespaceManager，如下所示：

...
navigator.Select("//*[ local-name() = 'innerelement' and namespace-uri() = '' ]")
...

这是在定义了默认命名空间的 XML 中选择元素的简单方法。

重点是使用：

namespace-uri() = ''

它将在不使用前缀的情况下找到具有默认名称空间的元素。

Answer 6

我的回答扩展了布兰登之前的回答。 我使用他的示例创建了一个扩展方法，如下所示：

static public class XmlDocumentExt
{
    static public XmlNamespaceManager GetPopulatedNamespaceMgr(this System.Xml.XmlDocument xd)
    {
        XmlNamespaceManager nmsp = new XmlNamespaceManager(xd.NameTable);
        XPathNavigator nav = xd.DocumentElement.CreateNavigator();
        foreach (KeyValuePair<string,string> kvp in nav.GetNamespacesInScope(XmlNamespaceScope.All))
        {
            string sKey = kvp.Key;
            if (sKey == "")
            {
                sKey = "default";
            }
            nmsp.AddNamespace(sKey, kvp.Value);
        }

        return nmsp;
    }
}

然后在我的 XML 解析代码中，我只添加一行：

XmlDocument xdCandidate = new XmlDocument();
xdCandidate.Load(sCandidateFile);
XmlNamespaceManager nmsp = xdCandidate.GetPopulatedNamespaceMgr();  // 1-line addition
XmlElement xeScoreData = (XmlElement)xdCandidate.SelectSingleNode("default:ScoreData", nmsp);

我真的很喜欢这个方法，因为它在从源 XML 文件加载命名空间方面是完全动态的，而且它并没有完全忽视 XML 命名空间的概念，因此它可以与需要多个命名空间来消除冲突的 XML 一起使用。

Answer 7

我遇到了类似的问题，默认命名空间为空。 在此示例 XML 中，我混合了带有命名空间前缀的元素和不带命名空间前缀的单个元素 (DataBlock)：

<src:SRCExample xmlns="urn:some:stuff:here" xmlns:src="www.test.com/src" xmlns:a="www.test.com/a" xmlns:b="www.test.com/b">
 <DataBlock>
  <a:DocID>
   <a:IdID>7</a:IdID>
  </a:DocID>
  <b:Supplimental>
   <b:Data1>Value</b:Data1>
   <b:Data2/>
   <b:Extra1>
    <b:More1>Value</b:More1>
   </b:Extra1>
  </b:Supplimental>
 </DataBlock>
</src:SRCExample>

我尝试使用在 XPath Visualizer 中工作的 XPath，但在我的代码中不起作用：

  XmlDocument doc = new XmlDocument();
  doc.Load( textBox1.Text );
  XPathNavigator nav = doc.DocumentElement.CreateNavigator();
  XmlNamespaceManager nsman = new XmlNamespaceManager( nav.NameTable );
  foreach ( KeyValuePair<string, string> nskvp in nav.GetNamespacesInScope( XmlNamespaceScope.All ) ) {
    nsman.AddNamespace( nskvp.Key, nskvp.Value );
  }

  XPathNodeIterator nodes;

  XPathExpression failingexpr = XPathExpression.Compile( "/src:SRCExample/DataBlock/a:DocID/a:IdID" );
  failingexpr.SetContext( nsman );
  nodes = nav.Select( failingexpr );
  while ( nodes.MoveNext() ) {
    string testvalue = nodes.Current.Value;
  }

我将其范围缩小到XPath 的“DataBlock”元素，但除了简单地使用 DataBlock 元素的通配符之外无法使其工作：

  XPathExpression workingexpr = XPathExpression.Compile( "/src:SRCExample/*/a:DocID/a:IdID" );
  failingexpr.SetContext( nsman );
  nodes = nav.Select( failingexpr );
  while ( nodes.MoveNext() ) {
    string testvalue = nodes.Current.Value;
  }

经过多次绞尽脑汁和谷歌搜索（这让我来到这里），我决定直接在我的 XmlNamespaceManager 加载器中处理默认名称空间，方法是将其更改为：

  foreach ( KeyValuePair<string, string> nskvp in nav.GetNamespacesInScope( XmlNamespaceScope.All ) ) {
    nsman.AddNamespace( nskvp.Key, nskvp.Value );
    if ( nskvp.Key == "" ) {
      nsman.AddNamespace( "default", nskvp.Value );
    }
  }

所以现在“default”和“”指向相同的命名空间。 一旦我这样做了，XPath“/src:SRCExample/default:DataBlock/a:DocID/a:IdID”就按照我想要的方式返回了我的结果。 希望这有助于为其他人澄清这个问题。

Answer 8

如果外部元素和内部元素的命名空间不同

XmlNamespaceManager manager = new XmlNamespaceManager(myXmlDocument.NameTable);
                            manager.AddNamespace("o", "namespaceforOuterElement");
                            manager.AddNamespace("i", "namespaceforInnerElement");
string xpath = @"/o:outerelement/i:innerelement"
// For single node value selection
XPathExpression xPathExpression = navigator.Compile(xpath );
string reportID = myXmlDocument.SelectSingleNode(xPathExpression.Expression, manager).InnerText;

// For multiple node selection
XmlNodeList myNodeList= myXmlDocument.SelectNodes(xpath, manager);

Answer 9

就我而言，添加前缀是不切实际的。 太多的 xml 或 xpath 是在运行时确定的。 最终我在 XmlNode 上扩展了这些方法。 这尚未针对性能进行优化，并且可能无法处理所有情况，但到目前为止它对我有用。

    public static class XmlExtenders
{

    public static XmlNode SelectFirstNode(this XmlNode node, string xPath)
    {
        const string prefix = "pfx";
        XmlNamespaceManager nsmgr = GetNsmgr(node, prefix);
        string prefixedPath = GetPrefixedPath(xPath, prefix);
        return node.SelectSingleNode(prefixedPath, nsmgr);
    }

    public static XmlNodeList SelectAllNodes(this XmlNode node, string xPath)
    {
        const string prefix = "pfx";
        XmlNamespaceManager nsmgr = GetNsmgr(node, prefix);
        string prefixedPath = GetPrefixedPath(xPath, prefix);
        return node.SelectNodes(prefixedPath, nsmgr);
    }

    public static XmlNamespaceManager GetNsmgr(XmlNode node, string prefix)
    {
        string namespaceUri;
        XmlNameTable nameTable;
        if (node is XmlDocument)
        {
            nameTable = ((XmlDocument) node).NameTable;
            namespaceUri = ((XmlDocument) node).DocumentElement.NamespaceURI;
        }
        else
        {
            nameTable = node.OwnerDocument.NameTable;
            namespaceUri = node.NamespaceURI;
        }
        XmlNamespaceManager nsmgr = new XmlNamespaceManager(nameTable);
        nsmgr.AddNamespace(prefix, namespaceUri);
        return nsmgr;
    }

    public static string GetPrefixedPath(string xPath, string prefix)
    {
        char[] validLeadCharacters = "@/".ToCharArray();
        char[] quoteChars = "\'\"".ToCharArray();

        List<string> pathParts = xPath.Split("/".ToCharArray()).ToList();
        string result = string.Join("/",
                                    pathParts.Select(
                                        x =>
                                        (string.IsNullOrEmpty(x) ||
                                         x.IndexOfAny(validLeadCharacters) == 0 ||
                                         (x.IndexOf(':') > 0 &&
                                          (x.IndexOfAny(quoteChars) < 0 || x.IndexOfAny(quoteChars) > x.IndexOf(':'))))
                                            ? x
                                            : prefix + ":" + x).ToArray());
        return result;
    }
}

然后在你的代码中使用类似的

        XmlDocument document = new XmlDocument();
        document.Load(pathToFile);
        XmlNode node = document.SelectFirstNode("/rootTag/subTag");

希望这有帮助

Answer 10

我使用了上面 SpikeDog 描述的虽然简单但有用的方法。 它运行得很好，直到我向它添加一个使用管道组合多个路径的 xpath 表达式。

所以我用正则表达式重写了它，并认为我会分享：

public string HackXPath(string xpath_, string prefix_)
{
    return System.Text.RegularExpressions.Regex.Replace(xpath_, @"(^(?![A-Za-z0-9\-\.]+::)|[A-Za-z0-9\-\.]+::|[@|/|\[])(?'Expression'[A-Za-z][A-Za-z0-9\-\.]*)", x =>
                {
                    int expressionIndex = x.Groups["Expression"].Index - x.Index;
                    string before = x.Value.Substring(0, expressionIndex);
                    string after = x.Value.Substring(expressionIndex, x.Value.Length - expressionIndex);
                    return String.Format("{0}{1}:{2}", before, prefix_, after);
                });
}

Answer 11

或者，如果有人像我一样应该使用 XPathDocument：

XPathDocument xdoc = new XPathDocument(file);
XPathNavigator nav = xdoc.CreateNavigator();
XmlNamespaceManager nsmgr = new XmlNamespaceManager(nav.NameTable);
nsmgr.AddNamespace("y", "http://schemas.microsoft.com/developer/msbuild/2003");
XPathNodeIterator nodeIter = nav.Select("//y:PropertyGroup", nsmgr);

Answer 12

1] 如果您的 XML 文件在命名空间中没有任何前缀：

<bookstore xmlns="http://www.contoso.com/books">
…
</bookstore>

您有以下解决方法：

XmlTextReader reader = new XmlTextReader(@"C:\Temp\books.xml");
// ignore the namespace as there is a single default namespace:
reader.Namespaces = false;
XPathDocument document = new XPathDocument(reader);
XPathNavigator navigator = document.CreateNavigator();
XPathNodeIterator nodes = navigator.Select("//book");

2] 如果您的 XML 文件在命名空间中具有前缀：

<bookstore xmlns:ns="http://www.contoso.com/books">
…
</bookstore>

使用此方法：

XmlTextReader reader = new XmlTextReader(@"C:\Temp\books.xml");
XPathDocument document = new XPathDocument(reader);
XPathNavigator navigator = document.CreateNavigator();
XPathNodeIterator nodes = navigator.Select("//book");

当然，如果需要，您可以使用命名空间管理：

XmlTextReader reader = new XmlTextReader(@"C:\Temp\books.xml");
XPathDocument document = new XPathDocument(reader);
XPathNavigator navigator = document.CreateNavigator();
XmlNamespaceManager nsmgr = new XmlNamespaceManager(reader.NameTable);
nsmgr.AddNamespace("ns", "http://www.contoso.com/book");
XPathNodeIterator nodes = navigator.Select("//book", nsmgr);

我认为这是使代码在大多数情况下工作的最简单方法。

我希望这有助于解决这个微软问题......

Answer 13

这个问题至今仍困扰着我。 我现在已经做了一些测试，所以希望我能帮助你。

这是来自 Microsoft 的来源，是问题的关键

重要的一段在这里：

XPath 将空前缀视为空命名空间。 换句话说，只有映射到名称空间的前缀才能在 XPath 查询中使用。 这意味着，如果要查询 XML 文档中的命名空间，即使它是默认命名空间，也需要为其定义前缀。

本质上，您必须记住 XPath 解析器使用命名空间 URI - 其设计是前缀可互换。 就是这样，在编程时，您可以分配我们想要的任何前缀 - 只要 URI 匹配即可。

为了清楚起见，通过示例：

示例 A：

<data xmlns:nsa="http://example.com/ns"><nsa:a>World</nsa:a></data>

它具有 NULL 默认 URI（xmlns= 未定义）。 因此 /data/nsa:a 返回“World”。

示例 B：

<data xmlns:nsa="http://example.com/ns" xmlns="https://standardns/"><nsa:a>World</nsa:a></data>

此文档具有命名的默认前缀 https://standardns/。 因此，使用 /data/nsa:a 执行 XPathNavigator.Execute 不会返回任何结果。 MS 认为 data 的 XML namespace uri 应该为 NULL，而 data 的命名空间 URI 实际上是“https://standardns/” 。 本质上，XPath 正在寻找 /NULL:data/nsa:a - 尽管这不起作用，因为您不能将 NULL URI 作为“NULL”作为前缀引用。 NULL 前缀是所有 XPath 中的默认前缀 - 因此出现了问题。

我们如何解决这个问题？

XmlNamespaceManager result = new XmlNamespaceManager(xDoc.NameTable);
result.AddNamespace("DEFAULT", "https://standardns/");
result.AddNamespace("nsa", "http://example.com/ns");

这样，我们现在可以将 a 引用为 /DEFAULT:data/nsa:a

示例 C:

<data><a xmlns="https://standardns/">World</a></data>

在此示例中，data 位于空命名空间。 a 位于默认命名空间“https://standardns/”中。 根据 Microsoft 的说法，/data/a 不应该工作，因为 a 位于 NS https://standardns/ 和 data 中 位于命名空间 NULL 中。 因此 被隐藏（除非通过执行奇怪的“忽略名称空间”黑客）并且无法按原样选择。 这本质上是根本原因 - 您不应该能够选择两者都没有前缀的“a”和“data”，因为这会假设它们位于同一名称空间中，但事实并非如此！

我们如何解决这个问题？

XmlNamespaceManager result = new XmlNamespaceManager(xDoc.NameTable);
result.AddNamespace("DEFAULT", "https://standardns/");

这样，我们现在可以将 a 引用为 /data/DEFAULT:a，因为 data 是从 NULL 命名空间中选择的，而 a 是从新前缀“DEFAULT”中选择的。 此示例中重要的是命名空间前缀不需要保持不变。 在代码中引用具有不同前缀的 URI 命名空间是完全可以接受的，就像您正在处理的文档中写入的内容一样。

希望这可以帮助一些人！

Answer 14

在这种情况下，问题的原因可能是名称空间解析，但您的 XPath 表达式本身也可能不正确。 您可能想先对其进行评估。

这是使用 XPathNavigator 的代码。

//xNav is the created XPathNavigator.
XmlNamespaceManager mgr = New XmlNamespaceManager(xNav.NameTable);
mgr.AddNamespace("prefix", "http://tempuri.org/");

XPathNodeIterator result = xNav.Select("/prefix:outerelement/prefix:innerelement", mgr);