Angeben eines benutzerdefinierten DateTime-Formats beim Serialisieren mit Json.Net

Question

Ich entwickle eine API, um einige Daten mithilfe der ASP.NET-Web-API verfügbar zu machen.

In einer der API möchte der Client uns das Datum im Format JJJJ-MM-TT anzeigen. Ich möchte die globalen Einstellungen (z. B. GlobalConfiguration.Configuration.Formatters.JsonFormatter) nicht ändern, da sie für diesen Client sehr spezifisch sind. Und ich entwickle das in einer Lösung für mehrere Kunden.

Einer der Lösung, die ich denken konnte, ist ein benutzerdefinierter Json-Konverter zu erstellen und das dann auf die Eigenschaft hat ich die benutzerdefinierte Formatierung

zum Beispiel tun müssen

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

Ich frage mich nur, ob es eine andere einfache Möglichkeit gibt, das zu tun.

Answer 1

Sie sind auf dem richtigen Weg. Da Sie gesagt haben, dass Sie die globalen Einstellungen nicht ändern können, ist die nächstbeste Lösung, das Attribut JsonConverter je nach Bedarf anzuwenden, wie Sie es vorgeschlagen haben. Es stellt sich heraus, Json.Net hat bereits eine eingebaute IsoDateTimeConverter, mit der Sie das Datumsformat angeben können. Leider können Sie das Format nicht über das Attribut JsonConverter festlegen, da das einzige Argument des Attributs ein Typ ist. Es gibt jedoch eine einfache Lösung: Unterklasse IsoDateTimeConverter, dann geben Sie das Datumsformat im Konstruktor der Unterklasse an. Wenden Sie das Attribut JsonConverter dort an, wo Sie es benötigen, geben Sie Ihren benutzerdefinierten Konverter an, und schon kann es losgehen. Hier ist die Gesamtheit des Codes benötigt:

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

Wenn Sie nichts dagegen haben dort auch die Zeit haben, brauchen Sie nicht einmal die IsoDateTimeConverter Unterklasse. Das Standarddatumsformat ist yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK (wie in der source code zu sehen ist).

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

Dies verwendet die Überlastung, die ein params JsonConverter[] Argument:

Answer 2

Es kann auch mit einer temporären IsoDateTimeConverter Instanz, ohne Änderung globale Formatierungseinstellungen vorgenommen werden.

Answer 3

Auch eine der Serializer Einstellungen Überlastungen mit:

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

Oder

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

Überlastungen eine Art nehmen sind ebenfalls erhältlich.

Answer 4

könnten Sie diesen Ansatz verwenden:

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

Und es auf diese Weise verwenden:

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

Das Datetimeformat Zeichenfolge verwendet die .NET Format-String-Syntax hier beschrieben: https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings