Especificar un formato de fecha y hora personalizado al serializar con Json.Net

Estoy desarrollando una API para exponer algunos datos usando la API web ASP.NET.

En una de las API, el cliente quiere que expongamos la fecha en yyyy-MM-ddformato. No quiero cambiar la configuración global (por ejemplo GlobalConfiguration.Configuration.Formatters.JsonFormatter) para eso, ya que es muy específico para este cliente. Y lo desarrollo en una solución para múltiples clientes.

Una de las soluciones que se me JsonConverterocurre es crear una personalizada y luego ponerla en la propiedad que necesito para el formateo personalizado.

p.ej

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

Solo me pregunto si hay alguna otra manera fácil de hacerlo.

Estás en el camino correcto. Como usted dijo que no puede modificar la configuración global, lo mejor que puede hacer es aplicar el JsonConverteratributo según sea necesario, como lo sugirió. Resulta que Json.Net ya tiene un incorporado IsoDateTimeConverterque le permite especificar el formato de fecha. Desafortunadamente, no puede establecer el formato a través del JsonConverteratributo, ya que el único argumento del atributo es un tipo. Sin embargo, hay una solución simple: subclase IsoDateTimeConverter, luego especifique el formato de fecha en el constructor de la subclase. Aplique el JsonConverteratributo donde sea necesario, especifique su convertidor personalizado y estará listo para comenzar. Aquí está la totalidad del código necesario:

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

Si no le importa tener tiempo allí también, ni siquiera necesita subclasificar el IsoDateTimeConverter. Su formato de fecha predeterminado es yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK(como se ve en el código fuente ).

Podrías usar este enfoque:

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

Y úsalo de esta manera:

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

La cadena DateTimeFormat utiliza la sintaxis de cadena en formato .NET descrita aquí: https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings

También se puede hacer con una IsoDateTimeConverterinstancia, sin cambiar la configuración de formato global:

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

Esto usa la JsonConvert.SerializeObjectsobrecarga que toma un params JsonConverter[]argumento.

También disponible con una de las sobrecargas de configuración del serializador:

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

O

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

Las sobrecargas que toman un tipo también están disponibles.

Cree una clase auxiliar y aplíquela a su atributo de propiedad

Clase auxiliar:

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

Su código se usa así:

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

Hay otra solución que he estado usando. Simplemente cree una propiedad de cadena y úsela para json. Esta propiedad tendrá una fecha de devolución con el formato correcto.

class JSonModel {
    ...

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

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

    ...
}

De esta manera no tienes que crear clases adicionales. Además, le permite crear diferentes formatos de datos. por ejemplo, puede crear fácilmente otra propiedad por hora utilizando la misma fecha y hora.

Algunas veces decorar el atributo json convert no funcionará, lo hará a través de la excepción diciendo que " 2010-10-01" es una fecha válida . Para evitar este tipo, eliminé el atributo json convert en la propiedad y lo mencioné en el método deserilizedObject como se muestra a continuación.

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

Con el siguiente convertidor

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

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

Puede usarlo con un formato personalizado predeterminado

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

O cualquier formato especificado para una propiedad

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