JAXP和Dom4j通过XPath获取带命名空间的节点

最新推荐文章于 2019-07-09 10:59:42 发布

心如止水dy

最新推荐文章于 2019-07-09 10:59:42 发布

阅读量587

点赞数

分类专栏：技术原创文章标签： JAXP Dom4j XPath

本文链接：https://blog.csdn.net/code727/article/details/84457700

版权

技术原创专栏收录该内容

9 篇文章 0 订阅

订阅专栏

一、JAXP对XPath的支持

XPath是从JAXP1.3开始被支持的，在这些API中，其核心接口有XPath和XPathExpression，它们都在javax.xml.xpath包中，分别表示XPath对象以及被预编译后的表达式对象。

例如，对于如下的示例文件(schema_test_copy.xml)

<?xml version="1.0" encoding="UTF-8"?>
<templet>	
	<bean name="user" class="com.daniele.appdemo.test.domain.User"></bean>
	<bean name="company" class="com.daniele.appdemo.test.domain.Company"></bean>
	<description date="2013-06-07">This is a XML Schema example.</description>
</templet>

我们可以利用上述两个和XPath相关的接口进行一系列的节点访问操作。

public static void main(String[] args) throws XPathExpressionException, IOException {
	// 返回默认的DOM对象模型的XPath工厂
	XPathFactory factory = XPathFactory.newInstance();
	XPath xPath = factory.newXPath();
		
        // 获取templet下name属性值为user的bean元素的class属性
	String expression = "/templet/bean[@name='user']/@class";
	InputSource source = new InputSource();
	source.setByteStream(new FileInputStream(new File("resource/xml/schema/schema_test_copy.xml")));
		
	// 预编译表达式，这种方式对于对同一个表达式多次求值来说，可提高运行效率，并且是线程安全的
	XPathExpression compiledExpression = xPath.compile(expression);
	System.out.println(compiledExpression.evaluate(source));
		
}

上述代码执行后将会正确的得到schema_test_copy.xml文件中第一个bean元素的class的属性值。

现在，把xml文档的内容做如下修改(schema_test.xml)：

<templet xmlns="http://www.appdemo.daniele.com/schema/templet"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://www.appdemo.daniele.com/schema/templet ../../../schema/schame_test.xsd">
	
	<bean name="user" class="com.daniele.appdemo.test.domain.User"></bean>		
	<bean name="company" class="com.daniele.appdemo.test.domain.Company"></bean>
	<description date="2013-06-07">This is a XML Schema example.</description>
</templet>

注意对比文件中根节点的变化，它在schema_test_copy.xml的基础上增加了两个与命名空间相关的属性xmlns和xmlns:xsi，其中xmlns是我们自定义文档结构规范的命名空间，是使用XPath时需要考虑的重点。

此时我们再次运行上面的main()方法后会发现将得不到任何输出结果。这主要是由于XPath不支持默认命名空间造成的，因此我们需要将前缀和相关的URI关联起来。

为达到这个目的，JAVA为我们提供了一个javax.xml.namespace.NamespaceContext接口，它的目的在于让我们可以在XPath接口对象中设置这个context，当XPath进行编译时，会根据前缀和URI的映射关系来匹配实际的节点。

NamespaceContext接口定义有如下三个方法：

1）public String getNamespaceURI(String prefix)：获取绑定到当前范围中前缀的命名空间 URI；

2）public String getPrefix(String namespaceURI)：获取绑定到当前范围命名空间 URI的前缀；

3）public Iterato getPrefixes(String namespaceURI)：获取绑定到当前范围命名空间 URI的所有前缀。

下面来自定义实现一个NamespaceContext：

package com.daniele.appdemo.xml.jaxp.xpath;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;

import javax.xml.XMLConstants;
import javax.xml.namespace.NamespaceContext;

/**
 * <p>默认的命名空间处理器</p> 
 * @author  <a href="mailto:code727@gmail.com">Daniele</a>
 * @version 1.0.0, 2013-7-11
 * @see     
 * @since   AppDemo1.0.0
 */
public class DefaultNamespaceContext implements NamespaceContext {
	
