如何将 TimeSpan 序列化为 XML

Question

我正在尝试将 .NET TimeSpan 对象序列化为 XML，但它不起作用。 快速谷歌搜索后发现，虽然 TimeSpan 是可序列化的，但 XmlCustomFormatter 不提供将 TimeSpan 对象与 XML 相互转换的方法。

一种建议的方法是忽略 TimeSpan 进行序列化，而是序列化 TimeSpan.Ticks 的结果（并使用 new TimeSpan(ticks) 进行序列化）反序列化）。 一个例子如下：

[Serializable]
public class MyClass
{
    // Local Variable
    private TimeSpan m_TimeSinceLastEvent;

    // Public Property - XmlIgnore as it doesn't serialize anyway
    [XmlIgnore]
    public TimeSpan TimeSinceLastEvent
    {
        get { return m_TimeSinceLastEvent; }
        set { m_TimeSinceLastEvent = value; }
    }

    // Pretend property for serialization
    [XmlElement("TimeSinceLastEvent")]
    public long TimeSinceLastEventTicks
    {
        get { return m_TimeSinceLastEvent.Ticks; }
        set { m_TimeSinceLastEvent = new TimeSpan(value); }
    }
}

虽然这在我的简短测试中似乎有效 - 这是实现这一目标的最佳方法吗？

是否有更好的方法将 TimeSpan 与 XML 进行序列化？

Answer 1

这只是对问题中建议的方法的轻微修改，但是 此 Microsoft Connect 问题 建议使用如下属性进行序列化：

[XmlIgnore]
public TimeSpan TimeSinceLastEvent
{
    get { return m_TimeSinceLastEvent; }
    set { m_TimeSinceLastEvent = value; }
}

// XmlSerializer does not support TimeSpan, so use this property for 
// serialization instead.
[Browsable(false)]
[XmlElement(DataType="duration", ElementName="TimeSinceLastEvent")]
public string TimeSinceLastEventString
{
    get 
    { 
        return XmlConvert.ToString(TimeSinceLastEvent); 
    }
    set 
    { 
        TimeSinceLastEvent = string.IsNullOrEmpty(value) ?
            TimeSpan.Zero : XmlConvert.ToTimeSpan(value); 
    }
}

这会将 0:02:45 的 TimeSpan 序列化为：

<TimeSinceLastEvent>PT2M45S</TimeSinceLastEvent>

或者，DataContractSerializer 支持时间跨度。

Answer 2

您已经发布的方式可能是最干净的。 如果您不喜欢额外的属性，您可以实现IXmlSerialized，但随后您必须执行所有操作，这在很大程度上违背了这一点。 我很乐意使用您发布的方法； 它（例如）高效（没有复杂的解析等）、文化独立、明确，并且时间戳类型的数字易于理解。

顺便说一句，我经常补充：

[Browsable(false), EditorBrowsable(EditorBrowsableState.Never)]

这只是将其隐藏在 UI 和引用 dll 中，以避免混淆。

Answer 3

在某些情况下，可以为您的公共属性提供一个支持字段，即 TimeSpan，但公共属性以字符串形式公开。

例如：

protected TimeSpan myTimeout;
public string MyTimeout 
{ 
    get { return myTimeout.ToString(); } 
    set { myTimeout = TimeSpan.Parse(value); }
}

如果属性值主要在包含类或继承类中使用并且从 xml 配置加载，则这是可以的。

如果您希望公共属性成为其他类的可用 TimeSpan 值，则其他建议的解决方案会更好。

Answer 4

结合 颜色序列化 和 这个原始解决方案（本身就很棒）我得到了这个解决方案：

[XmlElement(Type = typeof(XmlTimeSpan))]
public TimeSpan TimeSinceLastEvent { get; set; }

其中XmlTimeSpan 类是这样的：

public class XmlTimeSpan
{
    private const long TICKS_PER_MS = TimeSpan.TicksPerMillisecond;

    private TimeSpan m_value = TimeSpan.Zero;

    public XmlTimeSpan() { }
    public XmlTimeSpan(TimeSpan source) { m_value = source; }

    public static implicit operator TimeSpan?(XmlTimeSpan o)
    {
        return o == null ? default(TimeSpan?) : o.m_value;
    }

    public static implicit operator XmlTimeSpan(TimeSpan? o)
    {
        return o == null ? null : new XmlTimeSpan(o.Value);
    }

    public static implicit operator TimeSpan(XmlTimeSpan o)
    {
        return o == null ? default(TimeSpan) : o.m_value;
    }

    public static implicit operator XmlTimeSpan(TimeSpan o)
    {
        return o == default(TimeSpan) ? null : new XmlTimeSpan(o);
    }

    [XmlText]
    public long Default
    {
        get { return m_value.Ticks / TICKS_PER_MS; }
        set { m_value = new TimeSpan(value * TICKS_PER_MS); }
    }
}

Answer 5

您可以围绕 TimeSpan 结构创建一个轻型包装器：

namespace My.XmlSerialization
{
    public struct TimeSpan : IXmlSerializable
    {
        private System.TimeSpan _value;

