在 C 语言中使用具有默认命名空间的 Xpath#

Using Xpath With Default Namespace in C#

提问人:macleojw 提问时间:2/25/2009 更新时间:7/16/2021 访问量:84943

问:

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

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

我没有得到任何结果:我假设这是因为我没有指定命名空间。如何将命名空间包含在我的选择中?

C# XML 命名空间 XPathNavigator

评论

0赞 k3b 11/25/2010
请参阅类似的问题 stackoverflow.com/questions/4271689/...,其中包含一些紧凑的示例作为单元测试

答:

87赞 Marc Gravell 2/25/2009 #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);

评论

14赞 JohnLBevan 4/7/2017
注意:将别名设置为空白字符串 () 会使其成为默认命名空间。然而,可悲的是,这并不意味着你可以在不使用前缀的情况下使用 XPaths(例如 )。只有您可以使用 .更多信息请见:stackoverflow.com/a/4271875/361842。添加注释以节省其他人的时间,如果希望避免使用前缀;即你不能。nsmgr.AddNamespace("", el.OwnerDocument.DocumentElement.NamespaceURI);var nodes = el.SelectNodes(@"/outerelement/innerelement", nsmgr);nsmgr.DefaultNamespace
1赞 Ravi M Patel 12/13/2017
还有一个技巧,如果你只是替换为 p 可以是任何有效前缀的地方,你的代码应该按原样工作。xmlns=xmlns:p
0赞 Luke 6/29/2018
我试过你的代码,但Visual Studio说,你能看看吗?imgur.com/a/TPHVeoMXElement does not contain a definition for OwnerDocument...
0赞 Cerebrus 2/25/2009 #2

在这种情况下,可能是命名空间解析是问题的原因,但也可能是您的 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);
5赞 Rashmi Pandit 2/25/2009 #3

如果 outerelement 和 innerelement 的命名空间不同

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);
49赞 Cheeso 12/13/2009 #4

您可能需要尝试使用 XPath Visualizer 工具来帮助您完成任务。

XPathVisualizer 是免费的,易于使用。

alt text

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

评论

0赞 Cheeso 10/19/2011
不知道这是否适用于XP。如果你只是抓住二进制文件,它可能会。我没有XP,所以无法测试它。我不知道其他工具。
1赞 Craig T 12/13/2011
版本 1.2 适用于 Windows XP - xpathvisualizer.codeplex.com/releases/view/42941
1赞 testing 3/30/2022
链接已关闭...
0赞 Abdul Saleem 2/6/2023
xpather.com
3赞 SpikeDog 1/13/2010 #5

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

    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");

希望这会有所帮助

评论

1赞 Dan 10/21/2010
我使用了这段代码,它就像一个魅力,直到我今天遇到它的问题。它不处理使用管道的 xpath 表达式。由于我发现原始代码难以阅读,因此我使用正则表达式重写了它,我发现这更容易(请参阅下面的答案)
20赞 Tomek Szpakowicz 5/26/2010 #6

在 .NET 中使用 XPath(通过导航器或 SelectNodes/SelectSingleNode)在具有命名空间的 XML 上使用时,需要:

  • 提供您自己的 XmlNamespaceManager

  • 显式地为 XPath 表达式中的所有元素添加前缀,这些元素位于命名空间中。

后者是(从下面链接的 MS 源代码转述):因为 XPath 1.0 忽略了默认的命名空间规范 (xmlns=“some_namespace”)。因此,当您使用不带前缀的元素名称时,它假定为 null 命名空间。

这就是为什么 XPath 的 .NET 实现会忽略 XmlNamespaceManager 中前缀为 String.Empty 的命名空间,并且 allways 使用 null 命名空间。

有关详细信息,请参阅 XmlNamespaceManager 和 UndefinedXsltContext 不处理默认命名空间

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

评论

1赞 12/31/2010
您编写的 XPath 1.0 忽略了默认命名空间。这是不对的。如果您使用,则会忽略它,因为根据定义,无前缀的 QName 测试会选择空或 null 命名空间下的元素。/root/child
0赞 1/4/2011
正确地说,QName 是 (namespace URI, local name, prefix) 的元组。因此,这个元素有一个QName('URI','el',''),等效于另一个元素('URI','el','pre'),但与最后一个元素('','el','')不同<el xmlns="URI"/><pre:el xmlns:pre="URI"/><el xmlns:pre="URI"/>
0赞 Tomek Szpakowicz 1/5/2011
@Alejandro:经过考虑,我决定删除我的评论,因为我觉得这个讨论毫无意义。如果我的答案不够准确,请写一个更好的答案。如果我的答案不正确,请提供工作示例来证明这一点。
0赞 Gerard ONeill 9/1/2016
它不会忽略默认命名空间。只是无法指定默认命名空间。巨大的差异。这种差异是有道理的——任何给定标签的默认命名空间可能不同;xpath 应该转到显式标记。除非您使用标签名称,否则您可以这样做。但它会找到使用默认命名空间定义的所有标签;您只需在 XPath 表达式中使用标记指定该命名空间即可。
0赞 Tomek Szpakowicz 9/6/2016
@GerardONeill 我之前对 user357812(又名 Alejandro)的评论仍然适用。另外,我认为您混淆了 XML 文档中包含的命名空间规范和适用于 XPath 表达式本身的命名空间规范。我的答案是关于后者的。
1赞 Dan 10/21/2010 #7