	/** 维持前缀与命名空间URI的映射关系(K:前缀,V:命名空间URI) */
	private Map<String,String> namespaceMap = new HashMap<String,String>();
	
	public DefaultNamespaceContext() {
		addNamespace("xsi", XMLConstants.W3C_XML_SCHEMA_INSTANCE_NS_URI);
	}
	
	public void addNamespace(String prefix, String namespaceURI) {
		namespaceMap.put(prefix, namespaceURI);
	}
	
	/**
	 * <p>获取绑定到当前范围中前缀的命名空间 URI。</p> 
	 * @author <a href="mailto:code727@gmail.com">Daniele</a> 
	 * @param prefix
	 * @return 
	 * @since AppDemo1.0.0 
	 */
	public String getNamespaceURI(String prefix) {
		String namespaceURI = namespaceMap.get(prefix);
		return namespaceURI != null ? namespaceURI : XMLConstants.NULL_NS_URI;
	}

	/**
	 * <p>获取绑定到当前范围命名空间 URI的前缀。</p> 
	 * @author <a href="mailto:code727@gmail.com">Daniele</a> 
	 * @param namespaceURI
	 * @return 
	 * @since AppDemo1.0.0 
	 */
	public String getPrefix(String namespaceURI) {
		Set<String> keySet = namespaceMap.keySet();
		for (String key : keySet) {
			if (namespaceMap.get(key).equals(namespaceURI))
				return key;
		}
		return XMLConstants.DEFAULT_NS_PREFIX;
	}

	/**
	 * <p>获取绑定到当前范围命名空间 URI的所有前缀。</p> 
	 * @author <a href="mailto:code727@gmail.com">Daniele</a> 
	 * @param namespaceURI
	 * @return 
	 * @since AppDemo1.0.0 
	 */
	public Iterator<?> getPrefixes(String namespaceURI) {
		List<String> prefixes = new ArrayList<String>();
		Set<String> keySet = namespaceMap.keySet();
		for (String key : keySet) {
			if (namespaceMap.get(key).equals(namespaceURI))
				prefixes.add(key);
		}
		return prefixes.iterator();
	}

}

完成后利用这个实现类，将前面的main()方法做如下修改(注意第5,11,12,15行的代码)：

public static void main(String[] args) throws IOException, XPathExpressionException {
	XPathFactory factory = XPathFactory.newInstance();
	XPath xPath = factory.newXPath();
		
	DefaultNamespaceContext defaultNamespaceContext = new DefaultNamespaceContext();
	/*
	 *  设置前缀与命名空间URI的映射关系
	 *  XPath表达式中使用的前缀与文档中实际的前缀并没有关联，这里只是为了在XPath中增加一个前缀标识所有。
	 *  但前缀对应的命名空间URI必须与文档中实际的命名空间URI保持一致
	 */
	defaultNamespaceContext.addNamespace("t", "http://www.appdemo.daniele.com/schema/templet");
	xPath.setNamespaceContext(defaultNamespaceContext); 
		
	InputSource source = new InputSource(new FileInputStream(new File("resource/xml/schema/schema_test.xml")));
	String expression = "/t:templet/t:bean[@name='user']/@class";
	XPathExpression compiledExpression = xPath.compile(expression);
	System.out.println(compiledExpression.evaluate(source));
}

再次运行main()方法将重新得到前面相同的运行结果。

二、Dom4j对XPath的支持

除了JAXP外，JDOM和Dom4j也提供了对XPath的支持。其中在Dom4j中，与JAXP的XPathExpression作用类似的接口为org.dom4j.XPath，这是在dom4j-1.x.x.jar中，因此在实际的使用过程中需将此包加入到classpath中。

例如，利用XPath获取上述schema_test_copy.xml中无命名空间的节点：

package com.daniele.appdemo.xml.dom4j;

import java.io.File;

import org.dom4j.Document;
import org.dom4j.DocumentException;
import org.dom4j.DocumentFactory;
import org.dom4j.DocumentHelper;
import org.dom4j.Element;
import org.dom4j.Node;
import org.dom4j.XPath;
import org.dom4j.io.SAXReader;

