XML 与 Java 技术： 用 Castor 进行数据绑定

xml 与 java 技术: 用 castor 进行数据绑定



英文原文













内容:



文档模型与数据绑定
castor 框架
默认绑定
改变 xml 格式
处理集合
对象引用
使用数据
结束语
参考资料
关于作者
对本文的评价



相关内容:



java 中的 xml：文档模型
理解 sax

理解 dom



在 xml 专区还有:



教学
工具与产品
所有的文章




使用开放源代码项目 cator 进行 java 的 xml 数据绑定
级别:中级
dennis m. sosnoski (dms@sosnoski.com)
总裁,sosnoski software solutions, inc.
2003 年 12 月
对于主要关心文档数据内容的应用程序,java xml 数据绑定是一种代替 xml 文档模型的强大机制。本文中,企业 java 专家 dennis sosnoski 介绍数据绑定,并讨论什么使它如此令人瞩目。然后,他向读者展示了如何利用 java 数据绑定的开放源代码 castor 框架来处理日益复杂的文档。如果您的应用程序更多的把 xml 作为数据而不是文档,您就会愿意了解这种处理
xml 和 java 技术的简单有效的方法。
应用程序中使用 xml 文档的多数方法都把重点放在 xml 上:从 xml 的观点使用文档,按照 xml 元素、属性和字符数据内容编程。如果应用程序主要关心文档的 xml 结构,那么这种方法非常好。对于更关心文档中所含数据而非文档本身的许多应用程序而言,数据绑定 提供了一种更简单的使用 xml 的方法。
文档模型与数据绑定
本系列文章的上一篇(请参阅
参考资料)所讨论的文档模型,是与数据绑定最接近的替代方案。文档模型和数据绑定都在内存中建立文档的表示,都需要在内部表示和标准文本 xml 之间双向转换。两者的区别在于文档模型尽可能保持 xml 结构,而数据绑定只关心应用程序所使用的文档数据。
为了说明这一点,图 1 给出了一个简单 xml 文档的数据模型视图。文档成分——在这个例子中只有元素和文本节点——通过反映原始 xml 文档的结构连接在一起。形成的节点树很容易和原始文档联系,但要解释树中表示的实际数据就不那么容易了。
图 1. 文档的文档模型视图



如果应用程序使用 xml 文档模型方法,您就需要处理这种类型的树。这种情况下,您将使用节点之间的父子关系在树的上下层之间导航,使用属于同一父节点的子女之间的兄弟关系在树的同一层中导航。您可以非常详尽地处理树结构,当把树序列化为文本时,生成的 xml 文档将反映您所做的修改(比如插入的注释)。
现在来看看与图 1 截然不同的图 2,它表示同一文档的数据绑定视图。在这里,转换过程几乎隐藏了原始 xml 文档的所有结构,但是因为只有通过两个对象,更容易看清楚真正的数据,也更很容易访问这些数据。
图 2. 文档的数据绑定视图



