JSON to C# Class

Что такое конвертация JSON в C#?

Конвертация JSON в C# — это процесс генерации строго типизированных определений классов C# из JSON-данных. Когда .NET-приложение получает JSON из API, конфигурационного файла или очереди сообщений, ему нужны классы C# для десериализации этих данных в объекты. Писать такие классы вручную утомительно и чревато ошибками, особенно когда JSON содержит вложенные объекты, массивы и смешанные типы.

Генератор классов C# из JSON анализирует структуру и значения вашего 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 в C#?

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

Сценарии использования JSON to C#

Справочник по сопоставлению типов JSON и C#

Каждый тип значения JSON соответствует определённому типу C#. Генератор анализирует реальные значения, чтобы выбрать наиболее точный тип. Например, число JSON без десятичной точки становится int, а 3.14 — double. Значения null дают object? (nullable ссылочный тип), поскольку реальный тип нельзя определить из 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))

Часто задаваемые вопросы