CN102609255A

CN102609255A - 一种Spring IOC配置文件的生成方法

Info

Publication number: CN102609255A
Application number: CN2012100181239A
Authority: CN
Inventors: 沈志宏; 黎建辉; 苏贤明
Original assignee: Computer Network Information Center of CAS
Current assignee: Beijing Zhongke Beilong Technology Co ltd
Priority date: 2012-01-19
Filing date: 2012-01-19
Publication date: 2012-07-25
Anticipated expiration: 2032-01-19
Also published as: CN102609255B

Abstract

本发明提供一种Spring IOC配置文件的生成方法，其步骤包括：1)载入一个或多个Java对象实例，读取并过滤欲编组的各Java对象实例的属性列表；2)创建对应的节点创造器，并定义写入规则；3)节点创造器根据写入规则生成Spring IOC配置文件节点，并在该节点中写入Java对象实例及其属性；4)按照不同输出方式将所有节点输出到Spring IOC配置文件。本发明方法的Java对象实例间可以相互引用，生成的Spring IOC配置文件可被Spring框架正确解组；灵活性和编组效率高，可极大地简化配置工作，方便用户使用。

Description

一种Spring IOC配置文件的生成方法

所属技术领域4

本发明属于计算机应用开发领域，涉及XML数据绑定技术，具体涉及一种程序化生成Spring IOC配置文件的方法。

背景技术

Spring作为解决企业应用开发的复杂性而创建的开源框架，是一个轻量级的控制反转(IOC，Inversion of Control)和面向切面的容器框架，亦是Java开发领域最为流行的开源框架，被广泛用于企业应用软件以及政府信息系统的设计与研发。例如：中国专利公开号：CN101996071A，利用Spring框架封装实现所述对象数据操作命令的Java类文件；中国专利公开号：CN101097615，将Spring用于服务的管理，进而实现一网行政审批信息系统架构。Spring使用基本的JavaBean规范来完成以前只可能由EJB完成的事情，并致力于J2EE应用的表现层、业务层以及持久层等各层的解决方案，基于Spring框架，能够轻松实现控制反转与依赖注入、面向切面编程以及声明式事务支持等功能。其中，控制反转和依赖注入功能借助于Java的反射特性，通过遍历读取IOC配置文件来创建Java对象，进而实现对象创建与使用的分离，是Spring框架的核心机制之一。凡是符合Spring Beans的Schema规范的配置文件均可被Spring框架正确解析，进而创建相应的Java对象。

XML是可扩展的标记语言，是W3C组织发布的用于定义互联网上数据描述与数据交换的一种标准，由于其自身良好的跨平台性、可移植性等特点，目前已被广泛应用于软件项目中。在Java开发领域，越来越多的软件项目采用XML作为其数据描述或者数据交换的格式，且绝大多数开发框架均支持或者只支持XML格式的配置文件，如Spring、Struts以及Hibernate等。

XML数据绑定是指从结构化的XML组件(如元素和属性)到保留组件逻辑层次的数据模型(如Java对象)的映射，它既表示了数据的真正含义，也用程序设计语言的原本格式表示组件。XML数据绑定有两个重要的概念：编组和解组。编组是指将对象模型实例转换为XML实例，反之，从XML实例至对象模型实例为解组，如图1所示。XML数据绑定提供了一种简单而直接的方法，使应用程序能够方便的使用XML来保存对象模型的数据，进而达到数据交换或者应用配置的作用。Spring框架解析IOC配置文件并创建相应的Java对象可以理解为解组的过程，而本发明对应的实施例可以将Java对象编组为Spring IOC格式的XML文件。

一般来说，有两种选择实现XML实例到Java对象模型的绑定：(1)利用XML数据绑定框架；(2)利用Dom4j、Jdom等API编写数据绑定应用程序。

目前，Java开发领域的XML数据绑定框架主要有：Castor、Simple、XStream、Digester、Jaxb、Jibx、XmlBeans等。