        public static implicit operator TimeSpan(System.TimeSpan value)
        {
            return new TimeSpan { _value = value };
        }

        public static implicit operator System.TimeSpan(TimeSpan value)
        {
            return value._value;
        }

        public XmlSchema GetSchema()
        {
            return null;
        }

        public void ReadXml(XmlReader reader)
        {
            _value = System.TimeSpan.Parse(reader.ReadContentAsString());
        }

        public void WriteXml(XmlWriter writer)
        {
            writer.WriteValue(_value.ToString());
        }
    }
}

示例序列化结果：

<Entry>
  <StartTime>2010-12-06T08:45:12.5</StartTime>
  <Duration>2.08:29:35.2500000</Duration>
</Entry>

Answer 6

更具可读性的选项是将其序列化为字符串并使用 TimeSpan.Parse 方法对其进行反序列化。 您可以执行与示例中相同的操作，但在 getter 中使用 TimeSpan.ToString() 并在 setter 中使用 TimeSpan.Parse(value) 。

Answer 7

对于 .NET6 和 .NET7，TimeSpan 序列化可以开箱即用。 该格式是 XSD“duration”数据类型的格式。 因此“14:30”被序列化为 PT14H30M

对于 .NET Framework 4.8，可以使用以下开关激活此行为：

AppContext.SetSwitch("Switch.System.Xml.EnableTimeSpanSerialization", true);

Answer 8

我的解决方案版本。

[DataMember, XmlIgnore]
public TimeSpan MyTimeoutValue { get; set; }
[DataMember]
public string MyTimeout
{
    get { return MyTimeoutValue.ToString(); }
    set { MyTimeoutValue = TimeSpan.Parse(value); }
}

编辑：假设它可以为空：

[DataMember, XmlIgnore]
public TimeSpan? MyTimeoutValue { get; set; }
[DataMember]
public string MyTimeout
{
    get 
    {
        if (MyTimeoutValue != null)
            return MyTimeoutValue.ToString();
        return null;
    }
    set 
    {
        TimeSpan outValue;
        if (TimeSpan.TryParse(value, out outValue))
            MyTimeoutValue = outValue;
        else
            MyTimeoutValue = null;
    }
}

Answer 9

另一种选择是使用 SoapFormatter 类而不是 XmlSerializer 类对其进行序列化。

生成的 XML 文件看起来有点不同...一些带有“SOAP”前缀的标签等...但它可以做到。

以下是 SoapFormatter 将 20 小时 28 分钟的时间跨度序列化为：

<myTimeSpan>P0Y0M0DT20H28M0S</myTimeSpan>

要使用 SOAPFormatter 类，需要添加对 System.Runtime.Serialization.Formatters.Soap 的引用并使用同名的命名空间。

Answer 10

时间跨度以秒数形式存储在 xml 中，但我希望它很容易采用。
手动序列化时间跨度（实现 IXmlSerialized）：

public class Settings : IXmlSerializable
{
    [XmlElement("IntervalInSeconds")]
    public TimeSpan Interval;

    public XmlSchema GetSchema()
    {
        return null;
    }

    public void WriteXml(XmlWriter writer)
    {
        writer.WriteElementString("IntervalInSeconds", ((int)Interval.TotalSeconds).ToString());
    }

    public void ReadXml(XmlReader reader)
    {
        string element = null;
        while (reader.Read())
        {
            if (reader.NodeType == XmlNodeType.Element)
                element = reader.Name;
            else if (reader.NodeType == XmlNodeType.Text)
            {
                if (element == "IntervalInSeconds")
                    Interval = TimeSpan.FromSeconds(double.Parse(reader.Value.Replace(',', '.'), CultureInfo.InvariantCulture));
            }
       }
    }
}

有更全面的示例：
https://bitbucket.org/njkazakov/timespan-serialization

查看 Settings.cs。
使用 XmlElementAttribute 有一些棘手的代码。

Answer 11

如果您不需要任何解决方法，请使用 System.Runtime.Serialization.dll 中的 DataContractSerializer 类。

        using (var fs = new FileStream("file.xml", FileMode.Create))
        {
            var serializer = new DataContractSerializer(typeof(List<SomeType>));
            serializer.WriteObject(fs, _items);
        }

Answer 12

对于数据契约序列化，我使用以下内容。

• 保持序列化属性私有可以保持公共接口的干净。
• 使用公共属性名称进行序列化可以保持 XML 的整洁。

Public Property Duration As TimeSpan

<DataMember(Name:="Duration")>
Private Property DurationString As String
    Get
        Return Duration.ToString
    End Get
    Set(value As String)
        Duration = TimeSpan.Parse(value)
    End Set
End Property

Answer 13

尝试这个 ：

//Don't Serialize Time Span object.
        [XmlIgnore]
        public TimeSpan m_timeSpan;
//Instead serialize (long)Ticks and instantiate Timespan at time of deserialization.
        public long m_TimeSpanTicks
        {
            get { return m_timeSpan.Ticks; }
            set { m_timeSpan = new TimeSpan(value); }
        }