/**
 * <p>Dom4j对XPath支持的测试类</p> 
 * @author  <a href="mailto:code727@gmail.com">Daniele</a>
 * @version 1.0.0, 2013-7-18
 * @see     
 * @since   AppDemo1.0.0
 */
public class Dom4jXPathTester {

	public static void main(String[] args) throws DocumentException {
		
		DocumentFactory factory = DocumentFactory.getInstance();
		SAXReader reader = new SAXReader(factory);
		
		// 解析无命名空间的XML文档
		Document document = reader.read(new File("./resource/xml/schema/schema_test_copy.xml"));
		Element root = document.getRootElement();
		
		String subNodeName = "bean";
		/* 
		 * 从工厂(DocumentFactory)对象或DocumentHelper中创建XPath对象，
		 * 与JAXP的XPathExpression类似，XPath的作用在于避免对同一个XPath求值时进行重复编译的问题
		 */
		XPath rootSubNodePath = factory.createXPath(root.getPath() + "/" + subNodeName);
		System.out.println("根元素" + root.getName() + "内共有"
				+ rootSubNodePath.selectNodes(document).size() + "个"
				+ subNodeName + "子节点");
		
		subNodeName = "description";
		rootSubNodePath = DocumentHelper.createXPath(root.getPath() + "/" + subNodeName);
		Node subNode = rootSubNodePath.selectSingleNode(document);
		System.out.println("根元素" + root.getName() + "子节点"
				+ subNode.getName() + "的文本值为：" + subNode.getText());
	}

}

运行后将得到如下结果：

根元素templet内共有2个bean子节点
根元素templet子节点description的文本值为：This is a XML Schema example.

与JAXP的情况一样，如果上述代码用来获取schema_test.xml文件中带命名空间的节点，则同样不会得到预期结果。为此，Dom4j也提供了与JAXP类似的解决方案，实际使用情况甚至比JAXP的还要方便和灵活。

Dom4j也提供了一个名为NamespaceContext的接口（与javax.xml.namespace.NamespaceContext没有任何关系），它可以根据某一个前缀来得到对应的URI，它在Dom4j的依赖包jaxen-1.x.jar中，因此在使用时需要将此包导入到classpath中。

jaxen提供了一个NamespaceContext的默认实现类SimpleNamespaceContext。在这个实现类中有一个叫namespaces的Map成员属性，它是用来维护命名空间前缀和URI的映射关系的。当进行XPath求值时，首先会将表达式中的前缀标识提取出来，再根据这个标识，到它所关联的NamespaceContext的映射中获取对应的URI，最终再调用NamespaceContext接口方法translateNamespacePrefixToUri(String prefix)返回URI。

对于SimpleNamespaceContext来说，它有如下两种方式来添加命名空间关系：

1)利用构造函数来添加——public SimpleNamespaceContext(Map namespaces)，这种方式传入一个已经在外部设置好了的映射关系即可；

2)调用SimpleNamespaceContext实例的addNamespace(String prefix, String URI)方法来逐条添加。

完成后，再调用XPath实例的setNamespaceContext(namespaceContext)方法，将Context实例传入即可。例如：

package com.daniele.appdemo.xml.dom4j;

import java.io.File;
import java.util.HashMap;
import java.util.Map;

import org.dom4j.Document;
import org.dom4j.DocumentException;
import org.dom4j.DocumentFactory;
import org.dom4j.DocumentHelper;
import org.dom4j.XPath;
import org.dom4j.io.SAXReader;
import org.jaxen.NamespaceContext;
import org.jaxen.SimpleNamespaceContext;

/**
 * <p>Dom4j利用XPath获取具有命名空间的节点的测试类</p> 
 * @author  <a href="mailto:code727@gmail.com">Daniele</a>
 * @version 1.0.0, 2013-7-18
 * @see     
 * @since   AppDemo1.0.0
 */

public class Dom4jNamespaceXPathTester {