我使用了上面 SpikeDog 描述的 hacky-but useful 方法。它运行良好,直到我向它抛出一个 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);
                });
}

评论

2赞 DaniCE 12/22/2011
当路径表达式具有属性时,此版本会出现问题。例如,“element/@id”被转换为“p:element/p:@id”,而它应该是“p:element/@id”。
6赞 Brandon 9/28/2011 #8

我在空白默认命名空间中遇到了类似的问题。在此示例 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” 返回了我的结果,就像我想要的那样。希望这有助于为其他人澄清这个问题。

8赞 Bartosz Węgielewski 3/14/2012 #9

您可以在不使用 XmlNamespaceManager 的情况下使用 XPath 语句,如下所示:

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

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

关键是要使用:

namespace-uri() = ''

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

评论

2赞 stefann 9/6/2013
namespace-uri='' 对我不起作用,但它给了我动态创建 XPath 表达式的想法,如下所示:doc。SelectNodes(String.Format(“//*[local-name()='innerelement' and namespace-uri()='{0}']”, doc.DocumentElement.NamespaceURI));这很有效
1赞 Zak 7/3/2012 #10

或者,如果有人应该像我一样使用 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);
32赞 Mitselplik 4/19/2014 #11

对于任何寻求快速黑客解决方案的人来说,尤其是在您了解 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");

当我处理单个文件时,我发现这比所有其他需要默认命名空间前缀的废话更容易。希望这会有所帮助。

评论

11赞 Scott Shaw-Smith 9/18/2015
这太棒了。所有其他关于处理 XmlNamespaceManager 的 BS 都是无用的。10,000 次中有 9999 次您知道 XML。
0赞 Timothy 6/29/2016
唯一的缺点是,正如预期的那样,选定的 XML 项位于 null 命名空间中。虽然我真的很喜欢这个技巧,但如果命名空间是你工作的要求,这将不符合要求。
2赞 Gerard ONeill 9/1/2016
“废话”与单个文件无关 - 它与命名空间标签有关。如果您控制 XML,则不必使用命名空间(标记将存在于 null 命名空间中)。如果你无法控制,那么你正在为一个需要 1/2 代码的解决方案创建一个黑客。Timothy 指出,现在您将有两种不同的解决方案,具体取决于您是否可以抓住标签不重复的机会。因为你想保存两行,用了4行来做。
4赞 Mitselplik 1/16/2017
@Gerard - 我不是想钻进任何人的皮肤下。我的帖子更多地与KISS有关,而不是嘲笑。无论如何:(1)我称我的解决方案为黑客,暗示它不是“正确”的方法;(2)无论我的听众是否控制XML,我都明确指出,只有当你了解XML并且不需要担心命名空间时,这才是一个很好的解决方案。(3) 虽然它只需要几行额外的行来包含管理器并指定命名空间,但 XPath 字符串本身最终看起来非常混乱,所有额外的命名空间噪音都使它们变得混乱。
3赞 rémy 4/11/2018
我在这里找到的这个不错的正则表达式 techoctave.com/c7/posts/113-c-reading-xml-with-namespacestring filter = @"xmlns(:\w+)?=""([^""]+)""|xsi(:\w+)?=""([^""]+)"""; fileData = Regex.Replace(fileData, filter, "");
7赞 Kent 5/4/2016 #12

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

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 一起使用。

评论

0赞 AnthonyVO 11/17/2021
我注意到,与@Brandon的解决方案相比,您将空白(“”)键替换为“默认”。Brandon 添加了 “” 键和第二个版本,键为 “Default”。
1赞 Corto 1/10/2019 #13

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);

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

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

1赞 ivebeenlinuxed 7/16/2021 #14

这个仍然一直困扰着我。我现在已经做了一些测试,所以希望我能帮到你。

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

重要的段落在这里:

XPath 将空前缀视为 null 命名空间。换句话说,只有映射到命名空间的前缀才能在 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

示例 B:

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

本文档具有命名的默认前缀。 因此,with 不返回任何结果。MS 认为 的 XML 命名空间 URI 应为 NULL,而 的命名空间 URI 实际上是“https://standardns/”。从本质上讲,XPath 正在寻找 - 尽管这行不通,因为您不能将 NULL URI 称为“NULL”作为前缀。NULL 前缀是所有 XPath 中的默认值 - 因此存在问题。https://standardns/XPathNavigator.Execute/data/nsa:adatadata/NULL:data/nsa:a

我们如何解决这个问题?

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>

在此示例中,位于 NULL 命名空间中。 位于默认命名空间“https://standardns/”中。 根据 Microsoft 的说法,应该不起作用,因为位于 NS 中并且位于命名空间 NULL 中。 因此是隐藏的(除非通过执行奇怪的“忽略命名空间”黑客攻击),并且不能按原样选择。这本质上是根本原因 - 您不应该选择没有前缀的“a”和“data”,因为这会假设它们在同一个命名空间中,而事实并非如此!dataa/data/aahttps://standardns/data<a>

我们如何解决这个问题?

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

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

希望这对一些人有所帮助!