一、概述

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文档的修改。

三、获取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树的工具实现接口。

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

下面是读入一个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 ser