java.util.Date 和 XMLGregorianCalendar 之间的简单转换

Posted 2023-02-26

【中文标题】java.util.Date 和 XMLGregorianCalendar 之间的简单转换

【英文标题】：Simple conversion between java.util.Date and XMLGregorianCalendar

【发布时间】：2011-04-10 09:44:24

【问题描述】：

我正在寻找一种在 java.util.Date 和 javax.xml.datatype.XMLGregorianCalendar 之间双向转换的简单方法。

这是我现在使用的代码：

import java.util.GregorianCalendar;
import javax.xml.datatype.DatatypeConfigurationException;
import javax.xml.datatype.DatatypeFactory;
import javax.xml.datatype.XMLGregorianCalendar;

/**
 * Utility class for converting between XMLGregorianCalendar and java.util.Date
 */
public class XMLGregorianCalendarConverter   

    /**
     * Needed to create XMLGregorianCalendar instances
     */
    private static DatatypeFactory df = null;
    static 
        try 
            df = DatatypeFactory.newInstance();
         catch (DatatypeConfigurationException dce) 
            throw new IllegalStateException(
                "Exception while obtaining DatatypeFactory instance", dce);
        
      

    /**
     * Converts a java.util.Date into an instance of XMLGregorianCalendar
     *
     * @param date Instance of java.util.Date or a null reference
     * @return XMLGregorianCalendar instance whose value is based upon the
     *  value in the date parameter. If the date parameter is null then
     *  this method will simply return null.
     */
    public static XMLGregorianCalendar asXMLGregorianCalendar(java.util.Date date) 
        if (date == null) 
            return null;
         else 
            GregorianCalendar gc = new GregorianCalendar();
            gc.setTimeInMillis(date.getTime());
            return df.newXMLGregorianCalendar(gc);
        
    

    /**
     * Converts an XMLGregorianCalendar to an instance of java.util.Date
     *
     * @param xgc Instance of XMLGregorianCalendar or a null reference
     * @return java.util.Date instance whose value is based upon the
     *  value in the xgc parameter. If the xgc parameter is null then
     *  this method will simply return null.
     */
    public static java.util.Date asDate(XMLGregorianCalendar xgc) 
        if (xgc == null) 
            return null;
         else 
            return xgc.toGregorianCalendar().getTime();
        
    

有什么更简单的吗，比如我忽略的一些 API 调用？

在标准 XML 日期/时间和 Java 日期对象之间进行转换似乎是一项非常常规的任务，我很惊讶我必须编写这段代码。

有什么建议吗？

注意事项： 我的 JAXB 类是从模式自动生成的。我的项目的构建过程不允许我对生成的类进行手动更改。 xs:dateTime 元素由 XJC 作为 JAXB 类中的 XMLGregorianCalendar 生成。架构会定期扩展和调整，因此我可以对架构 XSD 文件进行有限的更改。

解决方案更新： Blaise 提出的解决方案允许我将 XMLGregorianCalendar 排除在外，而是处理 java.util.Calendar 对象。通过在我的模式文件顶部添加 JAXB 绑定子句，XJC 能够为我的 JAXB 类中的 xs:dateTime 生成更合适的映射。以下是一些显示我的 XSD 文件中的修改的 sn-ps。

XSD 文件中的根元素：

<xs:schema xmlns:mydata="http://my.example.com/mydata" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:jaxb="http://java.sun.com/xml/ns/jaxb" targetNamespace="http://my.example.com/mydata" elementFormDefault="unqualified" attributeFormDefault="unqualified" version="0.2" xml:lang="en" jaxb:version="2.0">

JAXB 绑定注释块，在 XSD 中的根元素之后立即插入：

<xs:annotation>
    <xs:appinfo>
        <jaxb:globalBindings>
            <jaxb:javaType name="java.util.Calendar" xmlType="xs:dateTime" parseMethod="javax.xml.bind.DatatypeConverter.parseDateTime" printMethod="javax.xml.bind.DatatypeConverter.printDateTime" />
        </jaxb:globalBindings>
    </xs:appinfo>
</xs:annotation>

由于 XML xs:dateTime 字段还存储时区，因此使用 Calendar 而不是 Date 对我来说可能会更好，因为 Calendar 对象具有用于处理语言环境和时区的非常好的 API。无论如何，我更乐意处理 Calendar 对象而不是 XMLGregorianCalendar。不再需要我上面列出的转换方法。我没有一直到 java.util.Date，但已经足够接近了！

【问题讨论】：

我不知道。但你的似乎很好 - 只需将它放在 util 包中并使用它。

顺便说一句，但为什么您必须首先处理 XMLGregorianCalendar 对象？他们有点烦人。如果它们来自 jaxb，则可以使用 @XMLTypeAdapter 直接绑定到 java.util.Date。当然，如果您是从模式中自动生成，那么在重新生成时更改对象可能同样令人恼火。

@Affe 我正在自动生成模式，因此我无法对生成的 JAXB 类进行任何手动更改

这个和***.com/questions/835889/…一样吗？

@Jacob - 不是。他已经想好怎么做了，他想知道是否没有现成的实用程序类。

【参考方案1】：

为什么不使用外部绑定文件告诉 XJC 生成 java.util.Date 字段而不是 XMLGregorianCalendar？

另见 How do I map xs:date to java.util.Date? Blog

【讨论】：

我会调查的。谢谢。

没问题。 JAXB 可以处理 java.util.Date 类型，您只需要在模型中生成它。这可能很棘手。

这对我有用。有关我所做的详细信息，请参阅上面对我的问题的修改。

我添加了 jaxb 绑定，但在 xs:schema 正下方，我收到以下错误：com.sun.istack.SAXParseException2：编译器无法接受此 globalBindings 自定义。它附加到错误的位置，或者与其他绑定不一致。在 com.sun.tools.xjc.ErrorReceiver.error(ErrorReceiver.java:86) at ..

@pritam - 这是另一个可能有帮助的例子：blog.bdoughan.com/2011/08/xml-schema-to-java-generating.html。对于您所看到的问题，可能值得关注一个新问题。

【参考方案2】：

我必须进行一些更改才能使其正常工作，因为与此同时有些事情似乎发生了变化：

xjc 会抱怨我的适配器没有扩展 XmlAdapter 在 (org.w3._2001.xmlschema) 中绘制了一些奇怪且不需要的导入 显然，在扩展 XmlAdapter 时，解析方法不能是静态的

这是一个工作示例，希望对您有所帮助（我使用的是 JodaTime，但在这种情况下 SimpleDate 就足够了）：

import java.util.Date;
import javax.xml.bind.DatatypeConverter;
import javax.xml.bind.annotation.adapters.XmlAdapter;
import org.joda.time.DateTime;

public class DateAdapter extends XmlAdapter<Object, Object> 
    @Override
    public Object marshal(Object dt) throws Exception 
        return new DateTime((Date) dt).toString("YYYY-MM-dd");
    

    @Override
        public Object unmarshal(Object s) throws Exception 
        return DatatypeConverter.parseDate((String) s).getTime();
    

在xsd中，我遵循了上面给出的优秀参考，所以我包含了这个xml注解：

<xsd:appinfo>
    <jaxb:schemaBindings>
        <jaxb:package name="at.mycomp.xml" />
    </jaxb:schemaBindings>
    <jaxb:globalBindings>
        <jaxb:javaType name="java.util.Date" xmlType="xsd:date"
              parseMethod="at.mycomp.xml.DateAdapter.unmarshal"
          printMethod="at.mycomp.xml.DateAdapter.marshal" />
    </jaxb:globalBindings>
</xsd:appinfo>

【讨论】：

自从我提出这个问题以来，我已经成为 Joda Time 的粉丝。比 Java SE 日期和时间类好得多。处理时区很棒！

【参考方案3】：

我也有这种头痛。 通过在我的 POJO 中简单地将时间字段表示为原始 long 来摆脱它。 现在，我的 WS 客户端代码的生成可以正确处理所有内容，不再有 XML 到 Java 的废话。当然，在 Java 端处理millis 是简单而轻松的。 KISS 原则摇滚！

