Spécification d'un format DateTime personnalisé lors de la sérialisation avec Json.Net

Je développe une API pour exposer certaines données à l'aide de l'API Web ASP.NET.

Dans l'une des API, le client veut que nous exposions la date au yyyy-MM-ddformat. Je ne veux pas changer les paramètres globaux (par exemple GlobalConfiguration.Configuration.Formatters.JsonFormatter) pour cela car il est très spécifique à ce client. Et je développe cela dans une solution pour plusieurs clients.

Une des solutions à laquelle je pourrais penser est de créer une personnalisation JsonConverter, puis de la placer dans la propriété dont j'ai besoin pour effectuer la mise en forme personnalisée

par exemple

class ReturnObjectA 
{
    [JsonConverter(typeof(CustomDateTimeConverter))]
    public DateTime ReturnDate { get;set;}
}

Je me demande simplement s'il existe un autre moyen facile de le faire.

Tu es sur la bonne piste. Puisque vous avez dit que vous ne pouvez pas modifier les paramètres globaux, alors la meilleure chose à faire est d'appliquer l' JsonConverterattribut au besoin, comme vous l'avez suggéré. Il s'avère que Json.Net a déjà un intégré IsoDateTimeConverterqui vous permet de spécifier le format de date. Malheureusement, vous ne pouvez pas définir le format via l' JsonConverterattribut, car le seul argument de l'attribut est un type. Cependant, il y a une solution simple: sous - classe la IsoDateTimeConverter, puis spécifiez le format de date dans le constructeur de la sous - classe. Appliquez l' JsonConverterattribut si nécessaire, en spécifiant votre convertisseur personnalisé, et vous êtes prêt à partir. Voici l'intégralité du code nécessaire:

class CustomDateTimeConverter : IsoDateTimeConverter
{
    public CustomDateTimeConverter()
    {
        base.DateTimeFormat = "yyyy-MM-dd";
    }
}

Si cela ne vous dérange pas d'avoir le temps là-dedans également, vous n'avez même pas besoin de sous-classer IsoDateTimeConverter. Son format de date par défaut est yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK(comme indiqué dans le code source ).

Vous pouvez utiliser cette approche:

public class DateFormatConverter : IsoDateTimeConverter
{
    public DateFormatConverter(string format)
    {
        DateTimeFormat = format;
    }
}

Et utilisez-le de cette façon:

class ReturnObjectA 
{
    [JsonConverter(typeof(DateFormatConverter), "yyyy-MM-dd")]
    public DateTime ReturnDate { get;set;}
}

La chaîne DateTimeFormat utilise la syntaxe de chaîne de format .NET décrite ici: https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings

Cela peut également être fait avec une IsoDateTimeConverterinstance, sans modifier les paramètres de formatage globaux:

string json = JsonConvert.SerializeObject(yourObject,
    new IsoDateTimeConverter() { DateTimeFormat = "yyyy-MM-dd HH:mm:ss" });

Cela utilise la JsonConvert.SerializeObjectsurcharge qui prend un params JsonConverter[]argument.

Également disponible en utilisant l'une des surcharges de paramètres du sérialiseur:

var json = JsonConvert.SerializeObject(someObject, new JsonSerializerSettings() { DateFormatString = "yyyy-MM-ddThh:mm:ssZ" });

Ou

var json = JsonConvert.SerializeObject(someObject, Formatting.Indented, new JsonSerializerSettings() { DateFormatString = "yyyy-MM-ddThh:mm:ssZ" });

Des surcharges prenant un type sont également disponibles.

Créez une classe d'assistance et appliquez-la à votre attribut de propriété

Classe d'assistance:

public class ESDateTimeConverter : IsoDateTimeConverter
{
    public ESDateTimeConverter()
    {
        base.DateTimeFormat = "yyyy-MM-ddTHH:mm:ss.fffZ";
    }
}

Votre code utilise comme ceci:

[JsonConverter(typeof(ESDateTimeConverter))]
public DateTime timestamp { get; set; }

Il existe une autre solution que j'utilise. Créez simplement une propriété de chaîne et utilisez-la pour json. Cette propriété retournera la date correctement formatée.

class JSonModel {
    ...

    [JsonProperty("date")]
    public string MyDate { get; set; }

    public string CustomDate {
        get { return MyDate.ToString("DDMMYY"); }
        set { MyDate = DateTime.Parse(value); }
    }

    ...
}

De cette façon, vous n'avez pas à créer de classes supplémentaires. En outre, il vous permet de créer différents formats de données. par exemple, vous pouvez facilement créer une autre propriété pour l'heure en utilisant le même DateTime.

Parfois, la décoration de l'attribut json convert ne fonctionnera pas, cela fonctionnera grâce à une exception disant que " 2010-10-01" est une date valide . Pour éviter ce type, j'ai supprimé l'attribut json convert sur la propriété et mentionné dans la méthode deserilizedObject comme ci-dessous.

var addresss = JsonConvert.DeserializeObject<AddressHistory>(address, new IsoDateTimeConverter { DateTimeFormat = "yyyy-MM-dd" });

Avec ci-dessous convertisseur

public class CustomDateTimeConverter : IsoDateTimeConverter
    {
        public CustomDateTimeConverter()
        {
            DateTimeFormat = "yyyy-MM-dd";
        }

        public CustomDateTimeConverter(string format)
        {
            DateTimeFormat = format;
        }
    }

Peut l'utiliser avec un format personnalisé par défaut

class ReturnObjectA 
{
    [JsonConverter(typeof(DateFormatConverter))]
    public DateTime ReturnDate { get;set;}
}

Ou tout format spécifié pour une propriété

class ReturnObjectB 
{
    [JsonConverter(typeof(DateFormatConverter), "dd MMM yy")]
    public DateTime ReturnDate { get;set;}
}