深入XPath的详解以及Java示例代码分析
程序员文章站
2023-12-18 08:15:34
复制代码 代码如下:import java.io.ioexception;import javax.xml.parsers.*;import javax.xml.xpath...
复制代码 代码如下:
import java.io.ioexception;
import javax.xml.parsers.*;
import javax.xml.xpath.*;
import org.w3c.dom.*;
import org.xml.sax.saxexception;
public class xpathtest {
public static void main(string[] args) throws parserconfigurationexception,
saxexception, ioexception, xpathexpressionexception {
documentbuilderfactory factory = documentbuilderfactory.newinstance();
factory.setnamespaceaware(false);
documentbuilder builder = factory.newdocumentbuilder();
document doc = builder.parse("c:/users/administrator/desktop/test.xml");
system.out.println(doc.getchildnodes().getlength());
xpathfactory xfactory = xpathfactory.newinstance();
xpath xpath = xfactory.newxpath();
xpathexpression expr = xpath
.compile("//name/text()");
object result = expr.evaluate(doc, xpathconstants.nodeset);
nodelist nodes = (nodelist) result;
system.out.println(nodes.getlength());
for (int i = 0; i < nodes.getlength(); i++) {
system.out.println(nodes.item(i).getnodevalue());
}
}
}
一、结点类型
xpath中有七种结点类型：元素、属性、文本、命名空间、处理指令、注释以及文档节点（或成为根节点）。 文档的根节点即是文档结点；对应属性有属性结点，元素有元素结点。
二、常用路径表达式
表达式 描述
nodename 选取此节点的所有子节点
/ 从根节点选取
// 从匹配选择的当前节点选择文档中的节点，而不考虑它们的位置
. 选取当前节点
.. 选取当前节点的父节点
@ 选取属性
例如有文档：
复制代码 代码如下:
<?xml version="1.0" encoding="iso-8859-1"?>
<bookstore>
<book>
<title lang="eng">harry potter</title>
<price>29.99</price>
</book>
<book>
<title lang="eng">learning xml</title>
<price>39.95</price>
</book>
</bookstore>
则：
路径表达式 结果
bookstore 选取 bookstore 元素的所有子节点
/bookstore 选取根元素 bookstore 注释：假如路径起始于正斜杠( / )，则此路径始终代表到某元素的绝对路径！
bookstore/book 选取所有属于 bookstore 的子元素的 book 元素。
//book 选取所有 book 子元素，而不管它们在文档中的位置。
bookstore//book 选择所有属于 bookstore 元素的后代的 book 元素，而不管它们位于 bookstore 之下的什么位置。
//@lang 选取所有名为 lang 的属性。
三、限定语
用来查找某个特定的节点或者包含某个指定的值的节点。以方括号括起。
例如：
路径表达式 结果
/bookstore/book[1] 选取属于 bookstore 子元素的第一个 book 元素。
/bookstore/book[last()] 选取属于 bookstore 子元素的最后一个 book 元素。
/bookstore/book[last()-1] 选取属于 bookstore 子元素的倒数第二个 book 元素。
/bookstore/book[position()<3] 选取最前面的两个属于 bookstore 元素的子元素的 book 元素。
//title[@lang] 选取所有拥有名为 lang 的属性的 title 元素。
//title[@lang='eng'] 选取所有 title 元素，且这些元素拥有值为 eng 的 lang 属性。
/bookstore/book[price>35.00] 选取所有 bookstore 元素的 book 元素，且其中的 price 元素的值须大于 35.00。
/bookstore/book[price>35.00]/title 选取所有 bookstore 元素中的 book 元素的 title 元素，且其中的 price 元素的值须大于 35.00。
四、通配符
通配符 描述
* 匹配任何元素节点
@* 匹配任何属性节点
node() 匹配任何类型的节点
| 选取若干路径
例如：
路径表达式 结果
/bookstore/* 选取 bookstore 元素的所有子节点
//* 选取文档中的所有元素
//title[@*] 选取所有带有属性的 title 元素。
//book/title | //book/price 选取所有 book 元素的 tilte 和 price 元素。
//title | //price 选取所有文档中的 title 和 price 元素。
/bookstore/book/title | //price 选取所有属于 bookstore 元素的 book 元素的 title 元素，以及文档中所有的 price 元素。
五、函数
名称 结果
ancestor 选取当前节点的所有先辈（父、祖父等）
ancestor-or-self 选取当前节点的所有先辈（父、祖父等）以及当前节点本身
attribute 选取当前节点的所有属性
child 选取当前节点的所有子元素。
descendant 选取当前节点的所有后代元素（子、孙等）。
descendant-or-self 选取当前节点的所有后代元素（子、孙等）以及当前节点本身。
following 选取文档中当前节点的结束标签之后的所有节点。
namespace 选取当前节点的所有命名空间节点
parent 选取当前节点的父节点。
preceding 选取文档中当前节点的开始标签之前的所有节点。
preceding-sibling 选取当前节点之前的所有同级节点。
self 选取当前节点。
路径表达式可以是绝对路径，也可以是相对路径。例如：
绝对位置路径：
/step/step/...相对位置路径：
step/step/...其中的每一步又可以是一个表达式，包括：
轴（函数）（axis）
定义所选节点与当前节点之间的树关系
节点测试（node-test）
识别某个轴内部的节点
零个或者更多谓语（predicate）
更深入地提炼所选的节点集
例如： 例子 结果
child::book 选取所有属于当前节点的子元素的 book 节点
attribute::lang 选取当前节点的 lang 属性
child::* 选取当前节点的所有子元素
attribute::* 选取当前节点的所有属性
child::text() 选取当前节点的所有文本子节点
child::node() 选取当前节点的所有子节点
descendant::book 选取当前节点的所有 book 后代
ancestor::book 选择当前节点的所有 book 先辈
ancestor-or-self::book 选取当前节点的所有book先辈以及当前节点（假如此节点是book节点的话）
child::*/child::price 选取当前节点的所有 price 孙。
六、运算符
运算符 描述 实例 返回值
| 计算两个节点集 //book | //cd 返回所有带有 book 和 ck 元素的节点集
+ 加法 6 + 4 10
- 减法 6 - 4 2
* 乘法 6 * 4 24
div 除法 8 div 4 2
= 等于 price=9.80 如果 price 是9.80，则返回 true。 如果 price 是9.90，则返回 fasle。
!= 不等于 price!=9.80 如果 price 是 9.90，则返回 true。 如果 price 是 9.98，则返回 fasle。
< 小于 price<9.80 如果price是9.00，则返回true 如果price是9.98，则返回fasle
<= 小于或等于 price<=9.80 如果 price 是9.00，则返回 true。 如果 price 是9.90，则返回 fasle。
> 大于 price>9.80 如果 price 是 9.90，则返回 true。 如果 price 是 9.80，则返回 fasle。
>= 大于或等于 price>=9.80 如果 price 是 9.90，则返回 true。 如果 price 是 9.70，则返回 fasle。
or 或 price=9.80 or price=9.70 如果 price 是 9.80，则返回 true。 如果 price 是 9.50，则返回 fasle。
and 与 price>9.00 and price<9.90 如果 price 是 9.80，则返回 true。 如果 price 是 8.50，则返回 fasle。
mod 计算除法的余数 5 mod 2 1
七、在java中使用xpath
在java1.5中推出了一个javax.xml.xpath包专门用来在java中使用xpath表达式来读取xml。1. 数据类型
在学习之前首先需要注意的是：xpath的数据并不与java有一一对应关系，xpath1.0只声明了四种数据类型：
•node-set
•number
•boolean
•string
对应到java就是：
•number 映射为 java.lang.double
•string 映射为 java.lang.string
•boolean 映射为 java.lang.boolean
•node-set 映射为 org.w3c.dom.nodelist
因此，在使用java的xpathapi时，需要注意返回类型：
java代码
复制代码 代码如下:
public object evaluate(object item, qname returntype)throws xpathexpressionexception;
public string evaluate(object item)throws xpathexpressionexception;
public object evaluate(inputsource source, qname returntype)throws xpathexpressionexception;
public string evaluate(inputsource source)throws xpathexpressionexception;
复制代码 代码如下:
public object evaluate(object item, qname returntype)throws xpathexpressionexception;
public string evaluate(object item)throws xpathexpressionexception;
public object evaluate(inputsource source, qname returntype)throws xpathexpressionexception;
public string evaluate(inputsource source)throws xpathexpressionexception;
不指定返回类型时，缺省返回类型为string。指定返回类型时，需要把返回值由object类型强制转换成对应的返回类型。
api的使用
类似于dom，要得到一个xpath对象，可以如下使用： java代码
复制代码 代码如下:
xpathfactory factory = xpathfactory.newinstance();
xpath xpath = factory.newxpath();
xpathexpression expression = xpath.compile("/bookstore//book/title/text()");
复制代码 代码如下:
<strong><strong> xpathfactory factory = xpathfactory.newinstance();
xpath xpath = factory.newxpath();
xpathexpression expression = xpath.compile("/bookstore//book/title/text()");</strong></strong>
还是以之前的xml文档为例。要得到这个表达式的结果，我们先要得到一个输入对象，例如一个document:
复制代码 代码如下:
documentbuilderfactory builderfactory = documentbuilderfactory.newinstance();
documentbuilder documentbuilder = builderfactory.newdocumentbuilder();
document document = documentbuilder.parse(new file("books.xml"));
nodelist list = (nodelist) expression.evaluate(document,xpathconstants.nodeset);
复制代码 代码如下:
<strong><strong> documentbuilderfactory builderfactory = documentbuilderfactory.newinstance();
documentbuilder documentbuilder = builderfactory.newdocumentbuilder();
document document = documentbuilder.parse(new file("books.xml"));
nodelist list = (nodelist) expression.evaluate(document,xpathconstants.nodeset);</strong></strong>
这里可以看出，在使用xpath的时候，我们好像需要很清楚的知道返回结果是什么。否则就不能得到意想的结果。
最后，我们得到一个title的list值：
复制代码 代码如下:
for(int i = 0;i<list.getlength();i++){ system.out.println(list.item(i).getnodevalue());
}
复制代码 代码如下:
<strong><strong> for(int i = 0;i</strong></strong>
复制代码 代码如下:
everyday italian
harry potter
xquery kick start
learning xml
复制代码 代码如下:
<strong><strong>everyday italian
harry potter
xquery kick start
learning xml</strong></strong>
八、处理命令空间一般一个规范xml都会有命名空间的定义，例如：
复制代码 代码如下:
<strong><strong>
hello
</strong></strong>
复制代码 代码如下:
<?xml version="1.0" encoding="utf-8"?>
<tg:bookstore xmlns:tg="http://www.tibco.com/cdc/liugang"
xmlns:ns="http://www.tibco.com/cdc/liugang/ns">
<ns:book>
<tg:title>hello</tg:title>
</ns:book>
</tg:bookstore>
xpath中定义了与节点名和命名空间有关的三个函数：
•local-name()
•namespace-uri()
•name()
例如要查找所有在当前文档中定义的，元素的local名为book的结点，则如下：
复制代码 代码如下:
xpathfactory xpathfactory = xpathfactory.newinstance();
xpath xpath = xpathfactory.newxpath();
xpathexpression compile = xpath.compile("//*[local-name()='book']");
nodelist list = (nodelist) compile.evaluate(document,xpathconstants.nodeset);
复制代码 代码如下:
<strong><strong> xpathfactory xpathfactory = xpathfactory.newinstance();
xpath xpath = xpathfactory.newxpath();
xpathexpression compile = xpath.compile("//*[local-name()='book']");
nodelist list = (nodelist) compile.evaluate(document,xpathconstants.nodeset);</strong></strong>
如果元素定义了命名空间，则使用xpath查找时也必须指定在同一个命名空间中，即便元素使用的是缺省的命名空间，刚查找也需要定义缺省的命名空间。 例如文档：
复制代码 代码如下:
<?xml version="1.0" encoding="utf-8"?>
<bookstore xmlns="http://www.tibco.com/cdc/liugang" xmlns:tg="http://www.tibco.com/cdc/liugang/tg"
xmlns:ns="http://www.tibco.com/cdc/liugang/ns">
<ns:book>
<tg:title>hello</tg:title>
</ns:book>
<computer>
<id>elsioieldslke-1233</id>
</computer>
</bookstore>
复制代码 代码如下:
<strong><strong>
hello
elsioieldslke-1233
</strong></strong>
定义了三个命名空间：缺省的；xmlns:tg；xmlns:ns。 要使用命名空间，我们需要设置xpath的命名空间上下文：namespacecontext。这是一个接口类型，我们需要自定义去实现它。例如对应于上文档的三个命名空间，可以如下实现：
复制代码 代码如下:
class customnamespacecontext implements namespacecontext{
public string getnamespaceuri(string prefix) {
if(prefix.equals("ns")){
return "http://www.tibco.com/cdc/liugang/ns";
}else if(prefix.equals("tg")){
return "http://www.tibco.com/cdc/liugang/tg";
}else if(prefix.equals("df")){
return "http://www.tibco.com/cdc/liugang";
}
return xmlconstants.null_ns_uri;
}
public string getprefix(string namespaceuri) {
return null;
}
public iterator getprefixes(string namespaceuri) {
return null;
}
}
复制代码 代码如下:
<strong><strong>class customnamespacecontext implements namespacecontext{
public string getnamespaceuri(string prefix) {
if(prefix.equals("ns")){
return "http://www.tibco.com/cdc/liugang/ns";
}else if(prefix.equals("tg")){
return "http://www.tibco.com/cdc/liugang/tg";
}else if(prefix.equals("df")){
return "http://www.tibco.com/cdc/liugang";
}
return xmlconstants.null_ns_uri;
}
public string getprefix(string namespaceuri) {
return null;
}
public iterator getprefixes(string namespaceuri) {
return null;
}
}</strong></strong>
方法名都非常直观。这里只实现第一个方法。 这样，如果要查找命名空间是缺省，元素名为computer的所有元素，可以如下实现：
复制代码 代码如下:
xpathfactory xpathfactory = xpathfactory.newinstance();
xpath xpath = xpathfactory.newxpath();
xpath.setnamespacecontext(new customnamespacecontext());
xpathexpression compile = xpath.compile("//df:computer");
nodelist list = (nodelist) compile.evaluate(document,xpathconstants.nodeset);
for(int i = 0;i
node item = list.item(i);
system.out.println(item.getnodename()+" "+item.getnodevalue());
}
复制代码 代码如下:
<strong><strong> xpathfactory xpathfactory = xpathfactory.newinstance();
xpath xpath = xpathfactory.newxpath();
xpath.setnamespacecontext(new customnamespacecontext());
xpathexpression compile = xpath.compile("//df:computer");
nodelist list = (nodelist) compile.evaluate(document,xpathconstants.nodeset);
for(int i = 0;i</strong></strong>
九、其他
除此之外，在java中，还可以定义扩展的函数解释器和变量解释器，看xpath的方法：
复制代码 代码如下:
/**
*
establish a variable resolver.
*
*
a nullpointerexception is thrown if resolver is null.
*
* @param resolver variable resolver.
*
* @throws nullpointerexception if resolver is null.
*/
public void setxpathvariableresolver(xpathvariableresolver resolver);
/**
*
establish a function resolver.
*
*
a nullpointerexception is thrown if resolver is null.
*
* @param resolver xpath function resolver.
*
* @throws nullpointerexception if resolver is null.
*/
public void setxpathfunctionresolver(xpathfunctionresolver resolver);
复制代码 代码如下:
<strong><strong> /**
* establish a variable resolver.
*
* a <code>nullpointerexception</code> is thrown if <code>resolver</code> is <code>null</code>.
*
* @param resolver variable resolver.
*
* @throws nullpointerexception if <code>resolver</code> is <code>null</code>.
*/
public void setxpathvariableresolver(xpathvariableresolver resolver);
/**
* establish a function resolver.
*
* a <code>nullpointerexception</code> is thrown if <code>resolver</code> is <code>null</code>.
*
* @param resolver xpath function resolver.
*
* @throws nullpointerexception if <code>resolver</code> is <code>null</code>.
*/
public void setxpathfunctionresolver(xpathfunctionresolver resolver);</strong></strong>