如果想要在 xpath 表达式中使用名称空间，必须提供对此名称空间 uri 所用前缀的链接。本文介绍了向名称空间映射提供前缀的三种不同方式。本文亦包含了示例代码以方便您编写自己的 namespacecontext。
前提条件和示例
本文所有的示例均使用如下这个xml文件：
清单1. 示例xml
<?xml version="1.0" encoding="utf-8"?><books:booklist xmlns:books="http://univnaspresolver/booklist" xmlns="http://univnaspresolver/book" xmlns:fiction="http://univnaspresolver/fictionbook"> <science:book xmlns:science="http://univnaspresolver/sciencebook"> <title>learning xpath</title> <author>michael schmidt</author> </science:book> <fiction:book> <title>faust i</title> <author>johann wolfgang von goethe</author> </fiction:book> <fiction:book> <title>faust ii</title> <author>johann wolfgang von goethe</author> </fiction:book></books:booklist> |
这个 xml 示例包含三个在根元素内声明的名称空间，一个在此结构的更深层元素上声明的名称空间。您将可以看到这种设置所带来的差异。
这个 xml 示例的第二个有趣之处在于元素 booklist 具有三个子元素，均名为 book。但是第一个子元素具有名称空间 science，而其他子元素则具有名称空间 fiction。这意味着这些元素完全有别于 xpath。在接下来的这些例子中，您将可以看到这种特性产生的结果。
示例源代码中有一个需要注意之处：此代码没有针对维护进行优化，只针对可读性进行了优化。这意味着它将具有某些冗余。输出通过 system.out.println() 以最为简单的方式生成。在本文中有关输出的代码行均缩写为 “...”。
理论背景
名称空间究竟有何意义？为何要如此关注它呢？名称空间是元素或属性的标识符的一部分。元素或属性可以具有相同的本地名称，但是必须使用不同的名称空间。它们完全不同。请参考上述示例（science:book 和 fiction:book）。若要综合来自不同资源的 xml 文件，就需要使用名称空间来解决命名冲突。以一个 xslt 文件为例。它包含 xslt 名称空间的元素、来自您自己名称空间的元素以及（通常）xhtml 名称空间的元素。使用名称空间，就可以避免具有相同本地名称的元素所带来的不确定性。
名称空间由 uri（在本例中为 http://univnaspresolver/booklist）定义。为了避免使用这个长字符串，可以定义一个与此 uri 相关联的前缀（在本例中为 books）。请记住此前缀类似于一个变量：其名称并不重要。如果两个前缀引用相同的 uri，那么被加上前缀的元素的名称空间将是相同的（请参见 清单 5 中的示例 1）。
xpath 表达式使用前缀（比如 books:booklist/science:book）并且您必须提供与每个前缀相关联的 uri。这时，就需要使用 namespacecontext。它恰好能够实现此目的。
本文给出了提供前缀和 uri 之间的映射的不同方式。
在此 xml 文件中，映射由类似 xmlns:books="http://univnaspresolver/booklist" 这样的 xmlns 属性或 xmlns="http://univnaspresolver/book"（默认名称空间）提供。
|||
|||
|||
从文档读取名称空间并缓存它们
namespacecontext 的下一个版本要稍好一些。它只在构造函数内提前读取一次名称空间。对一个名称空间的每次调用均回应自缓存。这样一来，文档内的更改就变得无关紧要，因为名称空间列表在 java 对象创建之时就已被缓存。
清单 10. 从文档缓存名称空间解析
public class universalnamespacecache implements namespacecontext { private static final string default_ns = "default"; private map<string, string> prefix2uri = new hashmap<string, string>(); private map<string, string> uri2prefix = new hashmap<string, string>(); /** * this constructor parses the document and stores all namespaces it can * find. if toplevelonly is true, only namespaces in the root are used. * * @param document * source document * @param toplevelonly * restriction of the search to enhance performance */ public universalnamespacecache(document document, boolean toplevelonly) { examinenode(document.getfirstchild(), toplevelonly); system.out.println("the list of the cached namespaces:"); for (string key : prefix2uri.keyset()) { system.out .println("prefix " + key + ": uri " + prefix2uri.get(key)); } } /** * a single node is read, the namespace attributes are extracted and stored. * * @param node * to examine * @param attributesonly, * if true no recursion happens */ private void examinenode(node node, boolean attributesonly) { namednodemap attributes = node.getattributes(); for (int i = 0; i < attributes.getlength(); i++) { node attribute = attributes.item(i); storeattribute((attr) attribute); } if (!attributesonly) { nodelist chields = node.getchildnodes(); for (int i = 0; i < chields.getlength(); i++) { node chield = chields.item(i); if (chield.getnodetype() == node.element_node) examinenode(chield, false); } } } /** * this method looks at an attribute and stores it, if it is a namespace * attribute. * * @param attribute * to examine */ private void storeattribute(attr attribute) { // examine the attributes in namespace xmlns if (attribute.getnamespaceuri() != null && attribute.getnamespaceuri().equals( xmlconstants.xmlns_attribute_ns_uri)) { // default namespace xmlns="uri goes here" if (attribute.getnodename().equals(xmlconstants.xmlns_attribute)) { putincache(default_ns, attribute.getnodevalue()); } else { // the defined prefixes are stored here putincache(attribute.getlocalname(), attribute.getnodevalue()); } } } private void putincache(string prefix, string uri) { prefix2uri.put(prefix, uri); uri2prefix.put(uri, prefix); } /** * this method is called by xpath. it returns the default namespace, if the * prefix is null or "". * * @param prefix * to search for * @return uri */ public string getnamespaceuri(string prefix) { if (prefix == null || prefix.equals(xmlconstants.default_ns_prefix)) { return prefix2uri.get(default_ns); } else { return prefix2uri.get(prefix); } } /** * this method is not needed in this context, but can be implemented in a * similar way. */ public string getprefix(string namespaceuri) { return uri2prefix.get(namespaceuri); } public iterator getprefixes(string namespaceuri) { // not implemented return null; }} |
请注意在代码中有一个调试输出。每个节点的属性均被检查和存储。但子节点不被检查，因为构造函数内的布尔值 toplevelonly 被设置为 true。如果此布尔值被设为 false，那么子节点的检查将会在属性存储完毕后开始。有关此代码，有一点需要注意：在 dom 中，第一个节点代表整个文档，所以，要让元素 book 读取这些名称空间，必须访问子节点刚好一次。
在这种情况下，使用 namespacecontext 非常简单：
清单 11. 具有缓存了的名称空间解析的示例 3（只面向顶级）
private static void example3(document example) throws xpathexpressionexception, transformerexception { sysout("/n*** third example - namespaces of toplevel node cached ***"); xpath xpath = xpathfactory.newinstance().newxpath(); xpath.setnamespacecontext(new universalnamespacecache(example, true)); try {... nodelist result1 = (nodelist) xpath.evaluate( "books:booklist/science:book", example, xpathconstants.nodeset);... } catch (xpathexpressionexception e) {... }... nodelist result2 = (nodelist) xpath.evaluate( "books:booklist/fiction:book", example, xpathconstants.nodeset);... string result = xpath.evaluate( "books:booklist/fiction:book[1]/:author", example);... } |
这会导致如下输出：
清单 12. 示例 3 的输出
*** third example - namespaces of toplevel node cached ***the list of the cached namespaces:prefix default: uri http://univnaspresolver/bookprefix fiction: uri http://univnaspresolver/fictionbookprefix books: uri http://univnaspresolver/booklisttry to use the science prefix:--> books:booklist/science:bookthe cache only knows namespaces of the first level!the fiction namespace is such a namespace:--> books:booklist/fiction:booknumber of nodes: 2<?xml version="1.0" encoding="utf-8"?> <fiction:book xmlns:fiction="http://univnaspresolver/fictionbook"> <title xmlns="http://univnaspresolver/book">faust i</title> <author xmlns="http://univnaspresolver/book">johann wolfgang von goethe</author> </fiction:book><?xml version="1.0" encoding="utf-8"?> <fiction:book xmlns:fiction="http://univnaspresolver/fictionbook"> <title xmlns="http://univnaspresolver/book">faust ii</title> <author xmlns="http://univnaspresolver/book">johann wolfgang von goethe</author> </fiction:book>the default namespace works also:--> books:booklist/fiction:book[1]/:authorjohann wolfgang von goethe |
上述代码只找到了根元素的名称空间。更准确的说法是：此节点的名称空间被构造函数传递给了方法 examinenode。这会加速构造函数的运行，因它无需迭代整个文档。不过，正如您从输出看到的，science 前缀不能被解析。xpath 表达式导致了一个异常（xpathexpressionexception）。
|||
从文档及其所有元素读取名称空间并对之进行缓存
此版本将从这个 xml 文件读取所有名称空间声明。现在，即便是前缀 science 上的 xpath 也是有效的。但是有一种情况让此版本有些复杂：如果一个前缀重载（在不同 uri 上的嵌套元素内声明），所找到的最后一个将会 “胜出”。在实际中，这通常不成问题。
在本例中，namespacecontext 的使用与前一个示例相同。构造函数内的布尔值 toplevelonly 必须被设置为 false。
清单 13. 具有缓存了的名称空间解析的示例 4（面向所有级别）
private static void example4(document example) throws xpathexpressionexception, transformerexception { sysout("/n*** fourth example - namespaces all levels cached ***"); xpath xpath = xpathfactory.newinstance().newxpath(); xpath.setnamespacecontext(new universalnamespacecache(example, false));... nodelist result1 = (nodelist) xpath.evaluate( "books:booklist/science:book", example, xpathconstants.nodeset);... nodelist result2 = (nodelist) xpath.evaluate( "books:booklist/fiction:book", example, xpathconstants.nodeset);... string result = xpath.evaluate( "books:booklist/fiction:book[1]/:author", example);... } |
其输出结果如下：
清单 14. 示例 4 的输出
*** fourth example - namespaces all levels cached ***the list of the cached namespaces:prefix science: uri http://univnaspresolver/sciencebookprefix default: uri http://univnaspresolver/bookprefix fiction: uri http://univnaspresolver/fictionbookprefix books: uri http://univnaspresolver/booklistnow the use of the science prefix works as well:--> books:booklist/science:booknumber of nodes: 1<?xml version="1.0" encoding="utf-8"?> <science:book xmlns:science="http://univnaspresolver/sciencebook"> <title xmlns="http://univnaspresolver/book">learning xpath</title> <author xmlns="http://univnaspresolver/book">michael schmidt</author> </science:book>the fiction namespace is resolved:--> books:booklist/fiction:booknumber of nodes: 2<?xml version="1.0" encoding="utf-8"?> <fiction:book xmlns:fiction="http://univnaspresolver/fictionbook"> <title xmlns="http://univnaspresolver/book">faust i</title> <author xmlns="http://univnaspresolver/book">johann wolfgang von goethe</author> </fiction:book><?xml version="1.0" encoding="utf-8"?> <fiction:book xmlns:fiction="http://univnaspresolver/fictionbook"> <title xmlns="http://univnaspresolver/book">faust ii</title> <author xmlns="http://univnaspresolver/book">johann wolfgang von goethe</author> </fiction:book>the default namespace works also:--> books:booklist/fiction:book[1]/:authorjohann wolfgang von goethe |
结束语
实现名称空间解析，有几种方式可供选择，这些方式大都好于硬编码的实现方式：
•如果示例很小并且所有名称空间均位于顶部元素内，指派到此文档的方式将会十分有效。
•如果 xml 文件较大且具有深层嵌套和多个 xpath 求值，最好是缓存名称空间的列表。
•但是如果您无法控制 xml 文件，并且别人可以发送给您任何前缀，最好是独立于他人的选择。您可以编码实现您自己的名称空间解析，如示例 1 （hardcodednamespaceresolver）所示，并将它们用于您的 xpath 表达式。
在上述这些情况下，解析自此 xml 文件的 namespacecontext 能够让您的代码更少、并且更为通用。
从文档读取名称空间
名称空间及其前缀均存档在此 xml 文件内，因此可以从那里使用它们。实现此目的的最为简单的方式是将这个查找指派给该文档。
清单 7. 从文档直接进行名称空间解析
public class universalnamespaceresolver implements namespacecontext { // the delegate private document sourcedocument; /** * this constructor stores the source document to search the namespaces in * it. * * @param document * source document */ public universalnamespaceresolver(document document) { sourcedocument = document; } /** * the lookup for the namespace uris is delegated to the stored document. * * @param prefix * to search for * @return uri */ public string getnamespaceuri(string prefix) { if (prefix.equals(xmlconstants.default_ns_prefix)) { return sourcedocument.lookupnamespaceuri(null); } else { return sourcedocument.lookupnamespaceuri(prefix); } } /** * this method is not needed in this context, but can be implemented in a * similar way. */ public string getprefix(string namespaceuri) { return sourcedocument.lookupprefix(namespaceuri); } public iterator getprefixes(string namespaceuri) { // not implemented yet return null; }} |
请注意如下这些事项：
•如果文档在使用 xpath 前已更改，那么此更改还将反应在名称空间的这个查找上，因为指派是在需要的时候通过使用文档的当前版本完成的。
•对名称空间或前缀的查找在所用节点的祖先节点完成，在我们的例子中，即节点 sourcedocument。这意味着，借助所提供的代码，您只需在根节点上声明此名称空间。在我们的示例中，名称空间 science 没有被找到。
•此查找在 xpath 求值时被调用，因此它会消耗一些额外的时间。
如下是示例代码：
清单 8. 从文档直接进行名称空间解析的示例 2
private static void example2(document example) throws xpathexpressionexception, transformerexception { sysout("/n*** second example - namespacelookup delegated to document ***"); xpath xpath = xpathfactory.newinstance().newxpath(); xpath.setnamespacecontext(new universalnamespaceresolver(example)); try {... nodelist result1 = (nodelist) xpath.evaluate( "books:booklist/science:book", example, xpathconstants.nodeset);... } catch (xpathexpressionexception e) {... }... nodelist result2 = (nodelist) xpath.evaluate( "books:booklist/fiction:book", example, xpathconstants.nodeset);... string result = xpath.evaluate( "books:booklist/fiction:book[1]/:author", example);... } |
此示例的输出为：
清单 9. 示例 2 的输出
*** second example - namespacelookup delegated to document ***try to use the science prefix: no result--> books:booklist/science:bookthe resolver only knows namespaces of the first level!to be precise: only namespaces above the node, passed in the constructor.the fiction namespace is such a namespace:--> books:booklist/fiction:booknumber of nodes: 2<?xml version="1.0" encoding="utf-8"?> <fiction:book xmlns:fiction="http://univnaspresolver/fictionbook"> <title xmlns="http://univnaspresolver/book">faust i</title> <author xmlns="http://univnaspresolver/book">johann wolfgang von goethe</author> </fiction:book><?xml version="1.0" encoding="utf-8"?> <fiction:book xmlns:fiction="http://univnaspresolver/fictionbook"> <title xmlns="http://univnaspresolver/book">faust ii</title> <author xmlns="http://univnaspresolver/book">johann wolfgang von goethe</author> </fiction:book>the default namespace works also:--> books:booklist/fiction:book[1]/:authorjohann wolfgang von goethe |
正如输出所示，在 book 元素上声明的、具有前缀 science 的名称空间并未被解析。求值方法抛出了一个 xpathexpressionexception。要解决这个问题，需要从文档提取节点 science:book 并将此节点用作代表（delegate）。但是这将意味着对此文档要进行额外的解析，而且也不优雅。
提供名称空间解析的必要性
如果 xml 使用了名称空间，若不提供 namespacecontext，那么 xpath 表达式将会失效。清单 2 中的示例 0 充分展示了这一点。其中的 xpath 对象在所加载的 xml 文档之上构建和求值。首先，尝试不用任何名称空间前缀（result1）编写此表达式。之后，再用名称空间前缀（result2）编写此表达式。
清单 2. 无名称空间解析的示例 0
private static void example0(document example) throws xpathexpressionexception, transformerexception { sysout("/n*** zero example - no namespaces provided ***"); xpath xpath = xpathfactory.newinstance().newxpath();... nodelist result1 = (nodelist) xpath.evaluate("booklist/book", example, xpathconstants.nodeset);... nodelist result2 = (nodelist) xpath.evaluate( "books:booklist/science:book", example, xpathconstants.nodeset);... } |
输出如下所示。
清单 3. 示例 0 的输出
*** zero example - no namespaces provided ***first try asking without namespace prefix:--> booklist/bookresult is of length 0then try asking with namespace prefix:--> books:booklist/science:bookresult is of length 0the expression does not work in both cases. |
在两种情况下，xpath 求值并不返回任何节点，而且也没有任何异常。xpath 找不到节点，因为缺少前缀到 uri 的映射。
硬编码的名称空间解析
也可以以硬编码的值来提供名称空间，类似于 清单 4 中的类：
清单 4. 硬编码的名称空间解析
public class hardcodednamespaceresolver implements namespacecontext { /** * this method returns the uri for all prefixes needed. wherever possible * it uses xmlconstants. * * @param prefix * @return uri */ public string getnamespaceuri(string prefix) { if (prefix == null) { throw new illegalargumentexception("no prefix provided!"); } else if (prefix.equals(xmlconstants.default_ns_prefix)) { return "http://univnaspresolver/book"; } else if (prefix.equals("books")) { return "http://univnaspresolver/booklist"; } else if (prefix.equals("fiction")) { return "http://univnaspresolver/fictionbook"; } else if (prefix.equals("technical")) { return "http://univnaspresolver/sciencebook"; } else { return xmlconstants.null_ns_uri; } } public string getprefix(string namespaceuri) { // not needed in this context. return null; } public iterator getprefixes(string namespaceuri) { // not needed in this context. return null; }} |
请注意名称空间 http://univnaspresolver/sciencebook 被绑定到了前缀 technical（不是之前的 science）。结果将可以在随后的 示例（清单 6）中看到。在 清单 5 中，使用此解析器的代码还使用了新的前缀。
清单 5. 具有硬编码名称空间解析的示例 1
private static void example1(document example) throws xpathexpressionexception, transformerexception { sysout("/n*** first example - namespacelookup hardcoded ***"); xpath xpath = xpathfactory.newinstance().newxpath(); xpath.setnamespacecontext(new hardcodednamespaceresolver());... nodelist result1 = (nodelist) xpath.evaluate( "books:booklist/technical:book", example, xpathconstants.nodeset);... nodelist result2 = (nodelist) xpath.evaluate( "books:booklist/fiction:book", example, xpathconstants.nodeset);... string result = xpath.evaluate("books:booklist/technical:book/:author", example);... } |
如下是此示例的输出。
清单 6. 示例 1 的输出
*** first example - namespacelookup hardcoded ***using any namespaces results in a nodelist:--> books:booklist/technical:booknumber of nodes: 1<?xml version="1.0" encoding="utf-8"?> <science:book xmlns:science="http://univnaspresolver/sciencebook"> <title xmlns="http://univnaspresolver/book">learning xpath</title> <author xmlns="http://univnaspresolver/book">michael schmidt</author> </science:book>--> books:booklist/fiction:booknumber of nodes: 2<?xml version="1.0" encoding="utf-8"?> <fiction:book xmlns:fiction="http://univnaspresolver/fictionbook"> <title xmlns="http://univnaspresolver/book">faust i</title> <author xmlns="http://univnaspresolver/book">johann wolfgang von goethe</author> </fiction:book><?xml version="1.0" encoding="utf-8"?> <fiction:book xmlns:fiction="http://univnaspresolver/fictionbook"> <title xmlns="http://univnaspresolver/book">faust ii</title> <author xmlns="http://univnaspresolver/book">johann wolfgang von goethe</author> </fiction:book>the default namespace works also:--> books:booklist/technical:book/:authormichael schmidt |
如您所见，xpath 现在找到了节点。好处是您可以如您所希望的那样重命名前缀，我对前缀 science 就是这么做的。xml 文件包含前缀 science，而 xpath 则使用了另一个前缀 technical。由于这些 uri 都是相同的，所以节点均可被 xpath 找到。不利之处是您必须要在多个地方（xml、xsd、 xpath 表达式和此名称空间的上下文）维护名称空间。
