体验 Spring 的 Object/XML 映射支持

使用 Spring 框架进行编组和解组

在 Java™ Platform Enterprise Edition (Java EE) 社区内,Spring 正在成为一个非常受欢迎的框架。Spring 的最新版本的特性之一是它的 Object/XML (O/X) 映射支持。这个 API 支持开发人员在 Java 对象和 XML 之间来回转换。在本文中,您将学习如何使用 Spring 中的 Object/XML 映射特性并了解它的优势。

Brian M. Carey, 高级系统工程师, Triangle Information Solutions

Brian Carey 的照片Brian Carey 是一位信息系统顾问,擅长 Java、Java Enterprise、PHP、Ajax 和相关技术。您可以在 http://twitter.com/brianmcarey 的 Twitter 上了解 Brian Carey。



2009 年 12 月 07 日

Spring 是什么?

常用缩略词

  • API:应用程序编程接口
  • IDE:集成开发环境
  • XML:可扩展标记语言

Spring 是由 Rod Johnson 开发的一个健壮的 Java 应用程序框架,已在 Java 开发社区中得到广泛使用。Spring 以其流行的科技词汇而著名,比如 “dependency injection(依赖项注入)”、“inversion of control(控制反转)” 和 “aspect-oriented programming(面向方面编程)” 等。它还支持 Model-View-Controller (MVC) 模式,很好地兼容用于数据访问的各种数据库驱动程序。另外,它支持事务处理、单元测试、批处理和安全性。

鉴于 Spring 的良好声誉和悠久历史,它通常是应用程序快速开发的首选框架。但是,最大的好处也许是:Spring 是免费的。

O/X Mapper 是什么?

Spring 3.0 的一个新特性是 O/X Mapper。O/X 映射器这个概念并不新鲜,O 代表 ObjectX 代表 XML。它的目的是在 Java 对象(几乎总是一个 plain old Java object,或简写为 POJO)和 XML 文档之间来回转换。

例如,您可能有一个带有几个属性的简单 bean,且您的业务需要将那个 Java 对象转换为一个 XML 文档。Spring 的 O/X Mapper 能够为您解决那个问题。如果反过来,您需要将一个 XML 文档转换为一个简单 Java bean,Spring 的 O/X Mapper 也能胜任。

有一点需要注意:Spring O/X Mapper 只是定义由流行的第三方框架实现的统一的界面。要利用 Spring 的 O/X 功能,您需要一个在 Java 对象和 XML 之间来回转换的实用程序。Castor 就是这样一个流行的第三方工具,本文将使用这个工具。其他这样的工具包括 XMLBeans、Java Architecture for XML Binding (JAXB)、JiBX 和 XStream。

编组和解组

进行 O/X 映射时,您经常会看到编组(marshalling)解组(unmarshalling) 这两个术语。

编组 指将 Java bean 转换成 XML 文档的过程,这意味着 Java bean 的所有字段和字段值都将作为 XML 元素或属性填充到 XML 文件中。有时,编组也称为序列化(serializing)

如您所料,解组 是与编组完全相反的过程,即将 XML 文档转换为 Java bean,这意味着 XML 文档的所有元素或属性都作为 Java 字段填充到 Java bean 中。有时,解组也称为反序列化(deserializing)

使用 Spring 的 O/X Mapper 的好处

使用 Spring 的 O/X Mapper 的一个最直接的好处是可以通过利用 Spring 框架的其他特性简化配置。Spring 的 bean 库支持将实例化的 O/X 编组器注入(即前面提到过的 “依赖项注入”)使用那些编组器的对象。重申一遍,这将加快应用程序开发和部署。

遵循坚实的面向对象的设计实践,Spring O/X 框架只定义两个接口:MarshallerUnmarshaller,它们用于执行 O/X 功能,这是使用这个框架的另一个重大好处。这些接口的实现完全对独立开发人员开放,开发人员可以轻松切换它们而无需修改代码。例如,如果您一开始使用 Castor 进行 O/X 转换,但后来发现它缺乏您需要的某个功能,这时您可以切换到 XMLBeans 而无需任何代码更改。唯一需要做的就是更改 Spring 配置文件以使用新的 O/X 框架。

使用 Spring 的 O/X Mapper 的另一个好处是统一的异常层次结构。Spring 框架遵循使用它的数据访问模块建立的模式,方法是将原始异常对象包装到 Spring 自身专为 O/X Mapper 建立的运行时异常中。由于第三方提供商抛出的原始异常被包装到 Spring 运行时异常中,您能够查明出现异常的根本原因。您也不必费心修改代码以捕获异常,因为异常已包装到一个运行时异常中。以下几个运行时异常扩展了基础异常 XMLMappingExceptionGenericMarshallingFailureExceptionValidationFailureExceptionMarshallingFailureExceptionUnmarshallingFailureException

