如何使JAXB插件使用OffsetDateTime

Question

我们有一个带有xs:dateTime字段的XSD。这是我们内部内部API，我们可以保证始终包含偏移数据，以便它是ISO-8601兼容。例如：

2016-01-01T00：00：00.000 01：00

当前，JAXB2插件将xs:dateTime映射到XMLGregorianCalendar类型的字段。如何配置插件，以便使用OffsetDateTime？

我不在乎该解决方案是针对maven-jaxb2-plugin，jaxb2-maven-plugin还是cxf-codegen-plugin，我们将使用任何有效的方法。

Answer 1

您可以将jaxb2-maven-plugin与jaxb-bindings文件一起使用。

首先，我创建了一个odt.xsd文件：

<?xml version="1.0" encoding="UTF-8"?>
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <xsd:element name="teste" type="Teste" />
  <xsd:complexType name="Teste">
    <xsd:sequence>
      <xsd:element name="date" type="xsd:dateTime" minOccurs="1"
        maxOccurs="1" nillable="false"/>
    </xsd:sequence>
  </xsd:complexType>
</xsd:schema>

然后，我创建了一个jaxb-bindings.xjb文件，该文件定义了date字段的类型，以及从中转换和转换的类：

<jaxb:bindings xmlns:jaxb="http://java.sun.com/xml/ns/jaxb" xmlns:xsd="http://www.w3.org/2001/XMLSchema" jaxb:version="2.0">
    <jaxb:bindings schemaLocation="odt.xsd">
        <jaxb:bindings node="//xsd:element[@name='date']">
            <jaxb:javaType name="java.time.OffsetDateTime"
             parseMethod="xsd.test.OffsetDateTimeAdapter.parse"
             printMethod="xsd.test.OffsetDateTimeAdapter.print" />
        </jaxb:bindings>
        <jaxb:schemaBindings>
            <jaxb:package name="xsd.test" />
        </jaxb:schemaBindings>
    </jaxb:bindings>
</jaxb:bindings>

此文件引用了xsd.test.OffsetDateTimeAdapter类和将OffsetDateTime转换为String的相应方法，因此我还创建了它：

package xsd.test;
import java.time.OffsetDateTime;
public class OffsetDateTimeAdapter {
    public static OffsetDateTime parse(String value) {
        return OffsetDateTime.parse(value);
    }
    public static String print(OffsetDateTime value) {
        return value.toString();
    }
}

然后，在pom.xml中，我添加了插件的配置：

<plugin>
    <groupId>org.codehaus.mojo</groupId>
    <artifactId>jaxb2-maven-plugin</artifactId>
    <executions>
        <execution>
            <id>xjc</id>
            <goals>
                <goal>xjc</goal>
            </goals>
        </execution>
    </executions>
    <configuration>
        <!-- The package of your generated sources -->
        <packageName>xsd.test</packageName>
        <sources>
            <source>src/main/resources/odt.xsd</source>
        </sources>
        <xjbSources>
            <xjbSource>src/main/resources/jaxb-bindings.xjb</xjbSource>
        </xjbSources>
    </configuration>
</plugin>

这样，我刚刚用mvn clean package构建了该项目，而创建的JAR包含xsd.test软件包中的生成文件。Teste类包含date字段作为OffsetDateTime：

@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "Teste", propOrder = {
    "date"
})
public class Teste {
    @XmlElement(required = true, type = String.class)
    @XmlJavaTypeAdapter(Adapter1 .class)
    @XmlSchemaType(name = "dateTime")
    protected OffsetDateTime date;
    // getter and setter
}

这样，使用自动化的Adapter1（内部使用上面创建的xsd.test.OffsetDateTimeAdapter类），将date字段映射到OffsetDateTime。从XML解析日期的示例：

ObjectFactory f = new ObjectFactory();
JAXBContext context = JAXBContext.newInstance("xsd.test");
Unmarshaller unmarshaller = context.createUnmarshaller();
String xml = "<?xml version="1.0" encoding="UTF-8" standalone="yes"?><ns2:teste xmlns:ns2="xsd.test"><date>2016-01-01T00:00+01:00</date></ns2:teste>";
JAXBElement<Teste> jaxElement = unmarshaller.unmarshal(new StreamSource(new ByteArrayInputStream(xml.getBytes())), Teste.class);
OffsetDateTime odt = jaxElement.getValue().getDate();
System.out.println(odt); // 2016-01-01T00:00+01:00

以及将日期编组为XML时，OffsetDateTime直接转换为String，例如2016-01-01T00:00+01:00。

---

另一种方法是使用命令行xjc，它随附JDK：

xjc src/main/resources/odt.xsd -d src/main/java/ -p xsd.test -b src/main/resources/jaxb-bindings.xjb

这将在src/main/java目录中生成类，在xsd.test软件包中。

Answer 2

jtexttime库解决此问题。

库围绕JDK8 OffsetXXX日期/时间类别旋转，因为这些是XML模式类型date，dateTime和time的（唯一）自然当量。它还处理XML类型和JSR-310类型之间的差异，因为不幸的是没有一对一的匹配。

这样使用：

添加依赖关系：

<dependency>
    <groupId>com.addicticks.oss</groupId>
    <artifactId>jtexttime</artifactId>
    <version> ... latest ...</version>
</dependency>

创建XJC绑定：

创建一个名为 src/main/xjb/jaxb-datetime-bindings.xjb的文件，其内容如下。如果您使用的是JAXB2 Maven插件，则该插件将自动拾取。如果您使用的是另一个Maven插件，则必须告诉它在哪里可以找到此文件。

<?xml version="1.0" encoding="UTF-8"?>
    <!-- This file is automatically picked up by the jaxb2-maven-plugin
         if it lives in src/main/xjb                                -->
<jxb:bindings   
        xmlns:jxb="http://java.sun.com/xml/ns/jaxb" 
        xmlns:xs="http://www.w3.org/2001/XMLSchema"
        xmlns:xjc="http://java.sun.com/xml/ns/jaxb/xjc"
        xmlns:xsi="http://www.w3.org/2001/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">
    <jxb:globalBindings>
        <!-- Avoid having to work with XMLGregorianCalendar. 
             Instead, map as follows:
                 XML dateTime   :   OffsetDateTime  
                 XML date       :   OffsetDateTime  (time value truncated)
                 XML time       :   OffsetTime                             -->
        <xjc:javaType adapter="com.addicticks.texttime.jaxb.OffsetDateTimeXmlAdapter"
                      name="java.time.OffsetDateTime" xmlType="xs:dateTime"/>
        <xjc:javaType adapter="com.addicticks.texttime.jaxb.OffsetDateXmlAdapter"
                      name="java.time.OffsetDateTime" xmlType="xs:date"/>
        <xjc:javaType adapter="com.addicticks.texttime.jaxb.OffsetTimeXmlAdapter"
                      name="java.time.OffsetTime" xmlType="xs:time"/>
    </jxb:globalBindings>
</jxb:bindings>

jaxb2 maven插件默认拾取src/main/xjb/文件夹中的所有.xjb文件，因此您无需在插件的配置中指定上述文件。

项目的读数有更多有关如何使用库的信息。