Newtonsoft.json IsoDateTimeConverter and DateFormatHandling

Question

This is not an issue but concept I just want to make it clear. When working with asp.net web api we use Newtonsoft.Json's SerializerSettings. In this setting we can set

jsonSetting.Converters.Add(new IsoDateTimeConverter());
jsonSetting.DateFormatHandling = DateFormatHandling.IsoDateFormat;

I understood what IsoDateTimeConverter is doing but but not clear about DateFormatHandling.IsoDateFormat. It seems to be there is no effect of DateFormatHandling.MicrosoftDateFormat if you still using IsoDateTimeConverter.

Still excepting some explanation who know about this.

score 3 · Answer 1 · edited May 23 '17 at 12:23

You actually have several different related questions. Let's break them down:

What happens when I add a converter for a type that is natively supported by Json.NET?

If you do that, your converter supersedes the native Json.NET functionality. For instance, you can replace its serialization of byte [] fields. Or you can change how it serializes and deserializes numbers: this slightly silly converter serializes integers by adding 1:

public class IntConverter : JsonConverter
{ 
    public override bool CanConvert(Type objectType) { return objectType == typeof(int); }

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        return (int)JValue.Load(reader) - 1;
    }

    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        writer.WriteValue(1 + (int)value);
    }
}

Why does Json.NET provide various DateTime converters as well as native support for multiple DateTime formats?

This is explained in the documentation Serializing Dates in JSON

DateTimes in JSON are hard.

The problem comes from the JSON spec itself: there is no literal syntax for dates in JSON. The spec has objects, arrays, strings, integers, and floats, but it defines no standard for what a date looks like.

The native support for dates handles some commonly encountered formats; if you have dates in some other format you can derive from DateTimeConverterBase. (For an example, see How to convert new Date(year, month, day) overload with JSON.Net.) Having done so, your converter will supersede the native conversion specified by DateFormatHandling.

Why does Json.NET have a class IsoDateTimeConverter that seems to duplicate the functionality of DateFormatHandling.IsoDateFormat?

This is a legacy class. From Serializing Dates in JSON

From Json.NET 4.5 and onwards dates are written using the ISO 8601 format by default, and using this converter is unnecessary.

Newtonsoft.json IsoDateTimeConverter and DateFormatHandling

1 Answers1

Linked