การระบุรูปแบบ DateTime แบบกำหนดเองเมื่อทำการจัดลำดับด้วย Json.Net

ฉันกำลังพัฒนา API เพื่อเปิดเผยข้อมูลบางอย่างโดยใช้ ASP.NET Web API

ในหนึ่งใน API ลูกค้าต้องการให้เราเปิดเผยวันที่ในyyyy-MM-ddรูปแบบ ฉันไม่ต้องการเปลี่ยนการตั้งค่าส่วนกลาง (เช่นGlobalConfiguration.Configuration.Formatters.JsonFormatter) สำหรับสิ่งนั้นเนื่องจากมีความเฉพาะเจาะจงสำหรับลูกค้า และฉันจะพัฒนาสิ่งนั้นในโซลูชันสำหรับลูกค้าหลายราย

หนึ่งในวิธีการแก้ปัญหาที่ฉันคิดได้ก็คือการสร้างกำหนดเองJsonConverterจากนั้นนำไปใช้กับคุณสมบัติที่ฉันต้องใช้ในการจัดรูปแบบที่กำหนดเอง

เช่น

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

แค่สงสัยว่ามีวิธีอื่นที่ง่ายกว่าในการทำเช่นนั้น

คุณอยู่ในเส้นทางที่ถูกต้อง เนื่องจากคุณบอกว่าคุณไม่สามารถแก้ไขการตั้งค่าส่วนกลางดังนั้นสิ่งที่ดีที่สุดถัดไปคือการใช้JsonConverterแอตทริบิวต์ตามความจำเป็นตามที่คุณแนะนำ ปรากฎว่า Json.Net มีอยู่แล้วในตัวIsoDateTimeConverterที่ช่วยให้คุณระบุรูปแบบวันที่ น่าเสียดายที่คุณไม่สามารถตั้งค่ารูปแบบผ่านแอJsonConverterททริบิวเนื่องจากอาร์กิวเมนต์ของแอททริบิวนั้นเป็นประเภท อย่างไรก็ตามมีวิธีแก้ปัญหาง่ายๆคือ: subclass IsoDateTimeConverterจากนั้นระบุรูปแบบวันที่ในนวกรรมิกของคลาสย่อย ใช้JsonConverterคุณลักษณะที่จำเป็นระบุตัวแปลงที่กำหนดเองของคุณและคุณพร้อมที่จะไป นี่คือรหัสทั้งหมดที่จำเป็น:

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

ถ้าคุณไม่รังเกียจที่จะมีเวลาอยู่ในนั้นคุณก็ไม่จำเป็นต้องใช้คลาสย่อยของ IsoDateTimeConverter รูปแบบวันที่เริ่มต้นคือyyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK(ตามที่เห็นในซอร์สโค้ด )

คุณสามารถใช้วิธีนี้:

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

และใช้วิธีนี้:

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

สตริง DateTimeFormat ใช้ไวยากรณ์สตริงรูปแบบ. NET ที่อธิบายไว้ที่นี่: https://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings

มันสามารถทำได้กับIsoDateTimeConverterอินสแตนซ์โดยไม่ต้องเปลี่ยนการตั้งค่าการจัดรูปแบบทั่วโลก:

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

นี่ใช้JsonConvert.SerializeObjectโอเวอร์โหลดที่รับparams JsonConverter[]อาร์กิวเมนต์

สามารถใช้งานได้โดยใช้การตั้งค่าหนึ่งในการตั้งค่าอนุกรม

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

หรือ

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

นอกจากนี้ยังมีการรับน้ำหนักเกินจำนวนด้วย

สร้างคลาสตัวช่วยและใช้กับคุณสมบัติคุณสมบัติของคุณ

ระดับผู้ช่วย:

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

รหัสของคุณใช้ดังนี้:

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

มีวิธีแก้ไขปัญหาอื่นที่ฉันใช้อยู่ เพียงสร้างคุณสมบัติสตริงและใช้สำหรับ json คุณสมบัตินี้จะส่งคืนวันที่ในรูปแบบที่ถูกต้อง

class JSonModel {
    ...

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

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

    ...
}

วิธีนี้คุณไม่ต้องสร้างคลาสเพิ่มเติม นอกจากนี้ยังช่วยให้คุณสามารถสร้างรูปแบบข้อมูลที่แตกต่างกัน เช่นคุณสามารถสร้างคุณสมบัติอื่นสำหรับชั่วโมงโดยใช้ DateTime เดียวกันได้อย่างง่ายดาย

บางครั้งการตกแต่ง JSON แปลงแอตทริบิวต์จะไม่ทำงานก็จะผ่านข้อยกเว้นบอกว่า " 2010/10/01" เป็นวันที่ถูกต้อง เพื่อหลีกเลี่ยงประเภทนี้ฉันลบ json คุณสมบัติการแปลงในทรัพย์สินและกล่าวถึงในวิธีการ deserilizedObject เช่นด้านล่าง

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

ด้วยตัวแปลงด้านล่าง

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

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

สามารถใช้กับรูปแบบที่กำหนดเองเริ่มต้น

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

หรือรูปแบบที่ระบุสำหรับคุณสมบัติ

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