	public static void main(String[] args) throws DocumentException {
		
		DocumentFactory factory = DocumentFactory.getInstance();
		SAXReader reader = new SAXReader(factory);
		
		// 解析具有命名空间的XML文档
		Document document = reader.read(new File("./resource/xml/schema/schema_test.xml"));
		
		// 命名空间前缀与URI的映射
		Map<String, String> namespaceMap = new HashMap<String, String>();
		namespaceMap.put("t", "http://www.appdemo.daniele.com/schema/templet");
		XPath xPath = null;
		
                // 根据映射关系构建NamespaceContext实例
		NamespaceContext namespaceContext = new SimpleNamespaceContext(namespaceMap);
		xPath = DocumentHelper.createXPath("/t:templet/t:bean");
		xPath.setNamespaceContext(namespaceContext);
		System.out.println(xPath.selectNodes(document).size());
		
		xPath = factory.createXPath("/t:templet/t:bean");
		xPath.setNamespaceContext(namespaceContext);
		System.out.println(xPath.selectNodes(document).size());		
	}

}

对于XPath的实例来说，可以完成摒弃对NamespaceContext实例的创建和设置，可以调用它的另外一个方法setNamespaceURIs(Map map)，直接将映射关系传递给这个方法就可以了。例如：

// 命名空间前缀与URI的映射
Map<String, String> namespaceMap = new HashMap<String, String>();
namespaceMap.put("t", "http://www.appdemo.daniele.com/schema/templet");
XPath xPath = null;
		
xPath = DocumentHelper.createXPath("/t:templet/t:bean");
xPath.setNamespaceURIs(namespaceMap);
System.out.println(xPath.selectNodes(document).size());
		
xPath = factory.createXPath("/t:templet/t:bean");
xPath.setNamespaceURIs(namespaceMap);
System.out.println(xPath.selectNodes(document).size());

在setNamespaceURIs()方法的内部，它会创建一个SimpleNamespaceContext来维护映射关系（具体实现在org.dom4j.xpath.DefaultXPath中）。

对于上述两种方式，都有一个比较明显的缺陷，即对于每一个新建的XPath实例来说，在求值之前都需要设置一次context或映射关系，这是比较繁琐的。

为此，Dom4j也提供了一个类似JAXP那样的全局设置方式，即调用DocumentFactory实例的setXPathNamespaceURIs(Map map)方法。

public static void main(String[] args) throws DocumentException {
		
		DocumentFactory factory = DocumentFactory.getInstance();
		SAXReader reader = new SAXReader(factory);
		
		// 解析具有命名空间的XML文档
		Document document = reader.read(new File("./resource/xml/schema/schema_test.xml"));
		
		// 命名空间前缀与URI的映射
		Map<String, String> namespaceMap = new HashMap<String, String>();
		namespaceMap.put("t", "http://www.appdemo.daniele.com/schema/templet");
		// 设置全局的映射关系
		factory.setXPathNamespaceURIs(namespaceMap);
		XPath xPath = null;
		
		xPath = DocumentHelper.createXPath("/t:templet/t:bean");
		System.out.println(xPath.selectNodes(document).size());
		
		xPath = factory.createXPath("/t:templet/t:bean");
		System.out.println(xPath.selectNodes(document).size());
		
	}

回顾第一部分中最后一块代码片段，JAXP的javax.xml.xpath.XPath并不代表某一个具体的表达式对象（Dom4j中的XPath更像是javax.xml.xpath.XPathExpression），因此在javax.xml.xpath.XPath实例中设置的NamespaceContext就表示为全局的，即后续所有与编译好了的XPathExpression（对于Dom4j来说是XPath）都使用同一个全局的NamespaceContext来将表达式中的前缀标识替换成对应的URI。

心如止水dy

关注

0
点赞
踩
2

收藏

觉得还不错? 一键收藏
0
评论
JAXP和Dom4j通过XPath获取带命名空间的节点

一、JAXP对XPath的支持 XPath是从JAXP1.3开始被支持的，在这些API中，其核心接口有XPath和XPathExpression，它们都在javax.xml.xpath包中，分别表示XPath对象以及被预编译后的表达式对象。例如，对于如下的示例文件(schema_test_copy.xml) &lt;?xml version...
复制链接

扫一扫