Spring中的Object/XML映射详解

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

Spring作为Java应用程序框架,已在Java开发社区中得到广泛使用,SpringSource近日发布了最新版本Spring 3.0.1版本。文章主要针对Spring中的Object/XML映射,分析使用Object/XML映射的特性与优势。

Spring以其流行的科技词汇而著名,比如“dependencyinjection(依赖项注入)”、“inversionofcontrol(控制反转)”和“aspect-orientedprogramming(面向方面编程)”等。它还支持Model-View-Controller(MVC)模式,很好地兼容用于数据访问的各种数据库驱动程序。

另外,它支持事务处理、单元测试、批处理和安全性。鉴于Spring的良好声誉和悠久历史,它通常是应用程序快速开发的首选框架。但是,最大的好处也许是:Spring是免费的。

Object/XML映射是什么?

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

例如,您可能有一个带有几个属性的简单bean,且您的业务需要将那个Java对象转换为一个XML文档。Spring的O/XMapper能够为您解决那个问题。如果反过来,您需要将一个XML文档转换为一个简单Javabean,Spring的O/XMapper也能胜任,有一点需要注意:SpringO/XMapper只是定义由流行的第三方框架实现的统一的界面。要利用Spring的O/X功能,您需要一个在Java对象和XML之间来回转换的实用程序。Castor就是这样一个流行的第三方工具,本文将使用这个工具。其他这样的工具包括XMLBeans、JavaArchitectureforXMLBinding(JAXB)、JiBX和XStream。

编组和解组

进行O/X映射时,您经常会看到编组(marshalling)和解组(unmarshalling)这两个术语。编组指将Javabean转换成XML文档的过程,这意味着Javabean的所有字段和字段值都将作为XML元素或属性填充到XML文件中。有时,编组也称为序列化(serializing)。

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

使用Spring的O/XMapper的好处

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

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

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

一个简单的演示

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