使用这种数据结构就像是一般的 java 编程——甚至根本不需要知道 xml!(哦,还是不要走得 太 远了——我们这些专家顾问还得活……)您的项目中至少要有人明白,这种数据结构和 xml 文档之间的映射是如何建立的,但这仍然是向简化迈出的一大步。
不 仅仅 是编程的简化,数据绑定还带来其他的好处。与文档模型方法相比,因为抽掉了许多文档细节,数据绑定通常需要的内存更少。比如前面两个图中所示的数据结构:文档模型方法使用了 10 个单独的对象,与此相比数据绑定只使用了两个。要创建的东西少,构造文档的数据绑定表示可能就更快一些。最后,数据绑定与文档模型相比,应用程序可以更快地访问数据,因为您可以控制如何表示和存储数据。我后面还要讲到这一点。
既然数据绑定那么好,为何还要使用文档模型呢?以下两种情况需要使用文档模型:
应用程序真正关注文档结构的细节。比方说,如果您在编写一个 xml 文档编辑器,您就会坚持使用文档模型而非数据绑定。
您处理的文档没有固定的结构。比如实现一种通用的 xml 文档数据库,数据绑定就不是一种好办法。
许多应用程序使用 xml 传输数据,但并不关心文档表示的细节。这类应用程序非常适合使用数据绑定。如果您的应用程序符合这种模式,请继续读下去。
castor 框架
目前有几种不同的框架支持 java xml 数据绑定,但还没有标准的接口。这种情况最终会得到改变:java community process (jcp) 的 jsr-031 正在努力定义这方面的标准(请参阅
参考资料)。现在让我们选择一个框架并学习使用它的接口。
本文选择了 castor 数据绑定框架。castor 项目采用 bsd 类型的证书,因此可在任何类型的应用程序(包括完整版权的项目)中使用。 castor 实际上仅仅有 xml 数据绑定,它还支持 sql 和 ldap 绑定,尽管本文中不讨论这些其他的特性。该项目从 2000 年初开始发起,目前处于后 beta 状态(一般可以使用这个版本,但是如果需要问题修正,您可能需要升级到目前的
cvs 版本)。请参阅 参考资料 部分的 castor 站点链接,以了解更多的细节并下载该软件。
默认绑定
castor xml 数据绑定很容易上手,甚至不需要定义 xml 文档格式。只要您的数据用类 javabean 的对象表示,castor 就能自动生成表示这些数据的文档格式,然后从文档重构原始数据。
数据绑定词汇表
下面这个小小的词汇表列出了本文中要用到的一些术语:
编组 是在内存中生成对象的 xml 表示的过程。与 java 序列化一样,这种表示需要包括所有依赖的对象:主对象引用的对象、这些对象引用的其他对象、等等。
解组 是上述过程的逆过程,在内存中从 xml 表示创建对象(以及依赖的对象)。
映射 是用于编组和解组的一些规则。castor 有一些内建的规则定义了默认映射,本文这一部分将要描述。它也允许您使用单独的映射文件,参见后述。
那么“类 javabean”是什么意思呢?真正的 javabean 是可视化组件,可以在开发环境中配置以用于 gui 布局。一些源于真正 javabean 的惯例已经被 java 团体普遍接受,特别是对于数据类。如果一个类符合以下惯例,我就称之为是“类 javabean”的:
这个类是公共的
定义了公共的默认(没有参数)构造函数
定义了公共的 getx 和 setx 方法访问属性(数据)值
关于技术定义已经扯得太远了,当提到这些类 javabean 类时,我将不再重复说明,只是称之为“bean”类。
在整篇文章中,我将使用航线班机时刻表作为示例代码。我们从一个简单的 bean 类开始说明它的工作原理,这个类表示一个特定的航班,包括四个信息项:
飞机编号(航空公司)
航班编号
起飞时间
抵达时间
下面的清单 1 给出了处理航班信息的代码。
清单 1. 航班信息 bean
public class flightbean { private string m_carrier; private int m_number; private string m_departure; private string m_arrival; public flightbean() {} public void setcarrier(string carrier)
{ m_carrier = carrier; } public string getcarrier() { return m_carrier; } public void setnumber(int number) { m_number = number; } public int getnumber() { return m_number; } public void setdeparturetime(string time) { m_departure = time; } public string getdeparturetime()
{ return m_departure; } public void setarrivaltime(string time) { m_arrival = time; } public string getarrivaltime() { return m_arrival; } }
您可以看到,这个 bean 本身没有什么意思,因此我想增加一个类并在默认的 xml 绑定中使用它,如清单 2 所示。
清单 2. 测试默认的数据绑定
import java.io.*; import org.exolab.castor.xml.*; public class test { public static void main(string[] argv) { // build a test bean flightbean bean = new flightbean(); bean.setcarrier("ar");
bean.setnumber(426); bean.setdeparturetime("6:23a"); bean.setarrivaltime("8:42a"); try { // write it out as xml file file = new file("test.xml"); writer writer = new filewriter(file); marshaller.marshal(bean, writer); // now restore the value and list what
we get reader reader = new filereader(file); flightbean read = (flightbean) unmarshaller.unmarshal(flightbean.class, reader); system.out.println("flight " + read.getcarrier() + read.getnumber() + " departing at " + read.getdeparturetime() + " and arriving
at " + read.getarrivaltime()); } catch (ioexception ex) { ex.printstacktrace(system.err); } catch (marshalexception ex) { ex.printstacktrace(system.err); } catch (validationexception ex) { ex.printstacktrace(system.err); } } }
castor 不仅能用于 bean
实际上,castor 不仅仅能用于本文所述的类 javabean 类。它也可以访问带有公共成员变量的简单数据对象类的数据。比如,稍微改动前述的 test 类,您就可以对航班数据使用如下的定义,并最终得到同样的 xml 格式:
public class flightdata { public string carrier; public int number; public string departure; public string arrival; }
为了使 castor 正常工作,一个类必须全部采用这种方式或那种方式。如果类定义了 任何 getx 或 setx 方法,castor 就将其视作 bean,并在编组和解组时只使用这些方法。
这段代码首先构造了一个 flightbean bean,并使用一些固定的数据初始化它。然后用该 bean 默认的 castor xml 映射将其写入一个输出文件。最后又读回生成的 xml, 同样使用默认映射重构 bean,然后打印重构的 bean 中的信息。结果如下:
flight ar426 departing at 6:23a and arriving at 8:42a
这个输出结果表明您已经成功地来回转换了航班信息(不算太糟,只有两次方法调用)。现在我还不满足于简单控制台输出,准备再往深处挖一挖。
幕后
为了更清楚地了解这个例子中发生了什么,看一看 marshaller.marshal() 调用生成的 xml。文档如下:
8:42a 6:23a ar
castor 使用 java 内部检查机制检查 marshaller.marshal() 调用传递的对象。在本例中,它发现了定义的四个属性值。castor 在输出的 xml 中创建一个元素(文档的根元素)表示整个对象。元素名从对象的类名中衍生出来,在这里是 flight-bean。然后castor 用以下两种方法中的一个,把该对象的属性值包括进来:
对于具有基本类型值的属性创建元素的一个属性(本例中只有 number 属性通过 getnumber() 方法公开为 int 值)。
对于每个具有对象类型值的属性创建根元素的一个子元素(本例中的所有其他属性,因为它们是字符串)。
结果就是上面所示的 xml 文档。
改变 xml 格式
如果不喜欢 castor 的默认映射格式,您可以方便地改变映射。在我们的航班信息例子中,比方说,假定我们需要更紧凑的数据表示。使用属性代替子元素有助于实现这个目标,我们也许还希望使用比默认的名字更短一些的名字。如下所示的文档就可以很好地满足我们的需要:
定义映射
为了让 castor 使用这种格式而非默认的格式,首先需要定义描述这种格式的映射。映射描述本身(非常意外的)是一个 xml 文档。清单 3 给出了把 bean 编组成上述格式的映射。
清单 3. 紧凑格式的映射
basic mapping example
class 元素定义了一个命名类 flightbean 的映射。通过在该元素中加入 auto-complete 属性并把值设为 true,您可以告诉 castor 对于该类的任何属性,只要没有在这个元素中专门列出,就使用默认映射。这样非常简便,因为 number 属性已经按照希望的方式处理了。
子元素 map-to 告诉 castor,要把 flightbean 类的实例映射为 xml 文档中的 flight 元素。如果您继续使用默认的元素名 flight-bean(参阅
幕后 小节中默认映射输出的例子),可以不使用该元素。
最后,对于每个希望以非默认方式处理的属性,可以引入一个 field 子元素。这些子元素都按照相同的模式:name 属性给出映射的属性名,bind-xml 子元素告诉 castor 如何映射那个属性。这里要求把每个属性映射成给定名称的属性。
使用映射
现在已经定义了一个映射,您需要告诉 castor 框架在编组和解组数据时使用那个映射。清单 4 说明了要实现这一点,需要对前面的代码做哪些修改。
清单 4. 使用映射编组和解组
... // write it out as xml (if not already present) mapping map = new mapping(); map.loadmapping("mapping.xml"); file file = new file("test.xml"); writer writer = new filewriter(file); marshaller
marshaller = new marshaller(writer); marshaller.setmapping(map); marshaller.marshal(bean); // now restore the value and list what we get reader reader = new filereader(file); unmarshaller unmarshaller = new unmarshaller(map); flightbean read = (flightbean)unmarshaller.unmarshal(reader);
... } catch (mappingexception ex) { ex.printstacktrace(system.err); ...
与前面
清单 2 默认映射所用的代码相比,这段代码稍微复杂一点。在执行任何其他操作之前,首先要创建一个 mapping 对象载入您的映射定义。真正的编组和解组也有区别。为了使用这个映射,您需要创建 marshaller 和 unmarshaller 对象,用定义的映射配置它们,调用这些对象的方法,而不是像第一个例子那样使用静态方法。最后,您必须提供对映射错误产生的另一个异常类型的处理。
完成这些修改后,您可以尝试再次运行程序。控制台输出与第一个例子相同(如
清单 2 所示),但是现在的 xml 文档看起来符合我们的需要:
处理集合
现在单个航班数据已经有了我们喜欢的形式,您可以定义一个更高级的结构:航线数据。这个结构包括起降机场的标识符以及在该航线上飞行的一组航班。清单 5 给出了一个包含这些信息的 bean 类的例子。
清单 5. 航线信息 bean
import java.util.arraylist; public class routebean { private string m_from; private string m_to; private arraylist m_flights; public routebean() { m_flights = new arraylist(); } public void
setfrom(string from) { m_from = from; } public string getfrom() { return m_from; } public void setto(string to) { m_to = to; } public string getto() { return m_to; } public arraylist getflights() { return m_flights; } public void addflight(flightbean flight)
{ m_flights.add(flight); } }
在这段代码中,我定义了一个 addflight() 方法,用于每次增加一个属于这条航线的航班。这是在测试程序中建立这种数据结构非常简便的办法,但是可能和您预料的相反, castor 在解组时并不使用种方法向航线中增加航班。相反,它使用 getflights() 方法访问一组航班,然后直接添加到集合中。
在映射中处理航班集合只需要稍微改变上一个例子(如
清单 3 所示)中的 field 元素。清单 6 显示了修改后的映射文件。
清单 6. 映射包含一组航班的航线
collection mapping example
一切都和上一个映射(如
清单 3 所示)完全相同,只不过用 field 元素定义了一个 routebean 的 flights 属性。这个映射用到了两个原来不需要的属性。collection 属性的值 collection 把该属性定义成一个 java.util.collection (其他值分别定义数组,java.util.vectors 等等)。type 属性定义包含在集合中的对象类型,值是完整的限定类名。这里的值是
flightbean,因为对这些类我没有使用包。
另一个区别在 flightbean 类元素中,不再需要使用 map-to 子元素定义绑定的元素名。定义 routebean 的 flights 属性的 field 元素,通过它的 bind-xml 子元素定义了这一点。因为编组或解组 flightbean 对象只能通过该属性,它们将永远使用这个 bind-xml 元素设定的名称。
我不再详细列出这个例子的测试程序,因为数据绑定部分和上一个例子相同。以下是用一些示例数据生成的 xml 文档:
对象引用
现在可以为处理完整的航班时刻表做最后的准备了。您还需要增加三个 bean:
airportbean 用于用于机场信息
carrierbean 用于航线信息
timetablebean 把一切组合起来
为了保持趣味性,除了上一个例子(参阅
处理集合)中用到的 routebean 和 flightbean 之间的从属关系,您还要在 bean 之间增加一些联系。
连接 bean
要增加的第一个联系是修改 flightbean,让它直接引用班机信息,而不再仅仅用代码标识班机。以下是对 flightbean 的修改:
public class flightbean { private carrierbean m_carrier; ... public void setcarrier(carrierbean carrier) { m_carrier = carrier; } public carrierbean getcarrier() { return m_carrier; } ...
}
然后对 routebean 做同样的修改,让它引用机场信息:
public class routebean { private airportbean m_from; private airportbean m_to; ... public void setfrom(airportbean from) { m_from = from; } public airportbean getfrom() { return m_from; }
public void setto(airportbean to) { m_to = to; } public airportbean getto() { return m_to; } ... }
我没有给出新增 bean 自身的代码,因为和前面的代码相比没有什么新鲜的东西。您可以从下载文件 code.jar 中找到完整的示例代码(请参阅
参考资料)。
映射引用
您可能需要映射文档的其他一些特性,以支持编组和解组的对象之间的引用。清单 7 给出了一个完整的映射:
清单 7. 完整的时刻表映射
reference mapping example
除了新增的 bean 之外,这里有一个重要的变化,就是增加了 identity 和 reference 属性。class 元素的 identity 属性,通知 castor 这个命名属性是该类实例的唯一标识符。在这里,我把 carrierbean 和 airportbean 的 ident 属性定义成它们的标识符。
bind-xml 元素的 reference 属性,提供了对于该映射 castor 所需要的另一部分链接信息。reference 设为 true 的映射告诉 castor 编组和解组引用对象的标识符,而不是对象本身的副本。从 routebean 链接 airportbean (表示航线的起止点)的引用,从 flightbean 链接 carrierbean 的引用,都使用了这种方法。
当 castor 使用这种类型的映射解组数据时,它自动把对象标识符转化为对实际对象的引用。您需要保证标识符的值确实是唯一的,甚至不同类型的对象之间也要保证这种唯一性。对于本例中的数据,这一点不成问题:飞机的标识符是两个字符,而机场的标识符是三个字符,永远不会冲突。如果 确实 有潜在冲突的可能性,只要在所代表的对象类型的每个标识符加上唯一的前缀,就可以很容易地避免这种问题。
编组后的时刻表
这个例子的测试代码没有新东西,只是增加了一些示例数据。清单 8 给出了编组形成的 xml 文档:
清单 8. 编组的时刻表 http://www.arcticairlines.com arctic airlineshttp://www.combinedlines.com combined airlinesseattle, wa seattle-tacoma international airportlos angeles, ca los angeles international airport
使用数据
现在,时刻表中的所有数据都最终完成了,简单地看一看如何在程序中处理它们。使用数据绑定,您已经建立了时刻表的数据结构,它由几种类型的 bean 组成。处理数据的应用程序代码可以直接使用这些 bean。
比方说,假设您要查看在西雅图和洛杉矶之间有哪些航班可供选择,并且要求班机至少具备指定的最低品质评价级别。清单 9 给出了使用数据绑定 bean 结构获取这些信息的基本代码(完整的细节请参阅从
参考资料 下载的源文件)。
清单 9. 航班查找程序代码
private static void listflights(timetablebean top, string from, string to, int rating) { // find the routes for outbound and inbound flights iterator r_iter = top.getroutes().iterator();
routebean in = null; routebean out = null; while (r_iter.hasnext()) { routebean route = (routebean)r_iter.next(); if (route.getfrom().getident().equals(from) && route.getto().getident().equals(to)) { out = route; } else if (route.getfrom().getident().equals(to)
&& route.getto().getident().equals(from)) { in = route; } } // make sure we found the routes if (in != null && out != null) { // find outbound flights meeting carrier rating requirement iterator o_iter = out.getflights().iterator(); while (o_iter.hasnext())
{ flightbean o_flight = (flightbean)o_iter.next(); if (o_flight.getcarrier().getrating() >= rating) { // find inbound flights meeting carrier rating // requirement, and leaving after outbound arrives int time = timetominute(o_flight.getarrivaltime()); iterator
i_iter = in.getflights().iterator(); while (i_iter.hasnext()) { flightbean i_flight = (flightbean)i_iter.next(); if (i_flight.getcarrier().getrating() >= rating && timetominute(i_flight.getdeparturetime()) > time) { // list the flight combination printflights(o_flight,
i_flight, from, to); } } } } } }
您可以尝试使用前面
清单 8 中的数据。如果您询问从西雅图(sea)到洛杉矶(lax)、级别大于或等于 8 的班机,就会得到如下的结果:
leave sea on arctic airlines 426 at 6:23a return from lax on arctic airlines 593 at 9:27a leave sea on arctic airlines 426 at 6:23a return from lax on arctic airlines 102 at 12:30p leave
sea on arctic airlines 433 at 9:00a return from lax on arctic airlines 102 at 12:30p
与文档模型的比较
这里我不准备全面讨论使用 xml 文档模型的等价代码,那太复杂了,足以单独成章。解决这个问题最简单的方式,可能是首先解析 carrier 元素,创建每个标识符代码到相应对象之间的映射链接。然后使用和
清单 9 中示例代码类似的逻辑。和使用 bean 的例子相比,每一步都更加复杂,因为代码使用的是 xml 成分而不是真正的数据值。性能可能更糟——只对数据进行少量的操作还不算是问题,但是如果数据处理是应用程序的核心,这就会成为一个主要的焦点。
如果在 bean 和 xml 的映射中使用更多的数据类型转换,差别会更大(无论从代码的复杂性还是从性能的角度看)。比方说,假设您使用很多的航班时间,可能希望把文本时间转化成一种更好的国际化表示(如一天内的分钟数,参见
清单 9)。您可以选择为文本和国际化格式定义可以替换的 get 和 set 方法(让映射仅仅使用文本形式),也可以定义一个定制的 org.exolab.castor.mapping.fieldhandler 实现让 castor 使用这些值。保留时间值的内部形式,可以避免匹配清单 9 中的航班时进行转换,也许还能加快处理速度。
除了本文中所述的之外——fieldhandler 只是一个例子,castor 还有许多迷人的特性。但愿这些例子和讨论使您能够初步领略这个框架的强大功能和灵活性。 我相信,您将和我一样发现 castor 非常有用也非常有趣。
结束语
对于使用 xml 交换数据的应用程序,数据绑定是文档模型很好的替代品。它简化了编程,因为您不必再按照 xml 的方式思考。相反,您可以直接使用代表应用程序所用数据含义的对象。与文档模型相比,它还潜在地提供了更好的内存和处理器使用效率。
本文中,我使用 castor 框架展示了一些越来越复杂的数据绑定的例子。所有这些例子都使用所谓的 直接 数据绑定:开发人员根据数据定义类,然后把数据映射到 xml 文档结构。下一篇文章中,我将探讨另一种方法:模式 数据绑定,利用模式(如 dtd、xml 模式或者其他的类型)生成和那个模式对应的代码。
castor 同时支持模式方法和本文中介绍的直接绑定,您将在以后看到更多的 castor 应用。我还关注着 jsr-031 java 数据绑定标准的进展,并对这些方法的性能进行比较。更多了解 java 中的 xml 数据绑定这个领域,请速来访问离您最近的 ibm developerworks。
参考资料
请在
讨论论坛 参与本文的讨论。(您也可以单击本文顶部或底部的讨论来访问论坛。)
下载包含本文所用示例程序和库的
jar 压缩文件。
了解 castor 的最新进展,请访问该项目的
主页。
回顾作者以前的 developerworks 文章,包括 java xml 文档模型的
性能(2001 年 9 月)和
用法(2002 年 2 月)的比较。
其他作者对使用 castor xml 数据绑定的看法,阅读 scott l. bain 的论文 “xml data binding with castor”以及 dion almaer 在 onjava.com 上的文章
“xml data binding with castor”。
sam brodkin 的 javaworld 文章,“use xml data binding to do your laundry”,比较了jaxb 和 castor xml 数据绑定。
jacek kruszelnicki 的 javaworld 文章,“persist data with java data objects, part 2”,比较了 castor 和 sun jdo 的数据绑定和数据存储。
最后,看一看
ibm websphere studio application developer,这是一个创建、测试和部署 j2ee 应用程序简单易用的集成开发环境,包括从 dtd 和模式生成 xml 文档。
其他链接
阅读并下载
java architecture for xml binding (jaxb) 。
进一步了解
jsr 31 - xml data binding specification 。
关于作者


dennis sosnoski (dms@sosnoski.com)
是西雅图地区 java 咨询公司 sosnoski software solutions, inc. 的创始人和首席顾问。他有超过 30 年的专业软件开发经验,最近几年主要关注服务器端 java 技术,包括 servlets、 enterprise javabeans 和 xml。他经常在 xml in java 和 j2ee 技术的全国性会议上发表演讲,他还是
西雅图 java-xml 专业组 的主席。

======================================================

在最后，我邀请大家参加新浪APP，就是新浪免费送大家的一个空间，支持PHP+MySql，免费二级域名，免费域名绑定
这个是我邀请的地址，您通过这个链接注册即为我的好友，并获赠云豆500个，价值5元哦！短网址是http://t.cn/SXOiLh我创建的小站每天访客已经达到2000+了，每天挂广告赚50+元哦，呵呵，饭钱不愁了，\(^o^)/