CN108255849A - 将JavaBean转换成XML文件的方法、装置及*** - Google Patents

Abstract

本发明提供一种将JavaBean转换成XML文件的方法、装置及***，能够通过对JavaBean增加注解，使用工具类的静态方法实现把类直接转换为XML文件内容，减少了使用JDOM、xStream生成XML的复杂度。该方法包括：使用接口注解类对JavaBean添加转换说明，其中，使用XmlAttribute接口注解类对JavaBean的属性添加转换说明，使用XmlClass接口注解类对JavaBean的类名添加转换说明；获取JavaBean对象，使用转换工具类根据所述转换说明对JavaBean对象执行转换，以得到XML文件。

Description

将JavaBean转换成XML文件的方法、装置及***

技术领域

本发明涉及计算机技术及软件领域，尤其涉及一种将JavaBean转换成XML文件的方法、装置及***。

背景技术

可拓展标记语言XML的全称是eXtensible Markup Language，是一种志标语言，是一种可以展现有关文档结构和数据处理细节的文字编码。XML正在成为现在所有Web服务和大多数SOA(面向服务架构，Service-Oriented Architecture)的基础。目前hadoop集群的配置文件基本都为XML格式，很多配置文件被加入到自动化运维***中进行管理。当数据发生修改后，就需要生成XML格式的文件。

现有技术中将JavaBean对象转XML的文件，通常可以利用JDOM进行实现，JDOM解析读取、修改和生成操作XML的方法API较为丰富，但是JDOM存在一定的缺陷性，即其并不支持将JavaBean对象直接转换为xml方法，当需要把JavaBean对象分装的数据转换为XML文件时，需要通过写复杂的转换进行实现。

此外，还可以使用xStream方便地把JavaBean对象转为XML文件，但是xStream在使用上复杂不够灵活。实现JavaBean对象转XML的文件时，若JavaBean的属性为基本类型，则可以轻松完成转换，但当JavaBean的属性为一个自定义JavaBean类型时，会导致解析JavaBean的方式复杂化，不易于扩展，使得转换不够灵活。

发明内容

有鉴于此，本发明提供一种将JavaBean转换成XML文件的方法、装置及***，能够通过对JavaBean增加注解，使用工具类的静态方法实现把类直接转换为XML文件内容，减少了使用JDOM、xStream生成XML的复杂度。

为实现上述目的，根据本发明的一个方面，提供了一种将JavaBean转换成XML文件的方法。

本发明的一种将JavaBean转换成XML文件的方法包括：使用接口注解类对JavaBean添加转换说明，其中，使用XmlAttribute接口注解类对JavaBean的属性添加转换说明，使用XmlClass接口注解类对JavaBean的类名添加转换说明；获取JavaBean对象，使用转换工具类根据所述转换说明对JavaBean对象执行转换，以得到XML文件。

可选地，所述JavaBean的属性包括JavaBean基本属性和JavaBean复杂属性，所述JavaBean复杂属性是指所述JavaBean的属性中嵌套有其它JavaBean的属性。

可选地，使用接口注解类对JavaBean添加转换说明还包括：使用XmlAttribute接口注解类指定JavaBean的属性在转换为XML文件后，是XML文件节点，或是XML文件节点的属性。

可选地，所述方法还包括：获取JavaBean对象之后，对所述JavaBean对象进行基本校验，以检查所述JavaBean对象的转换说明是否符合转换为XML文件的配置项要求。

可选地，使用转换工具类根据所述转换说明对所述JavaBean对象执行转换还包括：

步骤一：获取JavaBean对象的方法集合；

步骤二：获取JavaBean对象的基本属性和复杂属性；

步骤三：循环处理JavaBean对象的所有基本属性，其中，处理JavaBean对象的基本属性包括：获取JavaBean对象的基本属性的XmlAttribute接口注解类，结合所述JavaBean对象的基本属性对应的方法，对所述JavaBean对象的基本属性进行转换；

步骤四：循环处理JavaBean对象的所有复杂属性，其中，处理JavaBean对象的复杂属性包括：获取JavaBean对象的复杂属性中包含的XmlClass接口注解类，根据所述XmlClass注解接口类，对所述JavaBean对象的复杂属性中嵌套的其他JavaBean的类名进行转换；以及根据JavaBean对象的复杂属性中包含的XmlAttribute接口注解类，对所述JavaBean对象的复杂属性中包含的基本属性进行循环转换处理。

为实现上述目的，根据本发明的另一方面，提供了一种将JavaBean转换成XML文件的装置。

本发明的一种将JavaBean转换成XML文件的装置包括：注解模块，用于使用接口注解类对JavaBean添加转换说明，其中，使用XmlAttribute接口注解类对JavaBean的属性添加转换说明，使用XmlClass接口注解类对JavaBean的类名添加转换说明；转换模块，用于获取JavaBean对象，使用转换工具类根据所述转换说明对JavaBean对象执行转换，以得到XML文件。

可选地，所述JavaBean的属性包括JavaBean基本属性和JavaBean复杂属性，所述JavaBean复杂属性是指所述JavaBean的属性中嵌套有其它JavaBean的属性。

可选地，所述注解模块还用于：使用XmlAttribute接口注解类指定JavaBean的属性在转换为XML文件后，是XML文件节点，或是XML文件节点的属性。

可选地，所述转换模块还用于：获取JavaBean对象之后，对所述JavaBean对象进行基本校验，以检查所述JavaBean对象的转换说明是否符合转换为XML文件的配置项要求。

可选地，所述转换模块还用于实现下列操作：步骤一：获取JavaBean对象的方法集合；步骤二：获取JavaBean对象的基本属性和复杂属性；步骤三：循环处理JavaBean对象的所有基本属性，其中，处理JavaBean对象的基本属性包括：获取JavaBean对象的基本属性的XmlAttribute接口注解类，结合所述JavaBean对象的基本属性对应的方法，对所述JavaBean对象的基本属性进行转换；步骤四：循环处理JavaBean对象的所有复杂属性，其中，处理JavaBean对象的复杂属性包括：获取JavaBean对象的复杂属性中包含的XmlClass接口注解类，根据所述XmlClass注解接口类，对所述JavaBean对象的复杂属性中嵌套的其他JavaBean的类名进行转换；以及根据JavaBean对象的复杂属性中包含的XmlAttribute接口注解类，对所述JavaBean对象的复杂属性中包含的基本属性进行循环转换处理。

为实现上述目的，根据本发明的再一方面，提供了一种将JavaBean转换成XML文件的***。

本发明的一种将JavaBean转换成XML文件的***，其特征在于，包括：存储器和处理器，其中，所述存储器用于存储指令；所述处理器被配置为根据所述指令执行下列动作：使用接口注解类对JavaBean添加转换说明，其中，使用XmlAttribute接口注解类对JavaBean的属性添加转换说明，使用XmlClass接口注解类对JavaBean的类名添加转换说明；获取JavaBean对象，使用转换工具类根据所述转换说明对JavaBean对象执行转换，以得到XML文件。

根据本发明的技术方案，通过利用注解的方式，从而可以只需要对JavaBean加入注解接口轻量级的引用，就可实现JavaBean向XML文件的转换，无需使用第三方架包；并且通过注解的方式，从而可以实现针对JavaBean的基本属性和复杂属性的不同，灵活的进行转换处理；通过灵活配置JavaBean的类名和属性字段，并指定包含的属性字段是生成XML文件节点还是XML文件节点的属性，以及是否需要生成XML文件的节点等信息，从而降低了JavaBean和XML文件的耦合度；通过获取JavaBean对象之后，对所述JavaBean对象进行基本校验，从而可以确保转换的准确性和效率。

附图说明

附图用于更好地理解本发明，不构成对本发明的不当限定。其中：

图1是根据本发明实施例的将JavaBean转换成XML文件的方法的主要步骤的示意图；

图2是根据本发明实施例的将JavaBean转换成XML文件的方法的主要流程的示意图；

图3是根据本发明实施例的将JavaBean转换成XML文件的装置的主要模块的示意图；

图4是根据本发明实施例的将JavaBean转换成XML文件的***的主要部分的示意图。

具体实施方式