一个简单的演示

现在您已经了解了 Spring 的 O/X Mapper 的背景和基础知识,可以检验它的使用方法了。在本文中,您首先创建一个简单的 Spring 应用程序,该程序独立于任何 Java Enterprise 依赖项。然后,您创建一个简单的 Java 类,它访问 Spring 的配置文件来实例化该类并注入 O/X 依赖项。参见 下载 部分获取所有源代码文件(包括配置文件)的链接。

编码

首先应该注意 Spring 配置文件。清单 1 是应用程序用于执行编组和解组操作的配置文件。注意,这个文件必须 在运行时位于类路径中。

清单 1. 配置文件
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
           http://www.springframework.org/schema/beans/spring-beans-3.0.xsd">

    <bean id="oxmExample" class="com.xyz.OXMExample">
        <property name="marshaller" ref="castorMarshaller" />
        <property name="unmarshaller" ref="castorMarshaller" />
    </bean>
    <bean id="castorMarshaller" class="org.springframework.oxm.castor.CastorMarshaller">
    	<property name="mappingLocation" value="classpath:mapping.xml" />
    </bean>
</beans>

如您所见,这个配置文件只定义了两个 bean,这是为了简便起见。第一个 bean 是用于执行演示的类:com.xyz.OXMExample。与该类关联的两个属性使用依赖项注入,它们都使用 castorMarshaller bean 的一个实例注入。这是在 Spring 框架中定义 bean 的标准方法,经验丰富的 Spring 开发人员很快就会意识到这一点。

另一个 bean 是 castorMarshaller bean 本身,它是 org.springframework.oxm.castor.CastorMarshaller 的一个实例,org.springframework.oxm.castor.CastorMarshaller 主要用于包装 Castor 框架。如前所述,使用 Spring 的 O/X 功能需要使用一个第三方 O/X 框架。在本例中,这个第三方产品是 Castor。还要注意,有一个属性使用 castorMarshaller 定义,那是用于在 Java bean 和 XML 输出之间来回映射的映射文件。这个文件称为 mapping.xml,它必须 在运行时位于类路径中。我将稍后解释 mapping.xml 文件的内容。

清单 2 实际执行 O/X 映射器的代码的部分清单。如您所见,它是一个简单的 Java 类。

清单 2. OXMExample 类(节选)
public class OXMExample {
    private static final String FILE_NAME = "simplebean.xml";
    private SimpleBean simpleBean;

    private Marshaller marshaller;
    private Unmarshaller unmarshaller;

    public void setMarshaller(Marshaller marshaller) {
        this.marshaller = marshaller;
    }

    public void setUnmarshaller(Unmarshaller unmarshaller) {
        this.unmarshaller = unmarshaller;
    }

    public void saveSimpleBean() throws IOException {
        FileOutputStream os = null;
        try {
            os = new FileOutputStream(FILE_NAME);
            this.marshaller.marshal(simpleBean, new StreamResult(os));
        } finally {
            if (os != null) {
                os.close();
            }
        }
    }

    public void loadSimpleBean() throws IOException {
        FileInputStream is = null;
        try {
            is = new FileInputStream(FILE_NAME);
            this.simpleBean 
                        = (SimpleBean) this.unmarshaller.unmarshal(new StreamSource(is));
        } finally {
            if (is != null) {
                is.close();
            }
        }
    }

    public static void main(String[] args) throws IOException {
        ApplicationContext appContext 
                        = new ClassPathXmlApplicationContext("applicationContext.xml");
        OXMExample ex = (OXMExample) appContext.getBean("oxmExample");
        ex.go();
    }

    private void go() throws IOException {
        simpleBean = getSimpleBean();

        saveSimpleBean();
        loadSimpleBean();
        
        System.out.println("name: " + simpleBean.getName());
        System.out.println("job description: " + simpleBean.getJobDescription());
        System.out.println("age: " + simpleBean.getAge());
        System.out.println("executive: " + simpleBean.isExecutive());
    }


    private SimpleBean getSimpleBean() {
        SimpleBean simpleBean = new SimpleBean();
        simpleBean.setAge(35);
        simpleBean.setExecutive(false);
        simpleBean.setJobDescription("Janitor");
        simpleBean.setName("Mister Jones");

        return simpleBean;

    }
}

要解释 清单 2,必须首先介绍 main 方法,因为该方法将先执行。然后再接着介绍清单 2。

首先,在 main 方法中,您的代码捕获 Spring 应用程序的上下文,就是您在 清单 1 中看到的配置文件。这个文件必须在类路径中,否则运行代码将产生一个异常。

