c# - newtonsoft json 序列化时间跨度格式

Question

是否可以为 TimeSpan 序列化指定自定义格式？使用 Newtonsoft.Json。

我想以 HH:mm 格式序列化字符串，例如:

TimeSpan.FromHours(5) ->//"+05:00"

TimeSpan.FromHours(-5) ->//"-05:00"

谢谢!

Answer 1

这是您可以添加到项目中的 TimeSpan 转换器:

using System;
using Newtonsoft.Json;

namespace JsonTools
{
    /// <summary>
    /// TimeSpans are not serialized consistently depending on what properties are present. So this 
    /// serializer will ensure the format is maintained no matter what.
    /// </summary>
    public class TimespanConverter : JsonConverter<TimeSpan>
    {
        /// <summary>
        /// Format: Days.Hours:Minutes:Seconds:Milliseconds
        /// </summary>
        public const string TimeSpanFormatString = @"d\.hh\:mm\:ss\:FFF";

        public override void WriteJson(JsonWriter writer, TimeSpan value, JsonSerializer serializer)
        {
            var timespanFormatted = $"{value.ToString(TimeSpanFormatString)}";
            writer.WriteValue(timespanFormatted);
        }

        public override TimeSpan ReadJson(JsonReader reader, Type objectType, TimeSpan existingValue, bool hasExistingValue, JsonSerializer serializer)
        {
            TimeSpan parsedTimeSpan;
            TimeSpan.TryParseExact((string)reader.Value, TimeSpanFormatString, null, out parsedTimeSpan);
            return parsedTimeSpan;
        }
    }
}

可以这样使用:

public class Schedule
{
    [JsonConverter(typeof(TimespanConverter))]
    [JsonProperty(TypeNameHandling = TypeNameHandling.All)]
    public TimeSpan Delay { get; set; }
}

注意事项:

1. Reference for TimeSpan serialization formats

2. 我发现在使用 Newtonsoft 生成架构时，我必须包含 TypeNameHandling 属性，否则 TimeSpan 类型名称在生成的架构中未正确序列化。对于此处的目的而言，这不是必需的，但我还是将其包括在内。