Json.Net ile serileştirirken özel bir DateTime biçimi belirtme

ASP.NET Web API kullanarak bazı verileri ortaya çıkarmak için bir API geliştiriyorum.

API'lardan birinde, müşteri tarihi yyyy-MM-ddformatta göstermemizi ister . GlobalConfiguration.Configuration.Formatters.JsonFormatterBu istemciye çok özel olduğu için bunun için genel ayarları (örneğin ) değiştirmek istemiyorum . Ve bunu birden fazla müşteri için bir çözümde geliştiriyorum.

Aklıma gelen bir çözüm, bir özel oluşturmak JsonConverterve daha sonra özel biçimlendirme yapmak için gereken özelliği koymak

Örneğin

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

Bunu yapmanın başka kolay bir yolu olup olmadığını merak etmek.

Doğru yoldasın. Genel ayarları değiştiremeyeceğinizi söylediğinizden, bir sonraki en iyi şey, JsonConverterözniteliği önerdiğiniz gibi gerektiği şekilde uygulamaktır . Görünüşe göre Json.Net IsoDateTimeConverter, tarih biçimini belirlemenizi sağlayan yerleşik bir yapıya sahip . Maalesef, JsonConverterniteliğin tek argümanı bir tür olduğundan formatı özellik üzerinden ayarlayamazsınız . Ancak, basit bir çözüm vardır: alt sınıfı IsoDateTimeConverter, ardından alt sınıfın yapıcısında tarih biçimini belirtin. JsonConverterÖzel dönüştürücünüzü belirterek özelliği gerektiği yerde uygulayın, artık hazırsınız. İşte gerekli kodun tamamı:

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

Orada zaman geçirmenin de bir sakıncası yoksa IsoDateTimeConverter öğesinin alt sınıfını bile almanıza gerek yoktur. Varsayılan tarih biçimi yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK( kaynak kodunda görüldüğü gibi ) şeklindedir.

Bu yaklaşımı kullanabilirsiniz:

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

Ve şu şekilde kullanın:

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

DateTimeFormat dizesi, burada açıklanan .NET biçimi dize sözdizimini kullanır: https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings

Genel IsoDateTimeConverterbiçimlendirme ayarlarını değiştirmeden bir örnekle de yapılabilir :

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

Bu, argüman alan JsonConvert.SerializeObjectaşırı yükü kullanır params JsonConverter[].

Ayrıca, serileştirici ayarları aşırı yüklerinden birini kullanarak da kullanılabilir:

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

Veya

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

Tip alan aşırı yükler de mevcuttur.

Yardımcı sınıf oluşturun ve bunu özellik özelliğinize uygulayın

Yardımcı sınıf:

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

Kodunuz şu şekilde kullanılır:

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

Kullandığım başka bir çözüm daha var. Bir dize özelliği oluşturun ve bunu json için kullanın. Bu özellik, iade tarihinin düzgün bir şekilde biçimlendirilmesini sağlayacaktır.

class JSonModel {
    ...

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

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

    ...
}

Bu şekilde ekstra sınıflar oluşturmak zorunda kalmazsınız. Ayrıca, farklı veri formatları oluşturmanıza izin verir. ör. aynı DateTime kullanarak kolayca Saat için başka bir Özellik oluşturabilirsiniz.

Bazı durumlarda json convert özniteliğini dekore etmek işe yaramaz, istisna olarak " 2010-10-01" geçerli bir tarih olduğunu söyleyecektir . Bu tür önlemek için özellik üzerinde json convert özniteliği kaldırıldı ve aşağıdaki gibi deserilizedObject yönteminde bahsedilen.

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

Aşağıdaki dönüştürücü ile

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

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

Varsayılan bir özel formatla kullanabilir

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

Veya bir mülk için belirtilen herhangi bir biçim

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