以下结合附图对本发明的示范性实施例做出说明，其中包括本发明实施例的各种细节以助于理解，应当将它们认为仅仅是示范性的。因此，本领域普通技术人员应当认识到，可以对这里描述的实施例做出各种改变和修改，而不会背离本发明的范围和精神。同样，为了清楚和简明，以下的描述中省略了对公知功能和结构的描述。

本发明实施例的将JavaBean转换成XML文件的方案，通过对JavaBean的类名和属性增加注解，并使用工具类的静态方法，从而可以实现把类直接转换为XML文件内容，减少了使用JDOM、xStream等方案生成XML的复杂度，实现轻量级的引用。

其中，注解，即Java Meta-annotation，也叫元数据。是一种代码级别的说明。它是JDK1.5及以后版本引入的一个特性，与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面，用来对这些元素进行说明，注释。

具体而言，利用注解实现Java对象转化XML文件，首先需要通过XmlClass接口注解类对要转换的JavaBean的类名加入转换说明，然后通过XmlAttribute接口注解类对JavaBean的属性加入转换说明。即通过注解，对JavaBean的类名和JavaBean的属性在转换后对应XML文件的节点名称的值、节点名称是否显示和转换后JavaBean的属性是XML文件节点或是XML文件节点的属性等信息做了配置说明。最后，通过工具类BeanConvert的beanToXml方法实现JavaBean到XML文件的具体转换。

图1是根据本发明实施例的将JavaBean转换成XML文件的方法的主要步骤的示意图。

如图1所示，本发明实施例的将JavaBean转换成XML文件的方法主要包括如下步骤：

步骤S11：使用接口注解类对JavaBean添加转换说明，其中，使用XmlAttribute接口注解类对JavaBean的属性添加转换说明，使用XmlClass接口注解类对JavaBean的类名添加转换说明。本发明实施例中，JavaBean的属性可以包括JavaBean基本属性和JavaBean复杂属性，其中，JavaBean复杂属性是指属性中嵌套有其它JavaBean的属性。本步骤的目的在于利用注解对JavaBean进行转换说明，从而实现利用轻量级的引用，达到JavaBean向XML文件直接转换的目的。

本发明实施例中，XmlClass接口包含了nodeName属性和display属性2个方法主要是针对JavaBean的类名做转换信息描述。通过JavaBean中使用@XmlClass注解接口类，从而利用nodeName属性指定JavaBean在转为XML文件后的节点名称，display属性指定JavaBean在转为XML文件节点后是否显示此节点。

XmlAttribute接口中包含了nodeName、display和attr的3个方法主要是对JavaBean中的属性做详细的转换描述。通过在JavaBean的属性中使用@XmlAttribute注解接口类，从而可以利用nodeName属性指定JavaBean的属性在转为XML文件后的节点名称，display指定JavaBean的属性在转为XML文件后是否显示此节点，attr指定JavaBean的属性在转为XML文件后是XML节点或是XML文件节点的属性。

其中，使用XmlAttribute接口注解类中的attr方法指定JavaBean的属性在转换为XML文件后，是XML文件节点，或是XML文件节点的属性，是本发明实施例的将JavaBean转换成XML文件的方法较现有技术的另一有益效果。通过对JavaBean的属性的灵活配置，从而实现对JavaBean转换XML映射管理，便于JavaBean与XML文件映射阅读，以灵活的配置方式降低JavaBean与XML文件的耦合度。

在本步骤对JavaBean添加转换说明后，从步骤S12进行转换处理。

步骤S12：获取JavaBean对象，使用转换工具类根据所述转换说明对JavaBean对象执行转换，以得到XML文件。

其中，使用转换工具类根据所述转换说明对所述JavaBean对象执行转换还包括：

步骤一：获取JavaBean对象的方法集合；

步骤二：获取JavaBean对象的基本属性和复杂属性；

步骤三：循环处理JavaBean对象的所有基本属性，其中，处理JavaBean对象的基本属性包括：获取JavaBean对象的基本属性的XmlAttribute接口注解类，结合所述JavaBean对象的基本属性对应的方法，对所述JavaBean对象的基本属性进行转换；

步骤四：循环处理JavaBean对象的所有复杂属性，其中，处理JavaBean对象的复杂属性包括：获取JavaBean对象的复杂属性中包含的XmlClass接口注解类，根据所述XmlClass注解接口类，对所述JavaBean对象的复杂属性中嵌套的其他JavaBean的类名进行转换；以及根据JavaBean对象的复杂属性中包含的XmlAttribute接口注解类，对所述JavaBean对象的复杂属性中包含的基本属性进行循环转换处理。

本发明实施例中，将JavaBean转换成XML文件的方法还可以包括：获取JavaBean对象之后，对所述JavaBean对象进行基本校验，以检查所述JavaBean对象的转换说明是否符合转换为XML文件的配置项要求，从而可以确保转换的准确性和效率。

图2是根据本发明实施例的将JavaBean转换成XML文件的方法的主要流程的示意图。以下结合图2对本发明实施例的将JavaBean转换成XML文件的流程进行详细说明。

如图2所示，本发明实施例中，通过步骤1和2，利用JavaBean的静态方法getInstance()，获取JavaBean的对象实例。通过步骤2中获取的对象实例执行步骤3，调用beanToXml()方法，参数为要转换为XML文件的JavaBean对象。此方法可以实现对数据做基本校验，即检查JavaBean对象的注解是否符合转为XML文件的配置项要求。

若符合配置项要求，则会执行步骤4的objectToXML方法。步骤4执行objectToXML方法中，会调用步骤5的getMethods()，以获取JavaBean对象的方法集合，方法集合的数据会在后面通过反射机制Java Reflect进行调用执行。反射机制Java Reflect是在运行状态中，对于任意一个类，都能够知道这个类的所有属性和方法；对于任意一个对象，都能够调用它的任意一个方法和属性；这种动态获取的信息以及动态调用对象的方法的功能称为Java语言的反射机制。

获取方法集合后，继续执行步骤7的getSimpleField()方法，获取JavaBean的基本类型的属性，即基本属性；然后执行步骤9的getcomplexField()方法，获取JavaBean对象的自定义JavaBean类型的属性，也即复杂属性。

其中，基本属性可以通过@XmlAttribute注解接口类配置的指定标记直接生成XML文件节点。而自定义JavaBean类型的属性需要按照处理对象进行循环处理转化。

在步骤11中，需对基本属性的类型和自定义属性类型进行区分，通过isSimpleField()方法做比对，参数为JavaBean的属性。区分完成后，循环处理所有基本类型的属性，获取基本属性的@XmlAttribute注解接口类配置的接口信息，其中nodeName指定JavaBean的基本属性生成XML节点的名称，attr指定基本类型的属性生成XML文件的节点或是节点的属性，然后通过反射机制调用基本类型的属性的方法，获取此JavaBean基本属性的值，以生成XML文件内容。

继续执行步骤12，循环处理所有自定义JavaBean类型的属性，获取属性中包含的其他JavaBean的@XmlClass接口信息，其中nodeName表示生成XML文件节点的名称，继而循环处理根据步骤8获得中自定义JavaBean类型的属性的基本类型的属性。

处理完所有节点信息后，执行步骤13、14以及15，把所有处理完成的内容信息按照XML文件格式生成XML文件内容字符串予以返回。

根据本发明实施例的将JavaBean转换成XML文件的方法可以看出，通过利用注解的方式，从而可以只需要对JavaBean加入注解接口轻量级的引用，就可实现JavaBean向XML文件的转换，无需使用第三方架包；并且通过注解的方式，从而可以实现针对JavaBean的基本属性和复杂属性的不同，灵活的进行转换处理；通过灵活配置JavaBean的类名和属性字段，并指定包含的属性字段是生成XML文件节点还是XML文件节点的属性，以及是否需要生成XML文件的节点等信息，从而降低了JavaBean和XML文件的耦合度；通过获取JavaBean对象之后，对所述JavaBean对象进行基本校验，从而可以确保转换的准确性和效率。

图3是根据本发明实施例的将JavaBean转换成XML文件的装置的主要模块的示意图。

本发明实施例的一种将JavaBean转换成XML文件的装置30主要包括：注解模块301以及转换模块302，其中，注解模块301用于使用接口注解类对JavaBean添加转换说明，其中，使用XmlAttribute接口注解类对JavaBean的属性添加转换说明，使用XmlClass接口注解类对JavaBean的类名添加转换说明；转换模块302用于获取JavaBean对象，使用转换工具类根据所述转换说明对JavaBean对象执行转换，以得到XML文件。

其中，JavaBean的属性包括JavaBean基本属性和JavaBean复杂属性，JavaBean复杂属性是指所述JavaBean的属性中嵌套有其它JavaBean的属性。

另外，注解模块301还可用于：使用XmlAttribute接口注解类指定JavaBean的属性在转换为XML文件后，是XML文件节点，或是XML文件节点的属性。

转换模块302还可用于：获取JavaBean对象之后，对所述JavaBean对象进行基本校验，以检查所述JavaBean对象的转换说明是否符合转换为XML文件的配置项要求。

此外，转换模块302还可用于实现下列操作：步骤一：获取JavaBean对象的方法集合；步骤二：获取JavaBean对象的基本属性和复杂属性；步骤三：循环处理JavaBean对象的所有基本属性，其中，处理JavaBean对象的基本属性包括：获取JavaBean对象的基本属性的XmlAttribute接口注解类，结合所述JavaBean对象的基本属性对应的方法，对所述JavaBean对象的基本属性进行转换；步骤四：循环处理JavaBean对象的所有复杂属性，其中，处理JavaBean对象的复杂属性包括：获取JavaBean对象的复杂属性中包含的XmlClass接口注解类，根据所述XmlClass注解接口类，对所述JavaBean对象的复杂属性中嵌套的其他JavaBean的类名进行转换；以及根据JavaBean对象的复杂属性中包含的XmlAttribute接口注解类，对所述JavaBean对象的复杂属性中包含的基本属性进行循环转换处理。

图4是根据本发明实施例的将JavaBean转换成XML文件的***的主要部分的示意图。

本发明实施例的一种将JavaBean转换成XML文件的***40包括：存储器401和处理器402，其中，存储器401用于存储指令；处理器402被配置为根据所述指令执行下列动作：使用接口注解类对JavaBean添加转换说明，其中，使用XmlAttribute接口注解类对JavaBean的属性添加转换说明，使用XmlClass接口注解类对JavaBean的类名添加转换说明；获取JavaBean对象，使用转换工具类根据所述转换说明对JavaBean对象执行转换，以得到XML文件。

从以上描述可以看出，通过利用注解的方式，从而可以只需要对JavaBean加入注解接口轻量级的引用，就可实现JavaBean向XML文件的转换，无需使用第三方架包；并且通过注解的方式，从而可以实现针对JavaBean的基本属性和复杂属性的不同，灵活的进行转换处理；通过灵活配置JavaBean的类名和属性字段，并指定包含的属性字段是生成XML文件节点还是XML文件节点的属性，以及是否需要生成XML文件的节点等信息，从而降低了JavaBean和XML文件的耦合度；通过获取JavaBean对象之后，对所述JavaBean对象进行基本校验，从而可以确保转换的准确性和效率。

上述具体实施方式，并不构成对本发明保护范围的限制。本领域技术人员应该明白的是，取决于设计要求和其它因素，可以发生各种各样的修改、组合、子组合和替代。任何在本发明的精神和原则之内所作的修改、等同替换和改进等，均应包含在本发明保护范围之内。

Claims (11)

1.一种将JavaBean转换成XML文件的方法，其特征在于，包括：

使用接口注解类对JavaBean添加转换说明，其中，使用XmlAttribute接口注解类对JavaBean的属性添加转换说明，使用XmlClass接口注解类对JavaBean的类名添加转换说明；

获取JavaBean对象，使用转换工具类根据所述转换说明对JavaBean对象执行转换，以得到XML文件。

2.根据权利要求1所述的方法，其特征在于，所述JavaBean的属性包括JavaBean基本属性和JavaBean复杂属性，所述JavaBean复杂属性是指所述JavaBean的属性中嵌套有其它JavaBean的属性。