Castor是ExoLab Group的开放源代码项目之一，主要目标是提供Java对象实例与XML文件实例间的绑定，同时提供SQL和LDAP绑定。Castor利用JavaBean的setter和getter方法实现对象实例的编组与解组，且可以根据需要选择性的使用映射配置文件。Castor的默认映射规则主要有两点：(1)对象实例的基本数据类型属性以节点属性的形式编组到XML文件中；(2)对象实例的高级对象类型属性以子节点的形式编组到XML文件中。Castor数据绑定框架的不足之处是：利用默认映射规则生成复杂嵌套对象的XML文件格式复杂，不易阅读与交换，而映射文件的学习成本较大；多层次对象的相互引用无法正确编组到XML文件。

Simple是一个高性能的XML数据绑定和配置框架。它提供完整的对象编组与解组功能，并能够保持它们的关联关系。Simple利用注解方式配置XML结构，支持数组以及List、Map等任意集合对象，并提供完全的命名空间支持，允许版本管理框架向前和向后兼容序列化。相对于其它XML数据绑定框架来说，Simple框架具有速度快、配置简单等特点，对于构造器、模板过滤器等也有很好的支持。但Simple框架不能正确的编组多层次对象的相互引用(相互引用会导致Simple在编组过程中出现异常)等复杂对象。

XStream数据绑定框架的特点是不用任何映射就能实现多数Java对象的序列化，支持多种XML解析器。XStream将对象以及对象的属性名称转换为XML的节点名称，属性的值转换为XML节点的文本。和其它数据绑定框架相比，XStream有三个突出的特点：(1)不关心序列化/逆序列化的类的字段的可见性；(2)序列化/逆序列化类的字段不需要getter和setter方法；(3)序列化/逆序列化的类不需要有默认构造函数。也就是说，在不作任何修改的情况下，使用XStream就能直接序列化/逆序列化任何第三方类。正是因为XStream无需任何配置即可直接序列化/逆序列化任何第三方类，导致XML文档中的自定义元素名称以及属性展现方式均需要在序列化代码中硬编码实现。

Jaxb(Java Architecture for XML Binding)作为Java规范的实现，提供了一个快速便捷的方式将Java对象与XML进行转换，已经被纳入到JavaSE 6.0的标准库中。同时，在JAX-WS(Java的WebService规范之一)中，JavaSE 6.0自带的版本JAX-WS2.1，其底层支持就是Jaxb。Jaxb亦支持注解方式将Java对象绑定到一段XML，同时可以使用Jaxb的XJC工具，通过定义Schema的方式实现Java对象与XML的绑定。Jaxb在转换效率以及配置方面均可以和Simple进行媲美，其不足之处亦与Simple框架类似，即不能正确的编组多层次对象的相互引用等复杂对象。利用Dom4j、Jdom等API编写数据绑定应用程序是实现XML实例到Java对象模型绑定的又一解决方案。如，中国专利公开号：CN101339500A，提出了一种基于XML模式的数据绑定应用程序接口生成方法；中国专利公开号：CN101699397A，实现了一种Java与XML数据绑定的方法。为实现某些特定的需求，有部分项目也选择利用Dom4j、Jdom等API编写应用程序实现XML实例到Java对象模型的绑定。然而，这些应用程序最大不足在于硬编码过多，导致灵活性和可扩展性有所欠缺。

综上所述，这些框架、专利或程序在配置、编组效率以及灵活性等方面各有所长，但相对于本发明对应的实施例来说，具备如下不足：

(1)多层次对象不能相互引用。上述数据绑定框架均采用XML的层次嵌套方式来解决对象实例中对另一个对象的引用。如图1所示，学生对象实例(Student)中对地址对象实例(Address)的引用多体现为学生节点(<Student>)中包含(<Address>)节点。这种层次嵌套方式从根本上就无法解决多层次对象相互引用(例如：学生对象实例有个属性为班主任实例，而班主任对象实例也有个学生实例的列表)的数据绑定问题，而只能利用一端的绑定来编写代码手动注入另外一端的绑定。而Spring IOC配置文件可以很好的定义多层次对象的相互引用且能被Spring框架正确的解组为Java对象实例。

