将 Joda-Time `DateTime` 对象转换为 `org.simpleframework.xml` 中的字符串（“简单 XML 序列化”库）

Question

如何为org.simpleframework.xml 库构建转换器？

我正在使用来自SimpleFramework.org 的Simple XML Serialization library（org.simpleframework.xml 包）。

我希望将Joda-Time DateTime 对象序列化为ISO 8601 字符串，例如2014-07-16T00:20:36Z。重构 Java 对象后，我希望从该字符串构造一个 DateTime。 documentation 并没有真正解释如何构建转换器。

我知道这与Transform 和Matcher 有关。在MythTV-Service-API 项目中，我找到了Transform 和Matcher 的实现。但我还没有确定如何组合。

Answer 1

您可以在两种方法之间进行选择，如类似问题Serialization third-party classes with Simple XML (org.simpleframework.xml) 中所述：

• 转换器
• 变换

我不知道每个比较的优缺点。但我确实知道如何实现 Transform 方法。为此，请继续阅读。

变换方法

需要三件：

1. Transform interface 的实现。
2. Matcher interface 的实现。
3. 一个 RegistryMatcher 实例，其中 Transform 实现映射到它处理的数据类型。

所有这三个都是transform package 的一部分。

我建议将您的实现放在项目中的“转换器”包中。

转换实现

您的 Transform 实现可能如下所示。

这里的实现很简单。它假定您希望输出是由 DateTime 的 toString 方法生成的默认 ISO 8601 字符串。它假定每个文本输入都与DateTime 构造函数中的默认解析器兼容。要处理其他格式，定义一堆DateTimeFormatter 实例，对每个实例依次调用parseDateTime 方法，直到格式化程序成功而不抛出IllegalArgumentException。另一件要考虑的事情是时区；您可能希望将时区强制为 UTC 或类似的。

package com.your.package.converters.simplexml;

import org.joda.time.DateTime;
import org.simpleframework.xml.transform.Transform;
import org.slf4j.LoggerFactory;

/**
 *
 * © 2014 Basil Bourque. This source code may be used freely forever by anyone taking full responsibility for such usage and its consequences.
 */
public class JodaTimeDateTimeTransform implements Transform<DateTime>
{
    //static final org.slf4j.Logger logger = LoggerFactory.getLogger( JodaTimeDateTimeTransform.class );

    @Override
    public DateTime read ( String input ) throws Exception
    {
        DateTime dateTime = null;
        try {
            dateTime = new DateTime( input );  // Keeping whatever offset is included. Not forcing to UTC.
        } catch ( Exception e ) {
            //logger.debug( "Joda-Time DateTime Transform failed. Exception: " + e );
        }
        return dateTime;
    }

    @Override
    public String write ( DateTime dateTime ) throws Exception
    {
        String output = dateTime.toString();  // Keeping whatever offset is included. Not forcing to UTC.
        return output;
    }

}

匹配器实现

Matcher 实现快速简单。

 package com.your.package.converters.simplexml;

import org.simpleframework.xml.transform.Transform;
import org.simpleframework.xml.transform.Matcher;

/**
 *
 * © 2014 Basil Bourque. This source code may be used freely forever by anyone taking full responsibility for such usage and its consequences.
 */
public class JodaTimeDateTimeMatcher implements Matcher
{
    @Override
    public Transform match ( Class classType ) throws Exception
    {
        // Is DateTime a superclass (or same class) the classType?
        if ( org.joda.time.DateTime.class.isAssignableFrom( classType ) ) {
            return new JodaTimeDateTimeTransform();
        }
        return null;
    }
}

注册表

将这些付诸实施意味着使用注册表。

RegistryMatcher matchers = new RegistryMatcher();
matchers.bind( org.joda.time.DateTime.class , JodaTimeDateTimeTransform.class );
// You could add other data-type handlers, such as the "YearMonth" class in Joda-Time.
//matchers.bind( org.joda.time.YearMonth.class , JodaTimeYearMonthTransform.class );

Strategy strategy = new AnnotationStrategy();
Serializer serializer = new Persister( strategy , matchers );

然后以通常的方式继续使用理解 Joda-Time 类型的序列化程序。