3.根据权利要求1所述的方法，其特征在于，使用接口注解类对JavaBean添加转换说明还包括：使用XmlAttribute接口注解类指定JavaBean的属性在转换为XML文件后，是XML文件节点，或是XML文件节点的属性。

4.根据权利要求1所述的方法，其特征在于，所述方法还包括：获取JavaBean对象之后，对所述JavaBean对象进行基本校验，以检查所述JavaBean对象的转换说明是否符合转换为XML文件的配置项要求。

5.根据权利要求2所述的方法，其特征在于，使用转换工具类根据所述转换说明对所述JavaBean对象执行转换还包括：

步骤一：获取JavaBean对象的方法集合；

步骤二：获取JavaBean对象的基本属性和复杂属性；

步骤三：循环处理JavaBean对象的所有基本属性，其中，处理JavaBean对象的基本属性包括：获取JavaBean对象的基本属性的XmlAttribute接口注解类，结合所述JavaBean对象的基本属性对应的方法，对所述JavaBean对象的基本属性进行转换；

步骤四：循环处理JavaBean对象的所有复杂属性，其中，处理JavaBean对象的复杂属性包括：获取JavaBean对象的复杂属性中包含的XmlClass接口注解类，根据所述XmlClass注解接口类，对所述JavaBean对象的复杂属性中嵌套的其他JavaBean的类名进行转换；以及根据JavaBean对象的复杂属性中包含的XmlAttribute接口注解类，对所述JavaBean对象的复杂属性中包含的基本属性进行循环转换处理。

6.一种将JavaBean转换成XML文件的装置，其特征在于，包括：

注解模块，用于使用接口注解类对JavaBean添加转换说明，其中，使用XmlAttribute接口注解类对JavaBean的属性添加转换说明，使用XmlClass接口注解类对JavaBean的类名添加转换说明；

转换模块，用于获取JavaBean对象，使用转换工具类根据所述转换说明对JavaBean对象执行转换，以得到XML文件。

7.根据权利要求6所述的装置，其特征在于，所述JavaBean的属性包括JavaBean基本属性和JavaBean复杂属性，所述JavaBean复杂属性是指所述JavaBean的属性中嵌套有其它JavaBean的属性。

8.根据权利要求6所述的装置，其特征在于，所述注解模块还用于：使用XmlAttribute接口注解类指定JavaBean的属性在转换为XML文件后，是XML文件节点，或是XML文件节点的属性。

9.根据权利要求6所述的装置，其特征在于，所述转换模块还用于：获取JavaBean对象之后，对所述JavaBean对象进行基本校验，以检查所述JavaBean对象的转换说明是否符合转换为XML文件的配置项要求。

10.根据权利要求7所述的装置，其特征在于，所述转换模块还用于实现下列操作：

步骤一：获取JavaBean对象的方法集合；

步骤二：获取JavaBean对象的基本属性和复杂属性；

步骤三：循环处理JavaBean对象的所有基本属性，其中，处理JavaBean对象的基本属性包括：获取JavaBean对象的基本属性的XmlAttribute接口注解类，结合所述JavaBean对象的基本属性对应的方法，对所述JavaBean对象的基本属性进行转换；

步骤四：循环处理JavaBean对象的所有复杂属性，其中，处理JavaBean对象的复杂属性包括：获取JavaBean对象的复杂属性中包含的XmlClass接口注解类，根据所述XmlClass注解接口类，对所述JavaBean对象的复杂属性中嵌套的其他JavaBean的类名进行转换；以及根据JavaBean对象的复杂属性中包含的XmlAttribute接口注解类，对所述JavaBean对象的复杂属性中包含的基本属性进行循环转换处理。

11.一种将JavaBean转换成XML文件的***，其特征在于，包括：存储器和处理器，其中，

所述存储器用于存储指令；

所述处理器被配置为根据所述指令执行下列动作：

使用接口注解类对JavaBean添加转换说明，其中，使用XmlAttribute接口注解类对JavaBean的属性添加转换说明，使用XmlClass接口注解类对JavaBean的类名添加转换说明；

获取JavaBean对象，使用转换工具类根据所述转换说明对JavaBean对象执行转换，以得到XML文件。