Określanie niestandardowego formatu daty i godziny podczas serializacji z Json.Net

Opracowuję interfejs API w celu udostępnienia niektórych danych przy użyciu interfejsu API sieci Web ASP.NET.

W jednym z API klient chce, abyśmy ujawnili datę w yyyy-MM-ddformacie. 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 rozwiązań, które przychodzi mi do głowy, jest utworzenie niestandardowego, JsonConvertera następnie umieszczenie go we właściwości, której potrzebuję, aby wykonać niestandardowe formatowanie

na przykład

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

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

Jesteś na dobrej drodze. Ponieważ powiedziałeś, że nie możesz modyfikować ustawień globalnych, następną najlepszą rzeczą jest zastosowanie JsonConverteratrybutu w razie potrzeby, tak jak zasugerowałeś. Okazuje się, że Json.Net ma już wbudowaną funkcję, IsoDateTimeConverterktóra pozwala określić format daty. Niestety nie możesz ustawić formatu za pomocą JsonConverteratrybutu, ponieważ jedynym argumentem atrybutu jest typ. Jest jednak proste rozwiązanie: podklasę podklasy IsoDateTimeConverter, a następnie określ format daty w konstruktorze podklasy. Zastosuj JsonConverteratrybut w razie potrzeby, określając swój niestandardowy konwerter i gotowe. Oto cały potrzebny kod:

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

Jeśli nie masz nic przeciwko temu, by mieć tam czas, nie musisz nawet tworzyć podklasy IsoDateTimeConverter. Jego domyślny format daty to yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK(jak widać w kodzie źródłowym ).

Możesz użyć tego podejścia:

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

I użyj tego w ten sposób:

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

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

Można to również zrobić za pomocą IsoDateTimeConverterinstancji, bez zmiany globalnych ustawień formatowania:

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

Używa JsonConvert.SerializeObjectprzeciążenia, które przyjmuje params JsonConverter[]argument.

Dostępne również przy użyciu jednego z przeciążeń ustawień serializatora:

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

Lub

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

Dostępne są również przeciążenia przyjmujące typ.

Zbuduj klasę pomocniczą i zastosuj ją do atrybutu właściwości

Klasa pomocnika:

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

Twój kod wygląda następująco:

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

Jest inne rozwiązanie, z którego korzystałem. Po prostu utwórz właściwość string i użyj jej dla json. Ta właściwość zwróci odpowiednio sformatowaną datę.

class JSonModel {
    ...

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

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

    ...
}

W ten sposób nie musisz tworzyć dodatkowych zajęć. Umożliwia także tworzenie różnych formatów danych. np. możesz łatwo utworzyć kolejną właściwość dla godziny przy użyciu tej samej daty i godziny.

Czasami dekorowanie atrybutu konwersji json nie zadziała, będzie to wynikać z wyjątku mówiącego, że „ 2010-10-01” jest prawidłową datą . Aby uniknąć tego typu, usunąłem atrybut json convert we właściwości i wspomniano o tym w metodzie deserilizedObject, jak poniżej.

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

Z poniższym konwerterem

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

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

Można go używać z domyślnym formatem niestandardowym

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

Lub jakikolwiek określony format właściwości

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