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

时间:2014-07-16 22:40:15

标签: java xml serialization jodatime simple-framework

如何为org.simpleframework.xml图书馆构建转换器?

我正在使用Simple XML Serialization library中的SimpleFramework.orgorg.simpleframework.xml包)。

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

我知道它与TransformMatcher有关。在MythTV-Service-API项目中,我发现了TransformMatcher的实现。但我还没决定如何把它放在一起。

1 个答案:

答案 0 :(得分:2)

您可以选择两种方法,如此类似问题Serialization third-party classes with Simple XML (org.simpleframework.xml)中所讨论的那样:

  • 转换器
  • 变换

我不知道每个人的利弊。但我确实知道如何实现Transform方法。为此,请继续阅读。

转换方法

需要三件:

  1. Transform interface
  2. 的实施
  3. Matcher interface
  4. 的实施
  5. 一个RegistryMatcher实例,其中Transform实现映射到它处理的数据类型。
  6. 所有这三个都是transform package的一部分。

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

    转换实施

    您的转换实现可能如下所示。

    这里的实现过于简单化。它假定您希望输出是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类型的序列化程序。