Określanie niestandardowego formatu DateTime podczas serializacji za pomocą Json.Net

Question

Zajmuję się tworzeniem interfejsu API w celu ujawnienia niektórych danych przy użyciu interfejsu ASP.NET Web API.

W jednym z interfejsów API klient chce, abyśmy ujawnili datę w formacie rrrr-MM-dd. Nie chcę zmieniać ustawień globalnych (np. GlobalConfiguration.Configuration.Formatters.JsonFormatter), ponieważ jest to bardzo specyficzne dla tego klienta. I rozwijam to w rozwiązaniu dla wielu klientów.

Jednym z roztworem, że mogę myśleć jest stworzenie własnego konwertera JSON, a następnie umieścić że do właściwości muszę zrobić formatowanie niestandardowej

np

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

Zastanawiam się, czy istnieje inny łatwy sposób na zrobienie tego.

Answer 1

Jesteś na dobrej drodze. Ponieważ powiedziałeś, że nie możesz modyfikować ustawień globalnych, najlepszą rzeczą jest zastosowanie atrybutu JsonConverter w razie potrzeby, zgodnie z sugestiami. Okazuje się, że Json.Net ma już wbudowany IsoDateTimeConverter, który pozwala określić format daty. Niestety, nie można ustawić formatu za pomocą atrybutu JsonConverter, ponieważ jedynym argumentem atrybutu jest typ. Istnieje jednak proste rozwiązanie: podklasa IsoDateTimeConverter, następnie określ format daty w konstruktorze podklasy. Zastosuj atrybut JsonConverter w razie potrzeby, określając swój niestandardowy konwerter i jesteś gotowy do pracy. Oto całość kodu potrzebne:

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

Jeśli nie przeszkadza mieć czas tam również, że nie trzeba nawet podklasy IsoDateTimeConverter. Jego domyślny format daty to yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK (jak widać w source code).

Answer 2

To może być również wykonane z instancji temp IsoDateTimeConverter, bez zmiany ustawień formatowania globalne:

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

używa przeciążenie, że trwa params JsonConverter[] argument.

Answer 3

Również dostępne za pomocą jednego z ustawień serializer przeciążeń:

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

Albo

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

Przeciążenia biorący typu są również dostępne.

Answer 4

Można użyć tej metody:

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

i używać go w ten sposób:

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

Ciąg DateTimeFormat używa ciąg składni formatu NET opisaną tutaj: https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings