jaxb注解使用_使用JAXB的简介

jaxb注解使用

我正在将一些依赖于Apache XMLBeans的模块迁移到JAXB。这是令人兴奋和充满挑战的几天。我想记下我遇到的一些重要事情，以供将来可能会发现有用的任何人使用。

首先，让我们来看一下设置用于JAXB代码生成的maven插件。在撰写本文时，我遇到了两个Maven插件。

http://www.mojohaus.org/jaxb2-maven-plugin/Documentation/v2.2/index.html
https://github.com/highsource/maven-jaxb2-plugin

最后使用第一个，因为我发现配置非常简单。

您的Maven项目结构如下：

项目文件夹-> src-> main-> xsd

这将保存您要从中生成JAXB对象的所有XSD文件。

项目文件夹-> src-> main-> xjb

这将保存您的“ bindings.xml”文件，该文件是您的数据绑定文件，用于运行JAX生成任务（xjc）时需要进行的任何自定义。

maven的插件配置如下所示；

<plugin><groupId>org.codehaus.mojo</groupId><artifactId>jaxb2-maven-plugin</artifactId><version>2.2</version><executions><execution><id>xjc</id><goals><goal>xjc</goal></goals></execution></executions><configuration><target>2.1</target><sources><source>src/main/xsd</source></sources></configuration></plugin>

与XMLBeans一起使用的一件事是所有可选元素的“ isSet”类型的方法，这些方法将检查是否设置了该元素。默认情况下，JAXB不会生成此方法，因此您必须在每个元素上使用not null条件。幸运的是，绑定配置允许以下操作：

<jxb:bindings xmlns:xs="http://www.w3.org/2001/XMLSchema"xmlns:jxb="http://java.sun.com/xml/ns/jaxb"xmlns:xjc="http://java.sun.com/xml/ns/jaxb/xjc"jxb:extensionBindingPrefixes="xjc"version="2.1">
<jxb:globalBindings  generateIsSetMethod="true"
</jxb:globalBindings>
</jxb:bindings>

默认情况下，JAXB不会为XSD文件上定义的枚举生成Java枚举。可悲的是，我找不到在全球范围内应用这一代的方法，只能按XSD处理它。但是对于XMLBeans，这是自动完成的。为了生成Java枚举，应执行以下操作：

样本XSD：

<xs:complexType name="EndpointType"><xs:attribute name="protocol"><xs:simpleType><xs:restriction base="xs:string"><xs:enumeration value="HTTP"/><xs:enumeration value="HTTPS"/><xs:enumeration value="PAYLOAD"/></xs:restriction></xs:simpleType></xs:attribute></xs:complexType>

JAXB绑定：

<jxb:bindings xmlns:xs="http://www.w3.org/2001/XMLSchema"xmlns:jxb="http://java.sun.com/xml/ns/jaxb"xmlns:xjc="http://java.sun.com/xml/ns/jaxb/xjc"jxb:extensionBindingPrefixes="xjc"version="2.1">
<jxb:bindings schemaLocation="../xsd/testconfig.xsd"><jxb:bindings node="//xs:complexType[@name='EndpointType']/xs:attribute[@name='protocol']/xs:simpleType"><jxb:typesafeEnumClass name="Protocol" /></jxb:bindings></jxb:bindings>
</jxb:bindings>

schemaLocation –这是我要引用的XSD的相对路径。由于我的“ bindings.xml”位于“ xjb”目录中，因此我不得不向上移动一步，进入XSD目录以获取所需的XSD文件。

节点 –在这里，您需要提供定义了枚举的简单类型的xquery路径。如果将其与提供的XSD进行交叉检查，您将了解XQuery路径如何检索给定元素。

注意：无论如何，如果您的xpath返回多个具有相同名称的元素，您仍然可以通过在<jxb：bindings>元素上引入元素multiple =” true”来处理此问题。

例如：<jxb：bindings node =” // xs：complexType [@ name ='EndpointType'] / xs：attribute [@ name ='protocol'] / xs：simpleType”
多个=“ true” >

typesafeEnumClass –在此元素上，您可以提供要生成的Java枚举名称。

默认情况下，XMLBeans将所有XSD日期和日期时间元素转换为Java Calendar对象。但是，对于JAXB，默认情况下使用XMLGregorianCalendar 。全局绑定再次得以解决，并通过以下配置处理了该配置，该配置将所有XSD日期元素转换为Java Calendar对象。

<jxb:bindings xmlns:xs="http://www.w3.org/2001/XMLSchema"xmlns:jxb="http://java.sun.com/xml/ns/jaxb"xmlns:xjc="http://java.sun.com/xml/ns/jaxb/xjc"jxb:extensionBindingPrefixes="xjc"version="2.1"><jxb:globalBindings><jxb:javaType name="java.util.Calendar" xmlType="xs:dateTime"parseMethod="javax.xml.bind.DatatypeConverter.parseDateTime"printMethod="javax.xml.bind.DatatypeConverter.printDateTime"/><jxb:javaType name="java.util.Calendar" xmlType="xs:date"parseMethod="javax.xml.bind.DatatypeConverter.parseDate"printMethod="javax.xml.bind.DatatypeConverter.printDate"/><jxb:javaType name="java.util.Calendar" xmlType="xs:time"parseMethod="javax.xml.bind.DatatypeConverter.parseTime"printMethod="javax.xml.bind.DatatypeConverter.printTime"/></jxb:globalBindings></jxb:bindings>

如果需要使您的JAXB对象可序列化，则可以使用以下全局绑定配置来实现；

<jxb:bindings xmlns:xs="http://www.w3.org/2001/XMLSchema"xmlns:jxb="http://java.sun.com/xml/ns/jaxb"xmlns:xjc="http://java.sun.com/xml/ns/jaxb/xjc"jxb:extensionBindingPrefixes="xjc"version="2.1"><jxb:globalBindings ><xjc:serializable /></jxb:globalBindings></jxb:bindings>

达到目的的元素是“ <xjc：serializable />”元素。

在JDK 1.8中，我遇到了一个问题，即如果您的XSD中有一个导入了另一个模式以通过HTTP检索另一个XSD，则该问题被阻止了。抛出错误的摘录是“因为由于accessExternalDTD属性设置的限制而不允许'http'访问” 。在这种情况下，解决方法是使用以下maven插件来设置绕过此限制所需的VM参数。有关此问题的更多信息，请参见此处。

<plugin><!-- We use this plugin to ensure that our usage of themaven-jaxb2-plugin is JDK 8 compatible in absence of a fixfor https://java.net/jira/browse/MAVEN_JAXB2_PLUGIN-80. --><groupId>org.codehaus.mojo</groupId><artifactId>properties-maven-plugin</artifactId><version>1.0.0</version><executions><execution><id>set-additional-system-properties</id><goals><goal>set-system-properties</goal></goals></execution></executions><configuration><properties><property><name>javax.xml.accessExternalSchema</name><value>file,http</value></property><property><name>javax.xml.accessExternalDTD</name><value>file,http</value></property></properties></configuration>
</plugin>

就是这样。我会继续更新这篇文章。与往常一样，您对此的反馈总是非常感激。

谢谢您的阅读，祝大家有美好的一天。