(2)无法与Spring框架无缝集成。上述框架、专利或者程序均是将Java对象编组为普通的XML文件实例，无法被Spring框架解析。Spring框架作为当今Java开发领域最为流行的开源框架，能够为Java应用的表现层、业务层以及持久层等各层提供优秀的解决方案。与Spring框架无缝集成，能够无缝引用Spring框架上下文定义的其它对象，是发明实施例的一大特点。

(3)单一输出文件。上述框架、专利或者程序均局限于将某个Java对象编组到某个XML文件，而无法实现对象的多文件编组输出以及互不关联的多个对象实例同时输出。在以Spring框架为核心的Java应用中，将应用的某些配置信息以XML文本文件的形式保存，并在需要的时候进行还原是实现配置信息持久化的较为普遍而有效的做法。而在很多场合需要将多个毫无关联的对象实例保存在同一个XML文本文件以减少配置文件的个数或者将一个对象实例保存在不同的文本文件中以控制配置文件的大小。由中国科学院计算机网络信息中心开发的数据管理与共享平台，利用本发明的实施例将数据模型的配置信息按照类型存储在不同的配置文件中，以控制配置文件的复杂度与大小。。

目前，有部分企业应用项目根据自身项目的需求，设计开发了Java对应到Spring配置文件格式的编组，但大多局限在特定需求以及特定前提，而无法满足通用的Java对象编组需求。

发明内容

本发明的目的在于提供一种程序化生成Spring IOC配置文件的方法，以解决Java对象实例编组为Spring IOC配置文件并被Spring框架正确解组的问题。

为达到上述目的，本发明采用如下技术方案：

一种Spring IOC配置文件的生成方法，其步骤包括：

1)载入一个或多个Java对象实例，过滤并读取欲编组的各Java对象实例的属性列表；

2)根据Spring IOC配置文件格式以及Java对象实例的属性类型，创建对应的节点创造器，并由其定义相应类型节点的写入规则；

3)不同类型的节点创造器根据所述写入规则生成不同的Spring IOC配置文件节点，并将Java对象实例及其属性写入到所述Spring IOC配置文件节点中；

4)按照用户定义的输出方式将所有节点输出到Spring IOC配置文件。

进一步地，步骤1)通过Map属性来存储载入的一个或多个Java对象实例。

进一步地，步骤1)通过注解方式读取并过滤所述Java对象实例的属性。所述注解方式包括注解本身和注解的解析类，通过所述解析类读取所有标注的注解进而得到需要编组的属性列表。

进一步地，步骤3)所述属性类型包括基本类型、对象类型、数组类型、List类型、Map类型和Set类型。根据Spring IOC配置文件格式以及所述属性类型，基于节点创造器接口创建所述节点创造器。

进一步地，根据对象格式化接口以及注册类，将所有注册过的Java对象实例格式化为文本字符串。

进一步地，通过对象引用类型节点创造器以及对象实例与引用节点间的对应关系实现多层次Java对象的相互引用。

进一步地，步骤5)所述用户定义的输出方式包括：将不同的对象实例输出到不同的XML文件，将互不关联的多个对象实例输出到同一个XML文件，以及将一个Java对象实例输出到不同的XML文件。所述输出方式通过绑定指定格式的节点到指定的输出文件来实现。

进一步地，上述方法生成的Spring IOC配置文件可通过Spring框架进行解组。

与现有技术相比，本发明的优点和积极效果如下：

1)Java对象实例间可以相互引用，且可以在Spring IOC配置文件实例中得到正确的表达，并被Spring框架正确解组；

2)编组后的Spring IOC配置文件实例可以充分利用Spring框架的其它功能，如声明式事务支持、连接池等，丰富配置信息，简化企业应用的配置；

