Especificando um formato DateTime personalizado ao serializar com o Json.Net

Estou desenvolvendo uma API para expor alguns dados usando a API da Web do ASP.NET.

Em uma das APIs, o cliente deseja que exponha a data no yyyy-MM-ddformato. Não quero alterar as configurações globais (por exemplo GlobalConfiguration.Configuration.Formatters.JsonFormatter) para isso, pois é muito específico para este cliente. E desenvolvo isso em uma solução para vários clientes.

Uma das soluções que eu consegui pensar é criar um costume JsonConvertere, em seguida, colocá-lo na propriedade de que preciso fazer a formatação personalizada

por exemplo

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

Apenas imaginando se existe alguma outra maneira fácil de fazer isso.

Você está no caminho certo. Como você disse que não pode modificar as configurações globais, a próxima melhor coisa a fazer é aplicar o JsonConverteratributo conforme necessário, conforme sugerido. Acontece que o Json.Net já possui um built-in IsoDateTimeConverterque permite especificar o formato da data. Infelizmente, você não pode definir o formato por meio do JsonConverteratributo, pois o único argumento do atributo é um tipo. No entanto, existe uma solução simples: subclasse the e IsoDateTimeConverter, em seguida, especifique o formato da data no construtor da subclasse. Aplique o JsonConverteratributo quando necessário, especificando seu conversor personalizado e você estará pronto para começar. Aqui está a totalidade do código necessário:

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

Se você não se importa em ter tempo lá também, não precisa nem subclassificar o IsoDateTimeConverter. Seu formato de data padrão é yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK(como visto no código-fonte ).

Você pode usar esta abordagem:

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

E use-o desta maneira:

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

A string DateTimeFormat usa a sintaxe de string do formato .NET descrita aqui: https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings

Isso também pode ser feito com uma IsoDateTimeConverterinstância, sem alterar as configurações globais de formatação:

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

Isso usa a JsonConvert.SerializeObjectsobrecarga que recebe um params JsonConverter[]argumento.

Também disponível usando uma das sobrecargas das configurações do serializador:

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

Sobrecargas com um tipo também estão disponíveis.

Crie uma classe auxiliar e aplique-a ao atributo de propriedade

Classe auxiliar:

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

Seu código usa assim:

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

Há outra solução que estou usando. Apenas crie uma propriedade string e use-a para json. Esta propriedade retornará a data formatada corretamente.

class JSonModel {
    ...

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

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

    ...
}

Dessa forma, você não precisa criar classes extras. Além disso, permite criar diferentes formatos de dados. por exemplo, você pode criar facilmente outra propriedade por hora usando o mesmo DateTime.

Algumas vezes, a decoração do atributo json convert não funcionará, por exceção dizendo que " 2010-10-01" é uma data válida . Para evitar esses tipos, removi o atributo json convert na propriedade e mencionei no método deserilizedObject como abaixo.

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

Com conversor abaixo

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

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

Pode usá-lo com um formato personalizado padrão

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

Ou qualquer formato especificado para uma propriedade

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