使用JAXB处理XML文档——先睹为快

使用JAXB处理XML文档——先睹为快

JAXB以其方便的XML数据处理能力可能会引起你的兴趣。你可能还不了解JAXB是什么，想要知道它到底有 什么好处，如果这是你需要的，你才会再花时间去细细的研究它，或者你只需要使用最基本的功能。然而Sun关于JAXB的文档有80页之多。我想大部分人都 没有耐心看完这样的长篇大论。本文以简短的篇幅介绍了JAXB的基本使用，算是先睹为快吧。本文附带的代码包括了JAXB1.0 early access版本和本文所使用的代码。欢迎与我讨论： mailto:boyofjava@sina

 

本文假设你会使用Java编程，了解并能够看懂XML，DTD。

 

1 为什么要使用JAXB

在 Java中处理XML数据的常规方法有SAX，DOM等。其中SAX使用起来很麻烦，不能修改XML数据；而DOM的处理大文档速度非常的慢，易用性也不 必SAX好到哪里去。实际上，无论是SAX还是DOM都不是专门为Java准备的，它们都是访问XML文档的统一底层接口，与语言无关。

现在我们有了另外的选择。这就是JAXB和JDOM。JDOM与本文无关，目前最新的版本是beta8，感兴趣的话，可以访问/。

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中，先到。注意由于是早期版本，需要先登录才能下载，本文附带的 源码包含了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文档。它描述书的列表，举例如下：

文件l

<?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 ls.xjc.Main bookList.dtd bookList.xjs

如果没出问题，编译器就生成了Book.java，BookList.java两个文件。你不用去理解这两个源文件里面的代码，只要知道怎么使用它们提供的方法就可以了。它们的继承结构都是这样的：

java.lang.Object

   l.bind.ValidatableObject

      l.bind.MarshallableObject

         l.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文件，把它和生成的两个文件以及前面的l放在一起。这个程序从 l读入数据，作修改（把第一本书作者改成王五）后写入l。因为中文的编码问题，所以我们需要多一点手续。

文件Test.java

import java.io.*;

import java.util.*;

l.bind.*;

l.marshal.*;

public class Test{

       public static void main(String[] args) throws Exception{

        BookList bl = new BookList();

        FileInputStream fis = new FileInputStream(&#l");

        try{

            bl = bl.unmarshal(fis);

        }finally{

            fis.close();

        }

        List books = bl.getBook();

        Book b = ((0);

        b.setAuthor("王五");

 

        bl.validate();  //先验证，不然marshal会出错

        FileOutputStream fos = new FileOutputStream(&#l");

        XMLWriter xw = new XMLWriter(fos,"GBK");

        try{

            bl.marshal(xw);

        }finally{

            fos.close();

        }

       }

}

 

编译运行，生成的文件l如下：

<?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 ls.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 SimpleDateFormat df

           = SimpleDateFormat("yyyy-MM-dd");

 

    public static Date parseDate(String d) {

           try {

               return df.parse(d);

          } catch (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中好像做不到，在l.marshal.XMLWriter中有一个chars(String str)方法，可以把字符串到XML文件的声明后面，但是这个方法对特殊字符作了转义，也就是没办法可以做到。这很奇怪，因为这是一个常用的功能，要实现 也不难。也许还有我没有发现的办法。倒是有一个doctype方法可以写DOCTYPE声明。

 

8 参考文档

1 The Java ™ Architecture for XML Binding User’s Guide

 (.pdf)

2 Web Services Made Easier. The Java TM APIs and Architectures for XML, A Technical White Paper (.pdf )

转自：.html

 

转载于:.html