编码

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

  1. <beansxmlnsbeansxmlns="http://www.springframework.org/schema/beans" 
  2. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
  3. xsi:schemaLocation="http://www.springframework.org/schema/beans  
  4. http://www.springframework.org/schema/beans/spring-beans-3.0.xsd"> 
  5.  
  6. <beanidbeanid="oxmExample"class="com.xyz.OXMExample"> 
  7. <propertynamepropertyname="marshaller"ref="castorMarshaller"/> 
  8. <propertynamepropertyname="unmarshaller"ref="castorMarshaller"/> 
  9. </bean> 
  10. <beanidbeanid="castorMarshaller"class="org.springframework.oxm.castor.CastorMarshaller"> 
  11. <propertynamepropertyname="mappingLocation"value="classpath:mapping.xml"/> 
  12. </bean> 
  13. </beans> 

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

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

  1. publicclassOXMExample{  
  2. privatestaticfinalStringFILE_NAME="simplebean.xml";  
  3. privateSimpleBeansimpleBean;  
  4.  
  5. privateMarshallermarshaller;  
  6. privateUnmarshallerunmarshaller;  
  7.  
  8. publicvoidsetMarshaller(Marshallermarshaller){  
  9. this.marshaller=marshaller;  
  10. }  
  11.  
  12. publicvoidsetUnmarshaller(Unmarshallerunmarshaller){  
  13. this.unmarshaller=unmarshaller;  
  14. }  
  15.  
  16. publicvoidsaveSimpleBean()throwsIOException{  
  17. FileOutputStreamos=null;  
  18. try{  
  19. os=newFileOutputStream(FILE_NAME);  
  20. this.marshaller.marshal(simpleBean,newStreamResult(os));  
  21. }finally{  
  22. if(os!=null){  
  23. os.close();  
  24. }  
  25. }  
  26. }  
  27.  
  28. publicvoidloadSimpleBean()throwsIOException{  
  29. FileInputStreamis=null;  
  30. try{  
  31. is=newFileInputStream(FILE_NAME);  
  32. this.simpleBean 
  33. =(SimpleBean)this.unmarshaller.unmarshal(newStreamSource(is));  
  34. }finally{  
  35. if(is!=null){  
  36. is.close();  
  37. }  
  38. }  
  39. }  
  40.  
  41. publicstaticvoidmain(String[]args)throwsIOException{  
  42. ApplicationContextappContext 
  43. =newClassPathXmlApplicationContext("applicationContext.xml");  
  44. OXMExampleex=(OXMExample)appContext.getBean("oxmExample");  
  45. ex.go();  
  46. }  
  47.  
  48. privatevoidgo()throwsIOException{  
  49. simpleBean=getSimpleBean();  
  50.  
  51. saveSimpleBean();  
  52. loadSimpleBean();  
  53.  
  54. System.out.println("name:"+simpleBean.getName());  
  55. System.out.println("jobdescription:"+simpleBean.getJobDescription());  
  56. System.out.println("age:"+simpleBean.getAge());  
  57. System.out.println("executive:"+simpleBean.isExecutive());  
  58. }  
  59.  
  60.  
  61. privateSimpleBeangetSimpleBean(){  
  62. SimpleBeansimpleBean=newSimpleBean();  
  63. simpleBean.setAge(35);  
  64. simpleBean.setExecutive(false);  
  65. simpleBean.setJobDescription("Janitor");  
  66. simpleBean.setName("MisterJones");  
  67.  
  68. returnsimpleBean;  
  69.  
  70. }  

要解释清单2,必须首先介绍main方法,因为该方法将先执行。然后再接着介绍清单2,首先,在main方法中,您的代码捕获Spring应用程序的上下文,就是您在清单1中看到的配置文件。这个文件必须在类路径中,否则运行代码将产生一个异常。 #p#

当您获得应用程序上下文时,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文件:

  1. <mapping> 
  2. <classnameclassname="com.xyz.SimpleBean"> 
  3. <map-toxmlmap-toxml="simplebean"/> 
  4. <fieldnamefieldname="age"type="integer"> 
  5. <bind-xmlnamebind-xmlname="age"node="element"/> 
  6. </field> 
  7. <fieldnamefieldname="executive"type="boolean"> 
  8. <bind-xmlnamebind-xmlname="is-executive"node="element"/> 
  9. </field> 
  10. <fieldnamefieldname="jobDescription"type="string"> 
  11. <bind-xmlnamebind-xmlname="job"node="element"/> 
  12. </field> 
  13. <fieldnamefieldname="name"type="string"> 
  14. <bind-xmlnamebind-xmlname="name"node="element"/> 
  15. </field> 
  16. </class> 
  17. </mapping> 

清单3中的映射文件特定于Object/XML映射的Castor实现。第一个元素(class)定义要映射到一个XML输出的类。您必须指定完整路径,map-to元素提供XML文件的根元素的名称。这很重要,因为XML规范规定,每个XML文件必须有一个根元素。

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

测试

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

  1. org.springframework.asm-3.0.0.M4.jar  
  2. org.springframework.beans-3.0.0.M4.jar  
  3. org.springframework.context-3.0.0.M4.jar  
  4. org.springframework.core-3.0.0.M4.jar  
  5. org.springframework.expression-3.0.0.M4.jar  
  6. org.springframework.oxm-3.0.0.M4.jar  

特定于Castor的依赖项有:

  1. castor-1.3-core.jar  
  2. castor-1.3-xml.jar 

您还需要commons-logging-1.1.1.jar和log4j-1.2.15.jar,因为Spring框架需要它们,所有这些JavaArchive(JAR)文件必须在运行时位于类路径中。如果您在没有这些依赖项的情况下试图运行代码,您很可能会收到一个异常,指出某个类没有找到。如果遇到这种情况,只需双击您的类路径,确保所有的必要依赖项已就绪。事实上,要成功编译这段代码,您需要大部分JAR文件。

您可以使用您钟爱的IDE或只是使用命令行来运行OXMExample.class。要从命令行运行,只需从您的工作目录输入java-cp[classpath]OXMExample,这里的[classpath]是指向刚才提到的所有依赖项(JAR文件和配置文件)的类路径。首次运行该程序后,一个名为simplebean.xml的新文件将出现在您的工作目录中。该文件的内容应该如清单4所示,清单4.simplebean.xml文件:

  1. <?xmlversionxmlversion="1.0"encoding="UTF-8"?> 
  2. <simplebean> 
  3. <age>35</age> 
  4. <is-executive>false</is-executive> 
  5. <job>Janitor</job> 
  6. <name>MisterJones</name> 
  7. </simplebean> 

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

  1. name:MisterJones  
  2. jobdescription:Janitor  
  3. age:35  
  4. executive:false 

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

结束语

Spring的O/X映射接口是Spring框架的强大特性。借助它,您不仅可以将XML文档转换为Java对象,还可以将Java对象转换为XML文档。它利用Spring的一个关键优势:依赖项注入。通过结合使用依赖项注入和Spring的O/XMapper,您可以轻松开发一个解决方案,该方案可以使用任一O/X实现,比如Castor、XBeans、JiBX、JAXB和XStream。由于各个特定实现是Spring强大的InversionofControl容器的一部分,开发人员可以在多个特定O/X实现之间轻松切换而无需修改代码。

Spring的O/XMapper还向开发人员提供一个统一的异常层次结构,这意味着不管您使用哪个第三方实现,抛出的运行时异常都是相同的。再强调一次,这将有利于在多个O/X供应商之间切换,在Java开发社区中,提供XML支持的Java应用程序非常热门并且Spring框架被广泛使用,因此Spring的O/XMapper将受到全世界Java应用程序开发人员的欢迎。

【编辑推荐】

  1. Spring 3.0发布 全面支持RESTful架构
  2. 使用 Spring Framework 设计和开发 SCA 组件
  3. 爱恨交加:OSGi的Spring和EJB之路?
  4. OSGi与Spring DM:使用Spring DataSource
  5. Spring仍然轻量么?谈SpringSource的发展战略

 

责任编辑:王晓东 来源: IBM
相关推荐

2009-12-09 09:55:39

ibmdwSpring

2010-10-09 09:56:51

JavaScriptObject对象

2009-05-12 10:55:06

SQLFOR XML模式

2009-06-16 13:27:59

Hibernate x

2020-12-10 08:21:27

XML映射Mybatis

2009-09-29 15:58:22

Hibernate映射

2020-06-24 08:27:36

ES数组对象

2011-03-18 09:27:00

Spring

2023-07-03 07:39:43

Spring框架设计模式

2009-08-06 18:23:51

XML映射XmlSerializ.asmx处理程序

2009-02-23 13:41:42

XML操作函数SQL Server

2011-08-22 13:28:56

FOR XMLSQL Server

2018-11-19 14:29:17

Spring BootXML支持

2009-06-03 14:06:44

ibmdwXML

2022-06-26 08:39:19

Spring容器字段格式化

2022-05-25 09:00:00

令牌JWT安全

2011-08-24 09:15:36

SQL Server数FOR XML AUT

2010-09-16 14:37:54

DataSetXML

2009-06-17 14:36:10

SpringXML配置文件

2024-04-18 08:28:06

点赞
收藏

51CTO技术栈公众号