JSON ถึงคลาสใน C#

ตัวอย่างผลลัพธ์

สำหรับการป้อนข้อมูล:

{ "firstName": "Alice", "age": 30, "emails": ["a@a.com"], "address": { "city": "Madrid" } }

ผลลัพธ์ของ System.Text.Json (C# 10+):

public class User
{
    [JsonPropertyName("firstName")]
    public string FirstName { get; set; } = default!;

    [JsonPropertyName("age")]
    public int Age { get; set; }

    [JsonPropertyName("emails")]
    public List<string> Emails { get; set; } = new();

    [JsonPropertyName("address")]
    public Address Address { get; set; } = default!;
}

public class Address
{
    [JsonPropertyName("city")]
    public string City { get; set; } = default!;
}

การจับคู่รูปแบบ

ตัวเลือกของแอตทริบิวต์

• System.Text.Json ([JsonPropertyName("foo")]), เหมาะอย่างยิ่งสำหรับโครงการที่ใช้ .NET 6+ และโครงการใหม่
• Newtonsoft.Json ([JsonProperty("foo")]), ใช้สำหรับโปรเจกต์เก่า หรือเมื่อคุณต้องการฟีเจอร์เฉพาะของ Newtonsoft
• ไม่มี, ชื่อพร็อพเพอร์ตี้ตรงกับคีย์ใน JSON อย่างแม่นยำ (ใช้ได้เฉพาะเมื่อคีย์ใน JSON เป็น PascalCase อยู่แล้ว)

ข้อผิดพลาดที่พบบ่อย

• ใช้ int สำหรับฟิลด์ที่อาจมีค่าเกินขีดจำกัด หาก JSON ของคุณมีค่าที่มากกว่า int.MaxValue ให้ใช้ long โดยตัวสร้างจะเปลี่ยนไปใช้ long อัตโนมัติเมื่อตรวจพบค่าที่มีขนาดใหญ่
• ไม่มี [JsonIgnore] สำหรับคุณสมบัติที่คำนวณได้ หากคุณเพิ่มคุณสมบัติช่วย (helper props) เข้าไปในคลาสที่สร้างขึ้น ให้กำหนดค่า [JsonIgnore] ให้กับคุณสมบัติดังกล่าว มิฉะนั้นคุณสมบัติเหล่านี้จะถูกแปลงเป็นข้อมูลแบบเซรีแอลไลซ์ (serialized data) ในระหว่างกระบวนการประมวลผล
• การละเลยการวิเคราะห์ข้อมูลที่ไม่ขึ้นอยู่กับวัฒนธรรม ฟิลด์ของ decimal ควรถูกแปลงรูปแบบให้สอดคล้องกับ CultureInfo.InvariantCulture โดยค่าเริ่มต้นแล้ว System.Text.Json จะทำเช่นนี้ ส่วน Newtonsoft ก็ทำเช่นเดียวกันเมื่อใช้การตั้งค่าระดับโลก
• ให้ความไว้วางใจกับตัวสร้างข้อมูลโดยใช้เพียงตัวอย่างเดียว คุณสมบัติของข้อมูลที่สามารถถูกตัดทอนได้ (nullable) และประเภทของรายการในอาร์เรย์จะถูกคาดการณ์จากสิ่งที่ระบบตรวจพบเสมอ ควรตรวจสอบความถูกต้องของคำอธิบายเกี่ยวกับคุณสมบัติnullable เทียบกับพฤติกรรมจริงของ API ของคุณอยู่เสมอ