用JDom轻松整合Java和XML

副标题#e#

概述：

Jdom是用Java语言读、写、操纵XML的新API函数。Jason Hunter 和 Brett McLaughlin果真宣布了它的测试版本。在直觉、简朴和高效的前提下，这些API函数被最大限度的优化。在接下来的篇幅里，Hunter 和 McLaughlin先容怎么用Jdom去读写一个已经存在的XML文档。

Jdom是一个开源的api，它以直接易懂的方法向java措施员描写XML文档和文档的内容。就象名字展现的那样，Jdom是为java优化的。为利用XML文档提供一个低耗损的要领。Jdom的利用者可以不必把握太多的XML的常识就可以完成想要的操纵。

Jdom可以和已有的XML技能如Simple API for XML (SAX)和 Document Object Model (DOM)彼此协作.然而，它并不是简朴的从这些api中提取出一些。Jdom从这些已存在的技能中接收了好的方面，本身成立了一套新的类和接口，用一个Jdom用户的话来说就是：“这些接口是我从一开始阅读org.w3c.dom就等候的”；Jdom可以读入SAX或是DOM的内容，也可以输出SAX或DOM可以吸收的名目。这个本领可以使Jdom很好的和已有的用SAX或DOM成立的系统之间整合。

Jdom的原则

第一条而且是最重要的一条就是Jdom的api函数被设计成对java措施员来说是简朴易懂的。其他的XML理会函数被设计成语言通用的（支持沟通的api函数在java，c++，甚至是javascript中）。Jdom操作了java的优秀的特征，如：要领重载、接纳机制，和靠山处理惩罚等。

为了可以或许简朴易用，这些函数不得不以措施员喜欢的形式来描画XML文档。譬喻：措施员想的到的一个元素的文本内容是什么样子的呢？

＜element＞This is my text content＜/element＞

在一些api中，元素的文本内容仅被看成是一个元素的孩子节点。从技能角度来说，这个设计需要下面的代码才气会见到元素的内容：

String content = element.getFirstChild().getValue();

Jdom用一种更简朴易用的要领来取得元素的内容：

String text = element.getText();

Jdom尽大概的淘汰措施员的事情量。依据拇指法则，Jdom应该用20%或是更少的尽力来完成80%或是更多的java/xml方面的问题。这并不是说Jdom只是支持80%的XML类型（实际上我们但愿Jdom100%的支持XML类型）。这个拇指法则是说有些对象可以加进去，可是没有须要。这些api函数应该保持简捷。

Jdom的第二条原则是说Jdom应该是快速的和轻量级的。调入和执行文档应该快速，内存的耗损应该只管小。Jdom的设计明明是遵循这个原则。譬喻，就算在开始的时候，不太协调的操纵已经比DOM快，可是比SAX显的粗拙。尽量这样，Jdom照旧有很多SAX没有的利益。

你需要Jdom吗？

那么，你需要Jdom吗？这真是一个很好的问题。已经有了存在的尺度，为什么还要去发现一个新的呢？谜底是Jdom办理了现有的尺度办理不了的问题。

DOM完全在内存中描写一个元素树。它是一个大的api，被设计操纵险些所有大概的XML任务。它也必需有沟通的api去支持差异的语言。因为这些限制，对那些习惯利用java的特征，如要领重载、简朴的set,get要领的java措施员来说，就很不习惯。DOM还需要大量的内存和较高的主频，这使它很难和很多轻量级的web应用一起事情。

SAX没有在内存中成立一个元素树，它用工作成长的方法来描写。譬喻：它陈诉每个读到的开始标志和竣事标志。这种处理惩罚方法使它成为一个轻量级的快速读取的api。然而，这种事件处理惩罚方法对处事器端的java措施员来说不足直观。SAX也不支持修改XML文档和随机读取。

Jdom试图组合DOM和SAX的利益。它被设计成一个可以在小内存上快速执行轻量级api 。Jdom也支持随机读取整个文档，可是令人诧异的是它并不需要把整个文档读到内存中。这个api支持将来的当需要时才读入信息的次轻量级操纵。尚有，Jdom通过尺度的结构器和set要领支持XML文档的修改。

#p#副标题#e#

获取XML文档

Jdom用org.Jdom.Document类的一个实例来描写一个XML文档。这个文档类是一个轻重量级的，它可以包罗文档范例、多处理惩罚指令的工具、一个根元素和注释工具。你可以不需要结构器而从草稿结构一个文档。

Document doc = new Document(new Element("rootElement"));

本文后头我们会接头从草稿结构一个XML文档是何等的容易。可是此刻，我们从一个已存在的文件、一个流、或是一个URL路径中结构我们的文档。