【参考方案4】：

从 XMLGregorianCalendar 到 java.util.Date 你可以简单地做：

java.util.Date dt = xmlGregorianCalendarInstance.toGregorianCalendar().getTime();  

【讨论】：

谢谢...我正在寻找一种将 XMLGregorianCalendar 转换为毫秒时间的方法。

【参考方案5】：

从 java.util.Date 到 XMLGregorianCalendar 你可以简单地做：

import javax.xml.datatype.XMLGregorianCalendar;
import javax.xml.datatype.DatatypeFactory;
import java.util.GregorianCalendar;
......
GregorianCalendar gcalendar = new GregorianCalendar();
gcalendar.setTime(yourDate);
XMLGregorianCalendar xmlDate = DatatypeFactory.newInstance().newXMLGregorianCalendar(gcalendar);

在@f-puras 的第一条评论之后编辑的代码，因为我做错了。

【讨论】：

不像你写的那样工作：GregorianCalendar.setTime() 不会返回任何东西。

【参考方案6】：

在编组时自定义日历和日期

第 1 步：为自定义属性准备 jaxb 绑定 xml，在这种情况下，我准备了日期和日历

<jaxb:bindings version="2.1" xmlns:jaxb="http://java.sun.com/xml/ns/jaxb"
xmlns:xjc="http://java.sun.com/xml/ns/jaxb/xjc" 
xmlns:xs="http://www.w3.org/2001/XMLSchema">
<jaxb:globalBindings generateElementProperty="false">
<jaxb:serializable uid="1" />
<jaxb:javaType name="java.util.Date" xmlType="xs:date"
    parseMethod="org.apache.cxf.tools.common.DataTypeAdapter.parseDate"
    printMethod="com.stech.jaxb.util.CalendarTypeConverter.printDate" />
<jaxb:javaType name="java.util.Calendar" xmlType="xs:dateTime"
    parseMethod="javax.xml.bind.DatatypeConverter.parseDateTime"
    printMethod="com.stech.jaxb.util.CalendarTypeConverter.printCalendar" />

Setp 2：将自定义 jaxb 绑定文件添加到 Apache 或任何相关插件的 xsd 选项，如下所述

<xsdOption>
  <xsd>$project.basedir/src/main/resources/tutorial/xsd/yourxsdfile.xsd</xsd>
  <packagename>com.tutorial.xml.packagename</packagename>
  <bindingFile>$project.basedir/src/main/resources/xsd/jaxbbindings.xml</bindingFile>
</xsdOption>

Setp 3：为 CalendarConverter 类编写代码

package com.stech.jaxb.util;

import java.text.SimpleDateFormat;

/**
 * To convert the calendar to JaxB customer format.
 * 
 */

public final class CalendarTypeConverter 

    /**
     * Calendar to custom format print to XML.
     * 
     * @param val
     * @return
     */
    public static String printCalendar(java.util.Calendar val) 
        SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy-MM-dd'T'hh:mm:ss");
        return simpleDateFormat.format(val.getTime());
    

    /**
     * Date to custom format print to XML.
     * 
     * @param val
     * @return
     */
    public static String printDate(java.util.Date val) 
        SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy-MM-dd");
        return simpleDateFormat.format(val);
    

Setp 4：输出

  <xmlHeader>
   <creationTime>2014-09-25T07:23:05</creationTime> Calendar class formatted

   <fileDate>2014-09-25</fileDate> - Date class formatted
</xmlHeader>

【参考方案7】：

您可以使用此自定义将默认映射更改为 java.util.Date

<xsd:annotation>
<xsd:appinfo>
    <jaxb:globalBindings>
        <jaxb:javaType name="java.util.Date" xmlType="xsd:dateTime"
                 parseMethod="org.apache.cxf.xjc.runtime.DataTypeAdapter.parseDateTime"
                 printMethod="org.apache.cxf.xjc.runtime.DataTypeAdapter.printDateTime"/>
    </jaxb:globalBindings>
</xsd:appinfo>