3)实现不同的对象实现输出到不同的XML文件、互不关联的多个实例输出到同一个XML文件以及一个对象实例输出到不同的XML文件等多种需求；

4)结合对象实例的属性编辑器，支持对象实例的格式化(将对象实例以字符串形式来表达)；

5)本发明在保证灵活性、编组效率以及功能需求的同时，极大地简化了配置工作，方便用户使用；

6)本发明可以在以Spring框架为基础的企业Java应用与政府信息系统中得到应用，利用本发明可以生成Spring IOC配置文件，进而被Spring框架正确解析，实现Java对象与XML文件实例间的编组与解组。动态生成的Spring IOC配置文件可以用来表达应用系统配置信息、数据模型以及其它动态变化的信息。

附图说明

图1为普通XML数据绑定的编组与解组示例图。

图2为本发明实施例的Spring IOC配置文件的生成方法的流程图。

图3为本发明实施例的通过编组上下文将Java对象实例写入到Spring IOC配置文件的流程图。

图4为本发明实施例对应的编组与解组示例图。

具体实施方式

下面通过实施例并结合附图，对本发明做进一步的说明。

图2为本实施例的程序化生成Spring IOC配置文件的方法的流程图，其步骤包括：

1)设计并实现Java对象实例装载机制，实现单个或者多个Java对象实例的装载。

在该步骤中，该Java对象实例装载机制可以装载需要编组的单个或多个Java对象实例列表。该机制体现为含有Map属性的类，可以往Map属性中添加一个或者多个Java对象实例，具体在本实施例中体现为SpringBeans类。

2)设计并实现属性过滤机制，采用注解方式实现需要编组的Java对象的属性过滤与读取。

在该步骤中，所述的机制包括注解本身和注解的解析类，由解析类读取所有标注的注解进而得到需要编组的属性列表；具体到本实施例中，通过设计XmlProperty注解来标识属性 (标识属性对应的get方法)，设计AnnotatedBeanWriterFormatFactory类来解析XmlProperty注解进而获得需要编组到XML文件实例的属性列表。

3)设计并实现对象格式化机制，Java对象实例(或属性)格式化为文本字符串可以有效地隐藏对象实例(或属性)的内部结构，减少XML文件实例的大小，并使XML文件实例的层次结构更为清晰。

在该步骤中，所述的机制包括值格式化接口(可以获得格式化后的值)以及对象格式化注册类，通过对象格式化注册类，可以注册所有需要格式化为文本字符串的对象实例与其格式化后的文本字符串之间的对应关系；具体到本实施例中，通过设计ValueFormatter接口(具有getAsText()方法)获得对象实例的格式化文本，通过对象实例格式化工厂(ValueFormaterRegistry类)注册所有对象实例的格式化文本。

4)根据Spring IOC配置文件格式以及Java对象实例的属性类型，设计并实现节点创造器，并由其定义相应类型节点的写入规则。不同类型的节点创造器根据写入规则生成不同的Spring IOC配置文件节点，并将Java对象实例及其属性写入到Spring IOC配置文件节点中。

在该步骤中，所述的属性类型包括基本类型、对象类型、数组类型以及List、Map和Set等集合类型，分别对应基本类型节点创造器、对象类型节点创造器、数组节点创造器、List节点创造器、Map节点创造器和Set节点创造器。

本实施例通过定义节点创造器接口(EntityNodeCreator)实现基本类型、对象类型、数组类型、List、Map以及Set等不同属性类型的节点创造器，并由各节点创造器维护各属性类型的写入规则，进而不同类型属性节点的创建。

5)设计并实现多文件输出机制。

该步骤可以实现按照用户定义的输出方式将所有节点输出到Spring IOC配置文件；输出方式包括：将不同的对象实例输出到不同的XML文件、互不关联的多个实例输出到同一个XML文件以及一个对象实例输出到不同的XML文件等情况；

本实施例利用FilteredOutput接口的getFilter()方法和getOutputStream()方法绑定指定格式的节点到指定的输出文件。

