Як серіалізувати TimeSpan до XML

Я намагаюся серіалізувати .NET- TimeSpanоб’єкт до XML, і він не працює. Швидкий google припустив, що, хоча він 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 і з нього?

Шлях, який ви вже розмістили, мабуть, найчистіший. Якщо вам не сподобається додаткова властивість, ви могли б реалізувати IXmlSerializable, але тоді вам доведеться зробити все , що значною мірою перемагає суть. Я б із задоволенням використовував підхід, який ви опублікували; це (наприклад) ефективне (без складного розбору тощо), незалежне від культури, однозначне число та цифри типу часових позначок легко та загальнозрозуміле.

Як осторонь я часто додаю:

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

Це просто приховує його в інтерфейсі та при посиланні на dlls, щоб уникнути плутанини.

Це лише незначна зміна підходу, запропонованого у питанні, але ця проблема 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 як:

<TimeSinceLastEvent>PT2M45S</TimeSinceLastEvent>

Крім того, DataContractSerializerпідтримує TimeSpan.

Щось може працювати в деяких випадках - це надати вашій публічній власності поле резервного копіювання, яке є TimeSpan, але публічна власність виставляється як рядок.

наприклад:

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

Це нормально, якщо значення властивості використовується здебільшого в / у класах, що містять або успадковують, і завантажується з конфігурації xml.

Інші запропоновані рішення краще, якщо ви хочете, щоб публічна власність була корисною для TimeSpan значенням для інших класів.

Поєднуючи відповідь із кольорової серіалізації та цього оригінального рішення (що само по собі чудово), я отримав таке рішення:

[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); }
    }
}

Ви можете створити легку обгортку навколо структури 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>

Більш читаним варіантом буде серіалізація як рядок та використання TimeSpan.Parseметоду для її дезаріалізації. Ви можете зробити те саме, що у вашому прикладі, але використовуючи TimeSpan.ToString()в геттері та TimeSpan.Parse(value)в сеттері.

Іншим варіантом буде серіалізація його за допомогою SoapFormatterкласу, а не класуXmlSerializer класу.

Отриманий XML-файл виглядає дещо інакше ... деякі теги з попереднім фіксом "SOAP" тощо ... але це можна зробити.

Ось, що SoapFormatterсеріалізували часовий проміжок часу, тривалістю 20 годин і 28 хвилин:

<myTimeSpan>P0Y0M0DT20H28M0S</myTimeSpan>

Щоб використовувати клас SOAPFormatter, потрібно додати посилання System.Runtime.Serialization.Formatters.Soapта використати однойменний простір імен.

Моя версія рішення :)

[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;
    }
}

Час дії зберігається в xml як кількість секунд, але його легко прийняти, сподіваюся. Час роботи серіалізується вручну (реалізуючи IXmlSerializable):

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.

Для серіалізації договорів даних я використовую наступне.

• Утримання приватного серіалізованого майна забезпечує чистий публічний інтерфейс.
• Використання назви загальнодоступних властивостей для серіалізації забезпечує чистоту 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

Якщо ви не хочете жодних обхідних шляхів, використовуйте клас DataContractSerializer від System.Runtime.Serialization.dll.

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

Спробуйте це :

//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); }
        }