当您获得应用程序上下文时,OXMExample 的一个实例从该配置文件中提供的定义创建。注意,这个 bean 在代码中的名称(oxmExample)与配置文件中定义的名称(见清单 1)一致。创建 OXMExample 的一个实例后,调用 go() 方法。这有点反常,因为 Spring 框架实例化一个已经从命令行运行的对象,但那只是为了实现演示目的而进行的简化。

go() 方法在打印结果数据前完成 3 个任务:

  1. 创建 SimpleBean 的一个实例。
  2. 编组该实例。
  3. 解组从编组创建的 XML 文档。

您使用 getSimpleBean() 方法实例化一个包含一个虚拟员工的信息的 SimpleBean 对象。这个信息包含年龄(一个整数)、工作描述(一个字符串)、姓名(一个字符串)和该员工是否是执行官(一个布尔型)。您使用测试数据和返回调用者的返回对象(在本例中为 go() 方法)填充字段。您在编组发生时将这个 bean 写入一个 XML 文件,在解组发生时读取那个 XML 文件的内容。

saveSimpleBean() 方法执行编组。首先,您获得一个指向 simplebean.xml 的对象,然后,您使用编组器对象(通过 Spring 的依赖项注入实例化)调用 marshal 方法。这个方法需要两个参数:

  • 要被编组的对象(本例中为 SimpleBean 实例)
  • 一个 StreamResult 对象,它基本上表示一个 XML 输出抽象

loadSimpleBean() 方法执行解组。首先,您获取一个指向 simplebean.xml 的 FileInputStream 对象,然后,您使用解组器对象(通过 Spring 的依赖项注入实例化)调用 unmarshal 方法。唯一需要的参数是一个包装 FileInputStream 对象的 StreamSource 对象。注意,解组将创建一个泛型对象,因此您必须将其显式设置为 SimpleBean 类型。

即使这个类和 Spring 配置文件已经就绪,您也还没有准备好运行这段代码。还记得 清单 1 中的映射文件吗?您还需要定义那个映射文件。定义代码如 清单 3 所示,而且,再说一遍,它也必须在运行时位于类路径中。

清单 3. mapping.xml 文件
<mapping>
        <class name="com.xyz.SimpleBean">

           <map-to xml="simplebean"/>

           <field name="age" type="integer">
              <bind-xml name="age" node="element"/>
           </field>

           <field name="executive" type="boolean">
              <bind-xml name="is-executive" node="element"/>
           </field>
	   
           <field name="jobDescription" type="string">
              <bind-xml name="job" node="element"/>
           </field>

           <field name="name" type="string">
              <bind-xml name="name" node="element"/>
           </field>
        </class>
</mapping>

清单 3 中的映射文件特定于 O/X 映射的 Castor 实现。第一个元素(class)定义要映射到一个 XML 输出的类。您必须指定完整路径。

map-to 元素提供 XML 文件的根元素的名称。这很重要,因为 XML 规范规定,每个 XML 文件必须有一个根元素。

每个 field 元素都将被映射到 SimpleBean 类中的一个特定字段。每个 field 元素的 bind-xml 子元素用于指定关于该字段的特定于 XML 的信息,如对应的 XML 元素的名称,每个字段的值应该是一个元素值还是一个属性值。如您所见,在本例中,所有值都是元素值。

测试

尽管代码已经编写完成,但在执行这个应用程序之前,您必须处理一些依赖项。

特定于 Spring 的依赖项有:

  • org.springframework.asm-3.0.0.M4.jar
  • org.springframework.beans-3.0.0.M4.jar
  • org.springframework.context-3.0.0.M4.jar
  • org.springframework.core-3.0.0.M4.jar
  • org.springframework.expression-3.0.0.M4.jar
  • org.springframework.oxm-3.0.0.M4.jar

特定于 Castor 的依赖项有:

  • castor-1.3-core.jar
  • castor-1.3-xml.jar

您还需要 commons-logging-1.1.1.jar 和 log4j-1.2.15.jar,因为 Spring 框架需要它们。

所有这些 Java Archive (JAR) 文件必须在运行时位于类路径中。如果您在没有这些依赖项的情况下试图运行代码,您很可能会收到一个异常,指出某个类没有找到。如果遇到这种情况,只需双击您的类路径,确保所有的必要依赖项已就绪。事实上,要成功编译这段代码,您需要大部分 JAR 文件。要了解关于获取这些 JAR 文件的信息,请参见本文末尾的 参考资料

您可以使用您钟爱的 IDE 或只是使用命令行来运行 OXMExample.class。要从命令行运行,只需从您的工作目录输入 java -cp [classpath] OXMExample,这里的 [classpath] 是指向刚才提到的所有依赖项(JAR 文件和配置文件)的类路径。