SAXBuilder builder = new SAXBuilder();
Document doc = builder.build(url);

你可以用org.Jdom.input包中提供的结构类从任何数据源中结构文档。最近，有两种结构方法：SAXBuilder 和 DOMBuilder。SAXBuilder用sax理会器从文件中结构文档。SAXBuilder侦听sax事件并从内存中成立一个相应的文档。这种方法很是快（根基上和sax一样快），这也是我们推荐的方法。DOMBuilder是另一种可选的方法，它从一个存在的org.w3c.dom.Document工具中成立Jdom文档。它答允Jdom轻松的和构建DOM树的东西实现接口。

#p#分页标题#e#

Jdom的速度有值得等候的提高的潜力通过一个延期的结构器的完成。这个结构器查抄XML数据源，但当请求的时候才对它理会。譬喻：文档的属性当不会见时是不需要理会的。

结构器仍在成长，可以通sql查询、ldap查询和其他的数据名目来够造Jdom文档。所以，一旦进到内存中，文档就和制作它的东西没有干系了。

SAXBuilder 和 DOMBuilder结构器答允用户指明他们是否应该轮换，以便确定哪个理会器时间执行理会的任务。

public SAXBuilder(String parserClass, boolean validation);
public DOMBuilder(String adapterClass, boolean validation);

默认的是用apache的开源 Xerces理会器而且是封锁轮换的。你应该注到DOMBuilder不象一个理会类，倒更象一个适配类。这是因为不是所有的DOM理会器都是沟通的api。为了仍让用户选择喜欢的理会器，Jdom利用一个对所有的dom理会器合用的民众的api的适配类。这个适配类支持所有风行的dom理会器，包罗Apache 的 Xerces, Crimson，IBM 的 XML4J, Sun 的 Project X, 和Oracle 的 parsers V1 and V2.每一个理会器通过正确的挪用此外理会器的要领执行尺度的接口。这有点象jaxp，除了它支持jaxp所不支持的新的理会器。

输出XML文档

你可以用几种差异的尺度输出东西输出一个XML文档。org.Jdom.output.XMLOutputter也许是最常用要领。它将xml文档写入一个特定的OutputStream.

SAXOutputter东西是另一个选择。它发生基于Jdom xml文档的sax事件，你可以把这些送到期待这些sax事件的应用措施哪里。沟通的方法，DOMOutputter发生一个dom文档，这样你就可以把它送给可以吸收dom文档的应用措施。输出xml文档的代码看起来象下边的样子：

XMLOutputter outputter = new XMLOutputter();
outputter.output(doc, System.out);

XMLOutputter用参数定制输出的名目。第一个参数是行缩进的名目；第二个参数是你是否想另起一行。因为呆板到呆板的原因，为了速度思量你可以放弃行缩进和另起新行。

XMLOutputter outputter = new XMLOutputter("", false);
outputter.output(doc, System.out);

（译注：这样的话本身看起来会很欠悦目，并且每一次从头写入的时候城市使这个xml文件变大，所以我发起照旧要缩进和另起一行，支持中文的带换行和缩进的名目如下：

XMLOutputter outp = new XMLOutputter(“”,true,"GB2312");
outp.setTextTrim(true);
outp.output(doc, System.out);

可以拜见以前我写的Jdom的文章http://www.csdn.net/Develop/read_article.asp?id=20720）

#p#副标题#e#

下面是读入一个xml文档，并把它又输出的例子：

import java.io.*;
import org.Jdom.*;
import org.Jdom.input.*;
import org.Jdom.output.*;
public class PrettyPrinter {
public static void main(String[] args) {
　// Assume filename argument
　String filename = args[0];
　try {
　　// Build the document with SAX and Xerces, no validation
　　SAXBuilder builder = new SAXBuilder();
　　// Create the document
　　Document doc = builder.build(new File(filename));
　　// Output the document, use standard formatter
　　XMLOutputter fmt = new XMLOutputter();
　　fmt.output(doc, System.out);
　} catch (Exception e) {
　　e.printStackTrace();
　}
}
}

读取文档范例

此刻，让我们来看一下怎么读取文档的具体内容。很多XML文档都有的一个对象是文档范例，在Jdom顶用DocType类来描写。万一你不是XML方面的专家（嘿，不消悲观，你就是我们所要面向的听众），一个文档范例的声明看起来象下边的样子：

＜!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"＞

DOCTYPE后边的第一个词展现文档被强制范例的名字，PUBLIC后边的词是文档范例的民众属性，最后一个词是文档范例的系统属性。文档属性可以上通过文档的getDocType（）要领得到，DocType类提供了一组得到文档范例声明的要领。

