JSON.. NET序列化日期时间.MinValue为空

本文关键字:MinValue 为空 时间 日期 NET 序列化 JSON | 更新日期: 2023-09-27 18:14:53

我希望设置为我的Web API返回的DateTime.MinValueDateTime字段被序列化为NULL而不是"0001-01-01T00:00:00"

我知道有一种方法来获得JSON。. NET省略设置为默认值的字段,但我更喜欢JSON。. NET专门序列化DateTime MinValue / "0001-01-01T00:00:00" as null .

有办法做到这一点吗?

JSON.. NET序列化日期时间.MinValue为空

创建自定义转换器,将DateTime.MinValue序列化为null,并(如果需要)将null反序列化为DateTime.MinValue:

public class MinDateTimeConverter : DateTimeConverterBase
{
    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        if (reader.Value == null)
            return DateTime.MinValue;
        return (DateTime)reader.Value;
    }
    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        DateTime dateTimeValue = (DateTime)value;
        if (dateTimeValue == DateTime.MinValue)
        {
            writer.WriteNull();
            return;
        }
        writer.WriteValue(value);
    }
}

然后可以使用属性将转换器添加到数据类中,如下例所示:

public class Example
{
    [JsonConverter(typeof(MinDateTimeConverter))]
    public DateTime ValueOne { get; set; }
    [JsonConverter(typeof(MinDateTimeConverter))]
    public DateTime ValueTwo { get; set; }
}
public static void Main(string[] args)
{
    Example data = new Example();
    data.ValueOne = DateTime.MinValue;
    data.ValueTwo = DateTime.Now;
    JsonSerializer serializer = new JsonSerializer();
    using (StringWriter writer = new StringWriter())
    {
        serializer.Serialize(writer, data);
        Console.Write(writer.ToString());
    }
    Console.ReadKey();
}
控制台输出

:

{"ValueOne":null,"ValueTwo":"2016-10-26T09:54:48.497463+01:00"}

自定义日期时间Json转换器

public class DateTimeConverter : JsonConverter
{   
    public override void WriteJson(JsonWriter jsonWriter, object inputObject,JsonSerializer jsonSerializer)
    {
        // Typecast the input object
        var dateTimeObject = inputObject as DateTime?;
        // Set the properties of the Json Writer
        jsonWriter.Formatting = Newtonsoft.Json.Formatting.Indented;
        if(dateTimeObject == DateTime.MinValue)
            jsonWriter.WriteValue((DateTime?)null);
        else
            jsonWriter.WriteValue(dateTimeObject);
    }

    public override object ReadJson(JsonReader reader,
        Type objectType,
        object existingValue,
        JsonSerializer serializer)
    {
        DateTime? readValue = reader.ReadAsDateTime();
        return (readValue == null) ? DateTime.MinValue : readValue;     
    }

    public override bool CanConvert(Type objectType)
    {
        return typeof(DateTime?).IsAssignableFrom(objectType);
    }
}

用法:

public class DateTest
{
    [JsonConverterAttribute(typeof(DateTimeConverter))]
    public DateTime? MyDateTime { get; set;}
    [JsonConverterAttribute(typeof(DateTimeConverter))]
    public DateTime? MyDateTime1 { get; set; }
}
void Main()
{
    DateTest dateTest = new DateTest 
    { 
      MyDateTime = DateTime.MinValue, 
      MyDateTime1 = DateTime.MaxValue
    };
    Console.WriteLine(JsonConvert.SerializeObject(dateTest));
}
结果:

{
  "MyDateTime": null,
  "MyDateTime1": "9999-12-31T23:59:59.9999999"
}

不完全清楚为什么最初的海报想要这个,它已经过去5年了,但我也想实现这个。

然而,在我的情况下,问题是,当我序列化我的对象时,它插入DateTime字段,因为它们没有在传入对象上指定,但被返回为MinValue不是null。

因此,当我在另一端反序列化时,这些字段显示为"脏"并正在被解析。

在这种情况下,你可以修改你的JsonSerializerSettings块,在默认值处理中包括'ignore':

string serialisedMessage = JsonConvert.SerializeObject(message, new JsonSerializerSettings
        {
            NullValueHandling = NullValueHandling.Ignore,
            DefaultValueHandling = DefaultValueHandling.Ignore
        });

所以我留下这个以防将来的用户和我一样。