JSON sang Lớp C#

Chuyển đổi JSON sang C# là gì?

Chuyển đổi JSON sang C# là quá trình tạo các định nghĩa lớp C# có kiểu chặt chẽ từ dữ liệu JSON. Khi một ứng dụng .NET nhận JSON từ API, file cấu hình, hoặc hàng đợi tin nhắn, nó cần các lớp C# để giải tuần tự hóa dữ liệu đó thành đối tượng. Viết các lớp này bằng tay rất tẻ nhạt và dễ mắc lỗi, đặc biệt khi JSON chứa các đối tượng lồng nhau, mảng và kiểu hỗn hợp.

Bộ tạo lớp C# từ JSON kiểm tra cấu trúc và giá trị trong JSON của bạn, suy kiểu C# phù hợp cho từng trường, và tạo ra các định nghĩa lớp với bộ truy cập thuộc tính và thuộc tính tuần tự hóa. Đầu ra tuân theo quy ước đặt tên .NET: tên thuộc tính PascalCase, thuộc tính JsonPropertyName để ánh xạ sang các khóa JSON camelCase hoặc snake_case gốc, và sử dụng đúng List'<'T'>' cho mảng.

Việc chuyển đổi này đặc biệt phổ biến trong ASP.NET Core web API, Azure Functions, và bất kỳ dịch vụ .NET nào sử dụng dữ liệu JSON bên ngoài. Thay vì dùng dynamic hoặc Dictionary'<'string, object'>', các lớp có kiểu mang lại an toàn tại thời điểm biên dịch, hỗ trợ IntelliSense, và bảo vệ khỏi lỗi đánh máy tên trường mà nếu không sẽ chỉ xuất hiện lúc chạy. Dán JSON của bạn vào công cụ này và nhận các lớp C# sẵn dùng ngay lập tức.

Tại sao dùng bộ tạo JSON sang C#?

Viết thủ công các lớp model C# từ mẫu JSON tốn thời gian và dễ xảy ra lỗi. Bộ tạo xử lý các phần lặp đi lặp lại để bạn có thể tập trung vào logic nghiệp vụ.

Các trường hợp sử dụng JSON sang C#

Bảng tham chiếu ánh xạ kiểu JSON sang C#

Mỗi kiểu giá trị JSON ánh xạ sang một kiểu C# cụ thể. Bộ tạo phân tích giá trị thực tế để chọn kiểu chính xác nhất. Ví dụ, một số JSON không có dấu thập phân trở thành int, trong khi 3.14 trở thành double. Giá trị null tạo ra object? (kiểu tham chiếu nullable) vì kiểu thực tế không thể suy ra từ null đơn thuần.

System.Text.Json vs Newtonsoft.Json

.NET có hai thư viện tuần tự hóa JSON chính. Các lớp được tạo từ công cụ này sử dụng thuộc tính System.Text.Json (JsonPropertyName), là tùy chọn tích hợp sẵn từ .NET Core 3.0. Nếu dự án của bạn dùng Newtonsoft.Json, bạn có thể hoán đổi các thuộc tính.

Ví dụ mã nguồn

Các ví dụ này cho thấy cách định nghĩa và sử dụng các lớp C# được tạo từ JSON, dùng cả hai thư viện tuần tự hóa chính, cùng cách tự động hóa việc tạo từ dòng lệnh.

using System.Text.Json;

var json = """{"id": 1, "name": "Alice", "active": true}""";
var user = JsonSerializer.Deserialize<User>(json);
Console.WriteLine(user.Name); // → "Alice"

public class User
{
    [JsonPropertyName("id")]
    public int Id { get; set; }

    [JsonPropertyName("name")]
    public string Name { get; set; }

    [JsonPropertyName("active")]
    public bool Active { get; set; }
}

using Newtonsoft.Json;

var json = @"{""id"": 1, ""name"": ""Alice"", ""scores"": [98, 85]}";
var user = JsonConvert.DeserializeObject<User>(json);
Console.WriteLine(user.Scores[0]); // → 98

public class User
{
    [JsonProperty("id")]
    public int Id { get; set; }

    [JsonProperty("name")]
    public string Name { get; set; }

    [JsonProperty("scores")]
    public List<int> Scores { get; set; }
}

// Install: npm install -g quicktype
// Generate C# classes from JSON:
// quicktype --lang csharp --src data.json --out Models.cs

// From stdin:
// echo '{"id": 1, "name": "Alice"}' | quicktype --lang csharp

// Output:
// public class Root
// {
//     [JsonPropertyName("id")]
//     public int Id { get; set; }
//
//     [JsonPropertyName("name")]
//     public string Name { get; set; }
// }

import json

def json_to_csharp(data: dict, class_name: str = "Root") -> str:
    lines = [f"public class {class_name}", "{"]
    type_map = {str: "string", int: "int", float: "double", bool: "bool"}

    for key, value in data.items():
        cs_type = type_map.get(type(value), "object")
        prop = key[0].upper() + key[1:]  # PascalCase
        lines.append(f'    [JsonPropertyName("{key}")]')
        lines.append(f'    public {cs_type} {prop} {{ get; set; }}')
        lines.append('')
    lines.append("}")
    return "\n".join(lines)

data = json.loads('{"id": 1, "name": "Alice", "active": true}')
print(json_to_csharp(data))

Câu hỏi thường gặp