Chỉ định định dạng DateTime tùy chỉnh khi tuần tự hóa với Json.Net

Tôi đang phát triển API để hiển thị một số dữ liệu bằng API Web ASP.NET.

Trong một trong các API, khách hàng muốn chúng tôi hiển thị ngày ở yyyy-MM-ddđịnh dạng. Tôi không muốn thay đổi cài đặt toàn cầu (ví dụ GlobalConfiguration.Configuration.Formatters.JsonFormatter) vì điều đó rất cụ thể đối với khách hàng này. Và tôi phát triển điều đó trong một giải pháp cho nhiều khách hàng.

Một trong những giải pháp mà tôi có thể nghĩ đến là tạo một tùy chỉnh JsonConvertervà sau đó đặt nó vào thuộc tính tôi cần để thực hiện định dạng tùy chỉnh

ví dụ

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

Chỉ tự hỏi nếu có một số cách dễ dàng khác để làm điều đó.

Bạn đang đi đúng hướng. Vì bạn nói rằng bạn không thể sửa đổi cài đặt chung, nên điều tốt nhất tiếp theo là áp dụng JsonConverterthuộc tính trên cơ sở khi cần, như bạn đã đề xuất. Hóa ra Json.Net đã tích hợp sẵn IsoDateTimeConvertercho phép bạn chỉ định định dạng ngày. Thật không may, bạn không thể đặt định dạng thông qua JsonConverterthuộc tính, vì đối số duy nhất của thuộc tính là một loại. Tuy nhiên, có một giải pháp đơn giản: phân lớp IsoDateTimeConverter, sau đó chỉ định định dạng ngày trong hàm tạo của lớp con. Áp dụng JsonConverterthuộc tính khi cần, chỉ định trình chuyển đổi tùy chỉnh của bạn và bạn đã sẵn sàng để đi. Đây là toàn bộ mã cần thiết:

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

Nếu bạn không có thời gian ở đó, bạn thậm chí không cần phải phân lớp IsoDateTimeConverter. Định dạng ngày mặc định của nó là yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK(như được thấy trong mã nguồn ).

Bạn có thể sử dụng phương pháp này:

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

Và sử dụng nó theo cách này:

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

Chuỗi DateTimeFormat sử dụng cú pháp chuỗi định dạng .NET được mô tả ở đây: https://docs.microsoft.com/en-us/dotnet/stiteria/base-types/custom-date-and-time-format-strings

Nó cũng có thể được thực hiện với một IsoDateTimeConverterthể hiện, mà không thay đổi cài đặt định dạng toàn cầu:

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

Điều này sử dụng JsonConvert.SerializeObjectquá tải mà có một params JsonConverter[]đối số.

Cũng có sẵn bằng cách sử dụng một trong các cài đặt serializer quá tải:

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

Hoặc là

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

Quá tải lấy một loại cũng có sẵn.

Xây dựng lớp trình trợ giúp và áp dụng nó vào thuộc tính thuộc tính của bạn

Lớp người trợ giúp:

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

Mã của bạn sử dụng như thế này:

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

Có một giải pháp khác mà tôi đang sử dụng. Chỉ cần tạo một thuộc tính chuỗi và sử dụng nó cho json. Khách sạn này sẽ trả lại ngày được định dạng đúng.

class JSonModel {
    ...

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

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

    ...
}

Bằng cách này, bạn không phải tạo thêm lớp. Ngoài ra, nó cho phép bạn tạo các định dạng dữ liệu khác nhau. ví dụ: bạn có thể dễ dàng tạo một Thuộc tính khác cho Giờ bằng cùng một DateTime.

Đôi khi trang trí thuộc tính json convert sẽ không hoạt động, thông qua ngoại lệ nói rằng " 2010-10-01" là ngày hợp lệ . Để tránh loại này, tôi đã loại bỏ thuộc tính json convert trên thuộc tính và được đề cập trong phương thức deserilizedObject như bên dưới.

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

Với bộ chuyển đổi dưới đây

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

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

Có thể sử dụng nó với định dạng tùy chỉnh mặc định

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

Hoặc bất kỳ định dạng được chỉ định cho một tài sản

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