| |
注：（本文代码在论坛xml版的同名帖子可以下载）
使用jaxb处理xml文档??先睹为快
关键词：java，xml，jaxb，dtd，绑定模式（binding schema），验证（validate），marshal，unmarshal
jaxb以其方便的xml数据处理能力可能会引起你的兴趣。你可能还不了解jaxb是什么，想要知道它到底有什么好处，如果这是你需要的，你才会再花时间去细细的研究它，或者你只需要使用最基本的功能。然而sun关于jaxb的文档有80页之多。我想大部分人都没有耐心看完这样的长篇大论。本文以简短的篇幅介绍了jaxb的基本使用，算是先睹为快吧。本文附带的代码包括了jaxb1.0 early access版本和本文所使用的代码。欢迎与我讨论： mailto:boyofjava@sina.com
本文假设你会使用java编程，了解并能够看懂xml，dtd。
1 为什么要使用jaxb
在java中处理xml数据的常规方法有sax，dom等。其中sax使用起来很麻烦，不能修改xml数据；而dom的处理大文档速度非常的慢，易用性也不必sax好到哪里去。实际上，无论是sax还是dom都不是专门为java准备的，它们都是访问xml文档的统一底层接口，与语言无关。
现在我们有了另外的选择。这就是jaxb和jdom。jdom与本文无关，目前最新的版本是beta8，感兴趣的话，可以访问http://www.jdom.org/。
jaxb的全名是java ™ architecture for xml binding，目前是1.0的early access版本，在sun的java站点只有注册为成员才能够下载。jaxb的特点就是将你用dtd定义好的xml文档映射为java对象，提供简单、快速的数据操作方式。要访问xml中的元素、属性只要通过相应对象上的一系列getter和 setter方法。你还可以通过marshal方法将对象的数据写进xml文件，通过unmarshal方法将xml文件的数据读入对象，通过validate方法验证xml文件是否符合dtd的约束。jaxb的缺点就在于只能访问特定的（也就是你用dtd定义的）xml文档。
2 jaxb如何工作
jaxb包括了一个运行类库和一个模式编译器。首先你要定义xml的dtd，然后编写一个绑定模式（binding schema）。dtd定义了xml文档，绑定模式也是一个xml文件，指出dtd定义的xml文档如何被映射为java对象。运行编译器，将dtd和绑定模式作为参数传给编译器，编译器就会生成java代码。编译生成的java代码，通过这些代码就可以访问xml文档了。
3 jaxb的安装
以1.0 early access为例，它不包含在jdk中，先到http://java.sun.com/xml下载。注意由于是早期版本，需要先登录才能下载，本文附带的源码包含了jaxb1.0 early access。下载后将文件解压缩，在lib目录中有两个文件。jaxb-rt-1.0-ea.jar是运行支持库，jaxb-xjc-1.0-ea.jar是模式编译器。注意bin目录中的xjc文件只能在unix下使用，如果你的系统是windows，那么你需要在命令行窗口手工输入命令来编译。为了在任何地方都可以运行模式编译器和它生成的代码，我们要把这两的文件加入classpath。一个简单的办法是把这两个文件拷贝到jre/lib/ext下。
4 一个简单的例子
有这样一个xml文档。它描述书的列表，举例如下：
文件examplea.xml
<?xml version="1.0" encoding="gbk"?>
<booklist>
<book>
<name>java编程入门</name>
<author>张三</author>
<publishdate>2002-6-6</publishdate>
<price>35.0</price>
</book>
<book>
<name>xml在java中的应用</name>
<author>李四</author>
<publishdate>2002-9-16</publishdate>
<price>92.0</price>
</book>
</booklist>
其dtd文件如下：
文件booklist.dtd
<!element booklist (book)*>
<!element book(name,author,publishdate,price)>
<!element name (#pcdata)>
<!element author (#pcdata)>
<!element publishdate (#pcdata)>
<!element price (#pcdata)>
现在我们就来编写一个最简单的绑定模式，其文件扩展名应该为xjs。
文件booklist.xjs
<xml-java-binding-schema version="1.0-ea">
<element name="booklist" type="class" root="true"/>
</xml-java-binding-schema>
现在就可以运行模式编译器生成java代码，请先保证classpath中包含了jaxb的两个jar文件。windows用户注意bin目录下的那个文件是没用的。在命令行运行：
java com.sun.tools.xjc.main booklist.dtd booklist.xjs
如果没出问题，编译器就生成了book.java，booklist.java两个文件。你不用去理解这两个源文件里面的代码，只要知道怎么使用它们提供的方法就可以了。它们的继承结构都是这样的：
java.lang.object
javax.xml.bind.validatableobject
javax.xml.bind.marshallableobject
javax.xml.bind.marshallablerootelement
booklist or book
booklist.java主要包含了以下方法
booklist() //构造函数
list getbook() //得到书的集合，list中的对象实际类型是book，可以添加、修改、删除其中的元素
void deletebook() //删除集合
void emptybook() //删除并生成一个新的空集合
void marshal(x) //将数据写进xml文档
void unmarshal(x) //将数据从xml文档读入对象
void validate(x) //检查是否符合dtd约束，同时检查子树。在这个例子中就是booklist的book集合
void validatethis() //检查是否符合dtd约束，不检查子树
其中marshal，unmarshal，validate被重载，有多种参数形式（可以参考jaxb的api文档）。
book.java主要包含了以下方法
book()
string getname()
string getauthor()
string getpublishdate()
string getprice()
void setname(string x)
void setauthor(string x)
void setpublishdate(string x)
void setprice(string x)
void marshal()
void unmarshal()
void validate()
现在我们就可以使用这两个文件访问xml了。首先编译这两个文件。编写一个test.java文件，把它和生成的两个文件以及前面的examplea.xml放在一起。这个程序从 examplea.xml读入数据，作修改（把第一本书作者改成王五）后写入exampleb.xml。因为中文的编码问题，所以我们需要多一点手续。
文件test.java
import java.io.*;
import java.util.*;
import javax.xml.bind.*;
import javax.xml.marshal.*;
public class test{
public static void main(string[] args) throws exception{
booklist bl = new booklist();
fileinputstream fis = new fileinputstream("examplea.xml");
try{
bl = bl.unmarshal(fis);
}finally{
fis.close();
}
list books = bl.getbook();
book b = (book)books.get(0);
b.setauthor("王五");
bl.validate(); //先验证，不然marshal会出错
fileoutputstream fos = new fileoutputstream("exampleb.xml");
xmlwriter xw = new xmlwriter(fos,"gbk");
try{
bl.marshal(xw);
}finally{
fos.close();
}
}
}
编译运行，生成的文件exampleb.xml如下：
<?xml version="1.0" encoding="gbk"?>
<booklist>
<book>
<name>java编程入门</name>
<author>王五</author>
<publishdate>2002-6-6</publishdate>
<price>35.0</price></book>
<book>
<name>xml在java中的应用</name>
<author>李四</author>
<publishdate>2002-9-16</publishdate>
<price>92.0</price></book></booklist>
5 更进一步：数据类型转换
你可能已经注意到在上面的例子中，生成的book对象的getprice方法返回的是string，实际上它应该是float。同样publishdate以该是日期类型，而不是字符串。这是因为我们的绑定模式写得太简单了，模式编译器生成了默认的string类型。现在我们这样写：
文件booklist2.xjs
<xml-java-binding-schema version="1.0-ea">
<element name="booklist" type="class" root="true"/>
<element name="price" type="value" convert="float"/>
<element name="publishdate" type="value" convert="transdate" />
<conversion name="transdate" type="java.util.date"
parse="transdate.parsedate" print="transdate.printdate"/>
</xml-java-binding-schema>
用java com.sun.tools.xjc.main booklist.dtd booklist2.xjs运行编译器。生成的book文件的相应代码为：
float getprice()
java.util.date getpublishdate()
booklist2.xjs第3行将price转换成了float类型，float类型是一个简单类型，因此用convert="float"描述就可以了。而 publishdate需要转变成java.util.date，这是一个类，而且他没有以字符串作为参数的构造函数。parse="transdate.parsedate"就表示使用unmarshal读取数据的时候，会调用transdate.parsedate()方法。这个静态方法以字符串为参数，返回java.util.date。print="transdate.printdate"的作用相反。transdate这个类需要我们提供。
文件transdate.java
import java.util.date;
public class transdate {
private static java.text.simpledateformat df
= new java.text.simpledateformat("yyyy-mm-dd");
public static date parsedate(string d) {
try {
return df.parse(d);
} catch (java.text.parseexception pe) {
system.out.print(pe);
return new date();
}
}
public static string printdate(date d) {
return df.format(d);
}
}
6 那些使jaxb能够做到，但本文没有提到的
本文提供的这个例子很简单，实际上jaxb还可以定义文档的哪些元素（属性）可以被转换成类，哪些被转换成类的属性。处理元素的属性。处理枚举值。为一些元素共同的子元素生成接口（因为jaxb不支持namespace），定义继承结构等等。
7 jaxb不能做到的
sun的文档里提到的：
仅支持用dtd定义xml
不支持namespace
不支持内部子集、notations、entity、entities等。
另外，我发现如果要写一条处理指令到xml文档中，例如指定转换的样式单
<?xml-stylesheet href=”a.xsl” type=”text/xsl”?>
在jaxb中好像做不到，在javax.xml.marshal.xmlwriter中有一个chars(string str)方法，可以把字符串到xml文件的声明后面，但是这个方法对特殊字符作了转义，也就是没办法可以做到。这很奇怪，因为这是一个常用的功能，要实现也不难。也许还有我没有发现的办法。倒是有一个doctype方法可以写doctype声明。
8 参考文档
1 the java ™ architecture for xml binding user’s guide
(http://java.sun.com/xml/jaxb/jaxb-docs.pdf)
2 web services made easier. the java tm apis and architectures for xml, a technical white paper (http://java.sun.com/xml/webservices.pdf )
|
|
