自定义您的JAXB绑定

最新推荐文章于 2021-03-15 22:16:54 发布

dlz00001

最新推荐文章于 2021-03-15 22:16:54 发布

阅读量487

点赞数

文章标签： java linux python spring maven

JAXB是Java与XML世界之间的桥梁，使您的代码可以透明地编组和解组Java对象与XML之间的关系。为此，您应该有一个代表XML-Schema的类。此类由xjc创建。在大多数情况下，xjc创建的类无法满足您的需求。在本文中，我们将看到这样做的原因以及如何自定义此行为。

先决条件

本文假设您使用Java开发工具包6.0。请注意，同一JDK 6的不同更新使用不同的JAXB版本：

更新资料	JAXB版本
3	2.0.3
4	2.1.3

更新资料

JAXB版本

2.0.3

2.1.3

并发技术

在进入JAXB之前，应该问自己是否需要使用JAXB。有很多框架的目标是在Java对象与XML之间进行序列化/反序列化：

从历史上讲（从我的卑鄙知识）， Castor XML是第一个被广泛使用的框架来管理Java XML序列化。
从Java 1.4开始，提供了两个类XMLEncoder和XMLDecoder 。它们分别等效于ObjectOutputStream和ObjectInputStream，仅它们产生XML而不是字节。
最后， XStream是一个运行速度快且易于使用的第三方框架。

所有这些解决方案在读取/生成XML方面都非常出色，但是它们完全忽略了绑定部分。绑定是根据模式创建Java类。当然，JAXB具有此功能。

西江

xjc是用于从XML模式创建Java类的可执行文件。可用语法为DTD，XML-Schema，RELAX NG，RELAX NG Compact和WSDL。由于我现在仅使用Maven来构建项目，因此我不会直接使用xjc，而是将Maven POM配置为使用它。首先要做的是将java.net存储库添加到您的POM（或您的设置文件，但我更喜欢前者）：

<repositories>
    <repository>
        <id> maven2-repository.dev.java.net </id>
        <name> Java.net Maven 2 Repository </name>
        <url> http://download.java.net/maven/2 </url>
    </repository>
</repositories>
<pluginRepositories>
    <pluginRepository>
        <id> maven2-repository.dev.java.net </id>
        <name> Java.net Maven 2 Repository </name>
        <url> http://download.java.net/maven/2 </url>
    </pluginRepository>
</pluginRepositories>

现在，您可以使用插件了：

<build>
    <plugins>
        <plugin>
            <groupId> org.jvnet.jaxb2.maven2 </groupId>
            <artifactId> maven-jaxb2-plugin </artifactId>
            <version> 0.7.1 </version>
            <configuration> ... </configuration>
        </plugin>
    </plugins>
</build>

通过以下命令行使用插件： mvn org.jvnet.jaxb2.maven2:maven-jaxb2-plugin:generate 。

通用配置

由于我们尚未指定任何配置，因此上一个命令行将失败。应该假定以下是一个很好的默认值：

<configuration>
    <schemaDirectory> src/main/resources/schema </schemaDirectory>
    <generateDirectory> src/main/generated </generateDirectory>
    <removeOldOutput> false </removeOldOutput>
</configuration>

这告诉XJC寻找所有xsd下文件src/main/schema目录下生成类src/main/generated 。它将使用前一个目录下的绑定文件（ *.xjb ）。

我真诚地建议您将removeOldOutput设置为false因为xjc会擦除所有目录内容。如果使用源代码管理工具，这将包括SCM使用的目录（ .cvs或.svn ），这是一个非常糟糕的主意。

您仍然需要两件事。首先是将编译器级别设置为至少1.5，以使注释起作用：

<plugin>
    <artifactId> maven-compiler-plugin </artifactId>
    <configuration>
        <source> 1.6 </source>
        <target> 1.6 </target>
    </configuration>
</plugin>

Maven仅接受一个源目录。第二件事是在构建项目时将src / main / generated目录创建到Maven。可以在builder插件的帮助下完成：

<plugin>
    <groupId> org.codehaus.mojo </groupId>
    <artifactId> build-helper-maven-plugin </artifactId>
    <executions>
        <execution>
            <id> add-source </id>
            <phase> generate-sources </phase>
            <goals>
                <goal> add-source </goal>
            </goals>
            <configuration>
                <sources>
                    <source> src/main/generated </source>
                </sources>
            </configuration>
        </execution>
    </executions>
</plugin>

现在，使用前一个命令行将产生一些有用的信息！试试看，您会得到一些惊喜。

客制化

为了自定义绑定，您基本上有2个选择：

用外部名称空间污染您的XML模式，
或保持XML模式纯净，并将所有绑定放入外部文件中。

从我使用的术语来看，您可能会猜到我更喜欢选项2。这是使用绑定文件的正确时机。在src/main/resources/schema下创建一个名为binding.xjb的文件。

包裹名字

当然，包名称不是理想的：默认情况下，它是XML-Schema命名空间减去http://加_package 。第一个定制是更改此行为。将以下内容放入绑定文件中：

<?xml version="1.0" encoding="UTF-8"?>
<bindingsxmlns="http://java.sun.com/xml/ns/jaxb"
                xmlns:xsi="http://www.w3.org/2000/10/XMLSchema-instance"
                xsi:schemaLocation="http://java.sun.com/xml/ns/jaxb http://java.sun.com/xml/ns/jaxb/bindingschema_2_0.xsd"
    version="2.1">
    <schemaBindings>
        <packagename="ch.frankel.blog.jaxb"/>
    </schemaBindings>
</bindings>

如果出现以下错误，则应使用JDK 6中的更新14：

`java.lang.LinkageError：正在从引导程序类加载器加载JAXB 2.0 API，但是此RI（从jar：file：/ C：/ $ {user.home} /。m2 / repository / com / sun / xml / bind /jaxb-impl/2.1.10/jaxb-impl-2.1.10.jar!/com/sun/xml/bind/v2/model/impl/ModelBuilder.class）需要2.1 API。使用认可的目录机制将jaxb-api.jar放在引导类加载器中。

— http://java.sun.com/j2se/1.5.0/docs/guide/standards/

如果不是这样，很可能您的班级将在适当的包名称下生成。

可序列化

管理实体可能需要您将其序列化。为了实现这一点，您必须修改绑定文件，以将java.io.Serializable接口与serialVersionUID一起添加到您的类中。现在，每个生成的类都将可序列化并具有指定的uid：此过程的局限性在于，每个生成的类将具有相同的uid。

<?xml version="1.0" encoding="UTF-8"?>
<bindingsxmlns="http://java.sun.com/xml/ns/jaxb"
                xmlns:xsi="http://www.w3.org/2000/10/XMLSchema-instance"
                xmlns:xjc="http://java.sun.com/xml/ns/jaxb/xjc"
                xsi:schemaLocation="http://java.sun.com/xml/ns/jaxb http://java.sun.com/xml/ns/jaxb/bindingschema_2_0.xsd"
    version="2.1">
    <schemaBindings>
        <packagename="ch.frankel.blog.jaxb"/>
    </schemaBindings>
    <globalBindings>
        <serializableuid="100"/>
     </globalBindings>
</bindings>

超类

有时，所有绑定的类都继承自一个公共类（在XSD中未描述）是有益的。如果此超类完全是出于技术目的（例如强类型化），并且不应使模式混乱，则可能会发生这种情况。

为此，必须执行两个操作：

为xjc编译器启用扩展模式。只需在POM中的配置下添加<extension>true</extension>
在http://java.sun.com/xml/ns/jaxb/xjc命名空间中使用superClass标记

此类不会由xjc生成，因此您可以随意创建（抽象，添加方法等）。

<?xml version="1.0" encoding="UTF-8"?>
<bindingsxmlns="http://java.sun.com/xml/ns/jaxb"
                xmlns:xsi="http://www.w3.org/2000/10/XMLSchema-instance"
                xmlns:xjc="http://java.sun.com/xml/ns/jaxb/xjc"
                xsi:schemaLocation="http://java.sun.com/xml/ns/jaxb http://java.sun.com/xml/ns/jaxb/bindingschema_2_0.xsd"
    version="2.1">
    <schemaBindings>
        <packagename="ch.frankel.blog.jaxb"/>
    </schemaBindings>
    <globalBindings>
        <serializableuid="100"/>
        <xjc:superClassname="ch.frankel.blog.jaxb.XmlSuperClass"/>
    </globalBindings>
</bindings>

数据类型

默认情况下，xjc会将架构绑定到可用的最精确的数据类型。例如，XML-Schema date类型将绑定到Java javax.xml.datatype.XMLGregorianCalendar 。这样做的缺点是将绑定的类耦合到JAXB API，并迫使您使用不需要的类。出于示例目的，检查如何将java.sql.Date从数据库转换为您的实体javax.xml.datatype.XMLGregorianCalendar ：玩得开心！

为了简化您的开发，您可以在绑定适配器和编组/解组适配器之间进行提供，这些适配器旨在与XML进行传递。在绑定文件中这样声明：

<?xml version="1.0" encoding="UTF-8"?>
<bindingsxmlns="http://java.sun.com/xml/ns/jaxb"
                xmlns:xsi="http://www.w3.org/2000/10/XMLSchema-instance"
                xmlns:xs="http://www.w3.org/2001/XMLSchema"
                xmlns:xjc="http://java.sun.com/xml/ns/jaxb/xjc"
                xsi:schemaLocation="http://java.sun.com/xml/ns/jaxb http://java.sun.com/xml/ns/jaxb/bindingschema_2_0.xsd
                                    http://www.w3.org/2001/XMLSchema http://www.w3.org/2001/XMLSchema.xsd"
    version="2.1">
    <bindingsschemaLocation="schema.xsd">
        <schemaBindings>
            <packagename="ch.frankel.blog.jaxb"/>
        </schemaBindings>
        <globalBindings>
            <javaTypename="java.util.Date"xmlType="xs:date"
                parseMethod="ch.frankel.blog.jaxb.JaxbConverter.parseDate"
                printMethod="ch.frankel.blog.jaxb.JaxbConverter.printDate"/>
            <serializableuid="100"/>
            <xjc:superClassname="ch.frankel.blog.jaxb.AbstractSuperClass"/>
        </globalBindings>
    </bindings>
</bindings>

注意，您还有另一个要管理的名称空间。这将在编组/解组过程中必须使用的org.w3._2001.xmlschema包下生成一个适配器类。

调整输出

XML-Schema不会提供您在Java中所需的所有信息。怎样用equals()补偿对象呢？

并非您将使用的每个架构都是由您或您的团队设计的。有些将成为遗产，有些将成为标准......这并不意味着您应该因他人缺乏良好实践而遭受痛苦。如果架构使用大写标签怎么办？当然，您希望生成的类遵循Sun编码约定。

Sun JAXB团队为XJC编译器提供了解决上述问题的插件。看看他们。

对于我们的示例，我们选择将hashCode() ， equals()和toString()方法添加到生成的类中。有一个插件可以做到这一点。您只需要在POM中配置这一代，将所需的参数添加到编译器，并添加管理这些参数所需的插件：

<configuration>
...
    <args>
        <arg> -XtoString </arg>
        <arg> -Xequals </arg>
        <arg> -XhashCode </arg>
    </args>
    <plugins>
        <plugin>
            <groupId> org.jvnet.jaxb2_commons </groupId>
            <artifactId> jaxb2-basics </artifactId>
            <version> 0.5.0 </version>
        </plugin>
     </plugins>
</configuration>

在这种特定情况下，由于生成的类将依赖于它们，因此您必须向POM添加两个依赖（Common Lang和JAXB Basics运行时）。

<dependencies>
...
    <dependency>
        <groupId> commons-lang </groupId>
        <artifactId> commons-lang </artifactId>
        <version> 2.4 </version>
    </dependency>
    <dependency>
        <groupId> org.jvnet.jaxb2_commons </groupId>
        <artifactId> jaxb2-basics-runtime </artifactId>
        <version> 0.5.0 </version>
    </dependency>
</dependencies>