Từ JSON đến lớp C#

Ví dụ về kết quả đầu ra

Đối với dữ liệu đầu vào:

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

Kết quả đầu ra 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!;
}

Xác định kiểu dữ liệu

Các tùy chọn thuộc tính

• System.Text.Json ([JsonPropertyName("foo")]) – được ưu tiên cho các dự án .NET 6+ và các dự án mới.
• Newtonsoft.Json ([JsonProperty("foo")]) – dùng cho các dự án cũ hoặc khi cần các tính năng riêng của Newtonsoft.
• Không có, tên thuộc tính trùng khớp hoàn toàn với các khóa JSON (chỉ hoạt động khi các khóa JSON đã ở định dạng PascalCase).

Các lỗi phổ biến

• Sử dụng int cho trường có nguy cơ vượt giới hạn giá trị. Nếu dữ liệu JSON của bạn chứa các giá trị lớn hơn int.MaxValue, hãy sử dụng long. Bộ tạo sẽ tự động chuyển sang sử dụng long khi phát hiện các giá trị lớn. – Thiếu [JsonIgnore] đối với các thuộc tính tính toán. Nếu bạn thêm các thuộc tính hỗ trợ vào lớp được tạo ra, hãy gắn [JsonIgnore] cho chúng; nếu không, chúng sẽ được tuần tự hóa khi xuất ra. – Bỏ qua việc phân tích không phụ thuộc vào văn hóa. Các trường của decimal cần được giải mã bằng CultureInfo.InvariantCulture; System.Text.Json thực hiện điều này mặc định, trong khi Newtonsoft sử dụng thiết lập toàn cục để thực hiện.
• Đặt niềm tin vào bộ sinh dữ liệu chỉ dựa trên một mẫu duy nhất. Các tính chất như khả năng bị xóa bỏ (nullable) và loại dữ liệu của các phần tử mảng sẽ được suy đoán từ những gì bộ sinh dữ liệu nhận được. Luôn kiểm tra tính hợp lý của các chú thích về tính khả năng bị xóa bỏ so với hành vi thực tế của API.