Jak serializować TimeSpan do XML

Próbuję serializować TimeSpanobiekt .NET do XML i nie działa. Szybki google zasugerował, że chociaż TimeSpanmożna go serializować, XmlCustomFormatternie zapewnia on metod konwertowania TimeSpanobiektów na i z XML.

Jednym sugerowanym podejściem było zignorowanie TimeSpanserializacji i zamiast tego serializacja wyniku TimeSpan.Ticks(i użycie new TimeSpan(ticks)do deserializacji). Oto przykład:

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

Chociaż wydaje się, że działa to w moich krótkich testach - czy to najlepszy sposób na osiągnięcie tego?

Czy istnieje lepszy sposób na serializację TimeSpan do iz XML?

Sposób, w jaki już pisałeś, jest prawdopodobnie najczystszy. Jeśli nie podoba ci się dodatkowa właściwość, możesz ją wdrożyć IXmlSerializable, ale wtedy musisz zrobić wszystko , co w dużej mierze pokonuje sens. Z chęcią skorzystam z opublikowanego przez ciebie podejścia; jest (na przykład) wydajny (bez złożonej analizy itp.), liczby niezależne od kultury, jednoznaczne, a numery typu datownika są łatwe i powszechnie rozumiane.

Nawiasem mówiąc, często dodaję:

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

To tylko ukrywa go w interfejsie użytkownika i odwołuje się do bibliotek dll, aby uniknąć nieporozumień.

To tylko niewielka modyfikacja podejścia zaproponowanego w pytaniu, ale ten problem z Microsoft Connect zaleca użycie właściwości do serializacji takiej jak ta:

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

Spowodowałoby to serializację TimeSpan 0:02:45 jako:

<TimeSinceLastEvent>PT2M45S</TimeSinceLastEvent>

Alternatywnie DataContractSerializerobsługuje TimeSpan.

Coś, co może działać w niektórych przypadkach, to nadanie swojej własności publicznej pola pomocniczego, które jest TimeSpan, ale własność publiczna jest ujawniona jako ciąg znaków.

na przykład:

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

Jest to w porządku, jeśli wartość właściwości jest używana głównie w / w klasie zawierającej lub dziedziczącej i jest ładowana z konfiguracji xml.

Inne proponowane rozwiązania są lepsze, jeśli chcesz, aby własność publiczna była użyteczną wartością TimeSpan dla innych klas.

Łącząc odpowiedź z serializacji kolorów i tego oryginalnego rozwiązania (które samo w sobie jest świetne) otrzymałem to rozwiązanie:

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

gdzie XmlTimeSpanklasa jest taka:

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

Możesz stworzyć lekkie opakowanie wokół struktury 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());
        }
    }
}

Przykładowy wynik zserializowany:

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

Bardziej czytelną opcją byłoby serializowanie jako ciąg i użycie TimeSpan.Parsemetody do deserializacji. Możesz zrobić to samo, co w twoim przykładzie, ale używając TimeSpan.ToString()gettera i TimeSpan.Parse(value)setera.

Inną opcją byłoby serializowanie go za pomocą SoapFormatterklasy, a nie XmlSerializerklasy.

Wynikowy plik XML wygląda trochę inaczej ... niektóre tagi z prefiksem „SOAP” itp., Ale może to zrobić.

Oto, co SoapFormatterszeregowało przedział czasowy wynoszący 20 godzin i 28 minut, aby:

<myTimeSpan>P0Y0M0DT20H28M0S</myTimeSpan>

Aby użyć klasy SOAPFormatter, należy dodać odwołanie do System.Runtime.Serialization.Formatters.Soapprzestrzeni nazw o tej samej nazwie i użyć jej.

Moja wersja rozwiązania :)

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

Edycja: zakładając, że jest zerowy ...

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

Przedział czasu przechowywany w xml jako liczba sekund, ale mam nadzieję, że łatwo go przyjąć. Przedział czasu jest serializowany ręcznie (implementacja 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));
            }
       }
    }
}

Bardziej wyczerpujący przykład: https://bitbucket.org/njkazakov/timespan-serialization

Spójrz na Settings.cs. I jest jakiś trudny kod do użycia XmlElementAttribute.

Do serializacji umów danych używam następujących.

• Utrzymanie zserializowanej własności prywatnej utrzymuje interfejs publiczny w czystości.
• Użycie nazwy właściwości publicznej do serializacji utrzymuje XML w czystości.

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

Jeśli nie chcesz żadnych obejść, użyj klasy DataContractSerializer z System.Runtime.Serialization.dll.

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

Spróbuj tego :

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