首次运行该程序后,一个名为 simplebean.xml 的新文件将出现在您的工作目录中。该文件的内容应该如 清单 4 所示。

清单 4. simplebean.xml 文件
<?xml version="1.0" encoding="UTF-8"?>
<simplebean>
 <age>35</age>
 <is-executive>false</is-executive>
 <job>Janitor</job>
 <name>Mister Jones</name>
</simplebean>

清单 4 显示了来自应用程序的编组端的输出,而 清单 5 则显示来自应用程序的解组端的结果,这些结果将在您的控制台中显示。

清单 5. 解组输出
name: Mister Jones
job description: Janitor
age: 35
executive: false

现在,您已经成功地完成了您的首次 Spring O/X 映射测试。祝贺您!

现在最好做开发人员应该做的工作:修改代码。向类添加字段并将它们映射到 XML 文件。删除一些字段并将它们从 XML 文件中移除。参考 Castor 文档,尝试一些更复杂的工作,比如嵌套元素。您可以随心所欲地尝试各种可能性。

结束语

Spring 的 O/X 映射接口是 Spring 框架的强大特性。借助它,您不仅可以将 XML 文档转换为 Java 对象,还可以将 Java 对象转换为 XML 文档。

它利用 Spring 的一个关键优势:依赖项注入。通过结合使用依赖项注入和 Spring 的 O/X Mapper,您可以轻松开发一个解决方案,该方案可以使用任一 O/X 实现,比如 Castor、XBeans、JiBX、JAXB 和 XStream。由于各个特定实现是 Spring 强大的 Inversion of Control 容器的一部分,开发人员可以在多个特定 O/X 实现之间轻松切换而无需修改代码。

Spring 的 O/X Mapper 还向开发人员提供一个统一的异常层次结构,这意味着不管您使用哪个第三方实现,抛出的运行时异常都是相同的。再强调一次,这将有利于在多个 O/X 供应商之间切换。

在 Java 开发社区中,提供 XML 支持的 Java 应用程序非常热门并且 Spring 框架被广泛使用,因此 Spring 的 O/X Mapper 将受到全世界 Java 应用程序开发人员的欢迎。


下载

描述名字大小
本文的源代码OXMTest.zip4KB

参考资料

学习

  • 实现 Castor 数据绑定(Brett McLaughlin,developerWorks,2007 年 11 月 — 2008 年 4 月):在一个包含 4 部分的文章系列中了解关于 Castor 和它的特性的更多信息,该系列介绍的内容包括 Castor 的安装和设置,Java 和 XML 代码的编组和解组,模式之间的映射,以及将 Java 对象绑定到 SQL 数据存储上。
  • Spring 系列(Naveen Balani,developerWorks,2005 年 6 月 — 10 月):使用这个 4 部分系列探索 Spring 框架的秘密。
  • IBM XML 认证:了解如何才能成为一名 IBM 认证的 XML 和相关技术的开发人员。
  • XML 技术库:访问 developerWorks XML 专区 ,获得广泛的技术文章和技巧、教程、标准和 IBM 红皮书。
  • developerWorks 技术活动网络广播:随时关 注这些活动中的技术。
  • developerWorks 播客:收听面向软件开发人员的有趣访谈和讨论。

获得产品和技术

讨论

条评论

developerWorks: 登录

标有星(*)号的字段是必填字段。


需要一个 IBM ID?
忘记 IBM ID?


忘记密码?
更改您的密码

单击提交则表示您同意developerWorks 的条款和条件。 查看条款和条件

 


在您首次登录 developerWorks 时,会为您创建一份个人概要。您的个人概要中的信息(您的姓名、国家/地区,以及公司名称)是公开显示的,而且会随着您发布的任何内容一起显示,除非您选择隐藏您的公司名称。您可以随时更新您的 IBM 帐户。

所有提交的信息确保安全。

选择您的昵称



当您初次登录到 developerWorks 时,将会为您创建一份概要信息,您需要指定一个昵称。您的昵称将和您在 developerWorks 发布的内容显示在一起。

昵称长度在 3 至 31 个字符之间。 您的昵称在 developerWorks 社区中必须是唯一的,并且出于隐私保护的原因,不能是您的电子邮件地址。

标有星(*)号的字段是必填字段。

(昵称长度在 3 至 31 个字符之间)

单击提交则表示您同意developerWorks 的条款和条件。 查看条款和条件.

 


所有提交的信息确保安全。


static.content.url=http://www.ibm.com/developerworks/js/artrating/
SITE_ID=10
Zone=XML, Java technology
ArticleID=453658
ArticleTitle=体验 Spring 的 Object/XML 映射支持
publish-date=12072009