在上述实施例中，进一步可实现多层次对象属性相互引用的写入机制，该机制包括对象引用类型节点创造器以及对象实例与引用节点的对应关系维护表。通过对象引用类型节点创造器以及对象实例与引用节点间的对应关系实现多层次Java对象的相互引用。

在上述实施例中，进一步可实现Java对象及其属性的遍历算法与编组上下文。所述的编组上下文通过遍历对象实例及相应的属性列表，将其写入到Spring IOC配置文件，参考图3，包括如下步骤：

a)获得并遍历对象实例列表；

b)创建Spring配置文件格式的根节点；该根节点符合Spring配置文件的Schema规范。

c)获得对象实例的格式化文本；

d)分析对象实例类型，根据对象实例类型调用合适的节点创造器；

e)如果实例为对象类型，分析实例的对应节点是否已经创建。如果已经创建，则选择对象引用节点创造器创建相应的对象引用属性；如果没有创建，则选择对象节点创造器创建对应节点，同时遍历对象实例属性列表，进入到步骤d)。

在该步骤中，通过维护所有Java对象实例及其引用节点的对应关系，实现多层次对象的相互引用。在编组过程中，将存在引用节点的对应实例以顶层Bean节点的形式编组到Spring配置文件中，并分配唯一的ID，而其它引用关系则以ref的形式体现在各个属性节点中。

f)如果实例为非对象类型，则选择基本类型节点创造器、数组节点创造器、Set节点创造器、Map节点创造器、List节点创造器等创建对应的节点。

对于数组、Set、Map以及List等类型来说，所述的数组节点创造器、Set节点创造器、Map节点创造器、List节点创造器等会首先创建对应的<array>、<set>、<map>以及<list>节点，然后遍历其元素列表，进入到步骤d)。对于基本类型，节点创造器则直接根据实例对象的值创建节点。所有节点创造器维护各自类型节点的写入规则，进而实现不同类型对象实例值的正确编组。

g)待所有遍历完成后，递归调用节点的writeTo()方法，将本节点写入到父节点(根节点写入到虚拟的父节点)；

h)将所有对象实例以用户设置的输出方式编组到Spring配置文件实例中。该步骤生成的Spring IOC配置文件可以被Spring框架正确解组。

图4为本实施例对应的编组与解组示例图。下面结合图4对本实施例的应用所需要的配置作进一步的说明。具体来说，本实施例表现为一个单独的JAR包，同时依赖于Dom4j的JAR包。在具体应用时，可以将本实施例对应的JAR包以及相应的依赖包导入到对应的企业项目中，按照如下步骤即可完成Java对象实例到Spring配置文件实例的正确编组，生成的Spring配置文件可以被Spring框架正确解组。

1)添加XmlProperty注解，即为需要编组到XML文件的属性添加XmlProperty注解，具体到本例中，即为Database类、Table类以及Field类相应属性的getXXX()方法添加XmlProperty注解；

2)实例化Database对象，并添加到需要编组的对象实例列表中。在本例中，实例化好的Database对象为database；

3)实例化Java对象装载工具与编组工具，即实例化SpringBeans和SpringBeansWriter；

4)设置编组工具的对象格式化方法，此步骤为可选步骤。如果没有需要编组到字符串的Java对象实例，可不设置。

5)设置编组工具的对象输出策略，此步骤为可选步骤。如果不需要实现Java对应实例的多文件输出，则不需要设置。

6)调用编组工具的write方法，输出XML文件。

根据上述步骤，本实施例在具体应用中的核心代码如下所示：

如果需要设置编组工具的对象格式化方法，代码如下所示：

在设置对象实例格式化策略前后，Field对象在XML文件实例中表现形式如下所示：

如果需要设置编组工具的对象输出策略，代码如下所示：

以上所述仅为本发明的较佳实施例，凡根据本发明权利要求所做的同等变化与修改，都应属于本发明的保护范围。