DocType docType = doc.getDocType();
System.out.println("Element: " + docType.getElementName());
System.out.println("Public ID: " + docType.getPublicID());
System.out.println("System ID: " + docType.getSystemID());

读取文档数据

每一个XML文档必需有一个根元素。这个元素是会见所有XML文档内部信息的起始点。譬喻：这个文档片断用＜web-app＞作为根元素：

＜web-app id="demo"＞
　＜description＞Gotta fit servlets in somewhere!＜/description＞
　＜distributable/＞
＜/web-app＞

根元素的实例可以在文档中直接得到。

Element webapp = doc.getRootElement();

这样，你就可以会见这个元素的属性（如上边的id）内容和子节点元素。

#p#副标题#e#

会见子节点

#p#分页标题#e#

XML文档是树型布局的，任何一个元素都有大概包括任何数量的子元素。譬喻：＜web-app＞元素有＜description＞和 ＜distributable＞作为子节点元素。你可以通过许多要领得到一个元素的子元素，getChild()假如没有子元素的话返回NULL。

List getChildren(); // return all children
List getChildren(String name); // return all children by name
Element getChild(String name); // return first child by name

示例：

// Get a List of all direct children as Element objects
List allChildren = element.getChildren();
out.println("First kid: " + ((Element)allChildren.get(0)).getName());
// Get a list of all direct children with a given name
List namedChildren = element.getChildren("name");
// Get a list of the first kid with a given name
Element kid = element.getChild("name");

当文档布局事先知道的环境下，getchild（）要领很容易快速的得到嵌套的元素。给出一个XML文档：

＜?xml version="1.0"?＞
　＜linux:config＞
　　＜gui＞
　　　＜window-manager＞
　　　　＜name＞Enlightenment＜/name＞
　　　　＜version＞0.16.2＜/version＞
　　　＜/window-manager＞
　　　＜!-- etc --＞
　　＜/gui＞
　＜/linux:config＞

下边的代码直接得到window manager 的名字

String windowManager = rootElement.getChild("gui")
.getChild("window-manager")
.getChild("name")
.getText();

假如文档不行用要小心NullPointerExceptions异常。为了实现简朴的文档导航，将来的Jdom大概会支持xpath。子节点可以通过getParent()得到父节点。

获取文档属性

属性是元素拥有的另一组信息。html措施员对他是很熟悉的。下边的＜table＞元素有width和border属性。

＜table width="100%" border="0"＞ ＜/table＞

这些属性可以在元素中直接得到。

String width = table.getAttributeValue("width");

你也可以用属性实例来从头得到这些属性。这个本领辅佐Jdom支持一些高级观念，譬喻名字空间中的属性。（参考文章后边关于名字空间的内容）

Attribute widthAttrib = table.getAttribute("width");
String width = widthAttrib.getValue();

为了利便你还可以得到这些属性的原始数据范例。

int width = table.getAttribute("border").getIntValue();

你可以转化这些数据到任何的原始数据范例。假如这些属性不能转换成原始数据范例就抛出一个DataConversionException异常。假如属性不存在getAttribute()返回一个null;

#p#副标题#e#

提取文档内容

我们为用简朴的要领得到文档内容而感动，下边我们看一下用element.getText()要领提取文档的文本内容是何等容易。这个是尺度要领，合用于象下边这样的文档：

＜name＞Enlightenment＜/name＞

可是有些时候这些文档包括注释，文本内容和子元素。在一些高级的文档中，它甚至包括一些处理惩罚指令：

＜table＞
　＜!-- Some comment --＞
　Some text
　＜tr＞Some child＜/tr＞
　＜?pi Some processing instruction?＞
＜/table＞

你可以老是通过下边的方法得到文本内容和子节点：

String text = table.getText(); // "Some text"
Element tr = table.getChild("tr"); // ＜tr＞ child

这使得尺度利用很简朴。有些时候譬喻输出，得到一个文档所有内容的顺序是很重要的。为了这个原因，你可以利用一个非凡的要领叫getMixedContent()。它返回一个list内容大概包括注释，字符串，元素和处理惩罚指令的实例。Java措施员可以利用instanceof 来得到内容。下边的代码打印一个文档内容的摘要：

 

List mixedContent = table.getMixedContent();
Iterator i = mixedContent.iterator();
while (i.hasNext()) {
　Object o = i.next();
　if (o instanceof Comment) {
　　// Comment has a toString()
　　out.println("Comment: " + o);
　}
　else if (o instanceof String) {
　　out.println("String: " + o);
　}
　else if (o instanceof ProcessingInstruction) {
　　out.println("PI: " + ((ProcessingInstriction)o).getTarget());
　}
　else if (o instanceof Element) {
　　out.println("Element: " + ((Element)o).getName());
　}
}