JSON to C# Class

Що таке конвертація JSON у C#?

Конвертація JSON у C# — це процес генерації строго типізованих визначень класів C# з даних JSON. Коли .NET-застосунок отримує JSON від API, конфігураційного файлу або черги повідомлень, йому потрібні класи C# для десеріалізації цих даних в об'єкти. Написання таких класів вручну є нудним і схильним до помилок, особливо коли JSON містить вкладені об'єкти, масиви та змішані типи.

Генератор класів JSON to C# аналізує структуру й значення вашого JSON, визначає відповідний тип C# для кожного поля та створює визначення класів з аксесорами властивостей і атрибутами серіалізації. Результат відповідає угодам іменування .NET: назви властивостей у PascalCase, атрибути JsonPropertyName для відображення на оригінальні ключі JSON у camelCase або snake_case, а також правильне використання List'<'T'>' для масивів.

Ця конвертація особливо поширена у веб-API ASP.NET Core, Azure Functions і будь-яких .NET-сервісах, що споживають зовнішні JSON-дані. Замість використання dynamic або Dictionary'<'string, object'>', типізовані класи забезпечують безпеку на етапі компіляції, підтримку IntelliSense та захист від друкарських помилок у назвах полів, які інакше виявлялися б лише під час виконання. Вставте ваш JSON в цей інструмент і отримайте готові до використання класи C# миттєво.

Навіщо використовувати генератор JSON to C#?

Написання класів моделей C# вручну за зразками JSON займає час і призводить до людських помилок. Генератор бере на себе шаблонну роботу, дозволяючи зосередитися на бізнес-логіці.

Сценарії використання JSON to C#

Таблиця відповідності типів JSON та C#

Кожен тип значення JSON відображається на конкретний тип C#. Генератор аналізує реальні значення, щоб обрати найточніший тип. Наприклад, JSON-число без десяткової крапки стає int, тоді як 3.14 стає double. Значення null дає object? (тип посилання, що допускає null), оскільки реальний тип неможливо визначити лише з null.

System.Text.Json vs Newtonsoft.Json

.NET має дві основні бібліотеки серіалізації JSON. Згенеровані цим інструментом класи використовують атрибути System.Text.Json (JsonPropertyName) — вбудований варіант, доступний починаючи з .NET Core 3.0. Якщо ваш проект використовує Newtonsoft.Json, ви можете замінити атрибути.

Приклади коду

Ці приклади показують, як визначати й використовувати класи C#, згенеровані з JSON, із використанням обох основних бібліотек серіалізації, а також автоматизацію генерації з командного рядка.

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))

Часті запитання