Классы C# из JSON: генерация и ручное создание

Обновлено: 31.10.2026 · 3 мин чтения

Понимание JSON и C#

Прежде чем генерировать классы, нужно понять, как устроен формат JSON и почему он удобен для обмена данными.

Что такое JSON?

JSON (JavaScript Object Notation) - это текстовый формат обмена данными, который отличается легкостью чтения и записи для человека, а также легкостью парсинга и генерации для машин. JSON часто используется для сериализации и передачи структурированной информации по сети.

Как JSON связан с C#?

В C# для работы с JSON часто используются классы, которые представляют структуру данных, содержащихся в JSON-строке. Это позволяет десериализовать JSON-строку в объекты C# и работать с ними в рамках типизированной системы языка.

Средства Автоматической Генерации Классов

Самый быстрый способ получить классы - воспользоваться средствами самой среды разработки.

Visual Studio

Visual Studio предлагает встроенную функцию для генерации классов из JSON. Просто скопируйте JSON-строку в буфер обмена, затем в Visual Studio выберите “Edit” > “Paste Special” > “Paste JSON As Classes”. Это создаст классы, которые соответствуют структуре JSON.

Онлайн-инструменты

Существует множество онлайн-сервисов, которые также могут генерировать C# классы из JSON. Примеры таких сервисов включают “json2csharp”, “QuickType” и другие. Эти инструменты обычно требуют, чтобы вы вставили JSON-строку на их веб-сайт, и в ответ они предоставят вам готовый код классов.

Использование Newtonsoft.Json для Десериализации

Если нужно получить классы без установки программ, существуют внешние сервисы, которым достаточно передать образец JSON.

Обзор библиотеки

Newtonsoft.Json, также известная как Json.NET, является самой популярной библиотекой для работы с JSON в .NET. Она предоставляет мощные средства для сериализации и десериализации объектов.

Пример десериализации

using Newtonsoft.Json;

public class MyObject
{
    public string Name { get; set; }
    public int Age { get; set; }
}

string json = @"{'Name':'John', 'Age':30}";
MyObject obj = JsonConvert.DeserializeObject<MyObject>(json);

В этом примере строка JSON десериализуется в объект класса MyObject.

Ручное Создание Классов

Для разбора JSON чаще всего берут готовую библиотеку, и самая популярная из них показана ниже.

Преимущества и недостатки

Иногда может потребоваться создать классы вручную, если автоматически сгенерированный код не соответствует всем требованиям или нуждается в дальнейшей настройке.

Пример ручного создания класса

public class Person
{
    public string FirstName { get; set; }
    public string LastName { get; set; }
    public int Age { get; set; }
}

string json = @"{'FirstName':'Jane', 'LastName':'Doe', 'Age':27}";
Person person = JsonConvert.DeserializeObject<Person>(json);

Здесь мы создали класс Person согласно структуре JSON и десериализовали JSON в этот класс.

Аттрибуты и Настройка Сериализации

Названия свойств в JSON и в C# часто не совпадают, и для этого в Json.NET предусмотрены атрибуты.

Аттрибуты Json.NET

Json.NET предоставляет аттрибуты, которые позволяют настроить процесс сериализации и десериализации. Например, JsonProperty позволяет переопределить имена свойств.

Пример использования аттрибутов

public class Employee
{
    [JsonProperty("name")]
    public string FullName { get; set; }

    [JsonProperty("years")]
    public int YearsOfExperience { get; set; }
}

string json = @"{'name':'Emily', 'years':5}";
Employee employee = JsonConvert.DeserializeObject<Employee>(json);

В этом примере аттрибуты используются для маппинга свойств объекта на поля JSON с другими именами.

Расширенная Настройка и Пользовательские Конвертеры

Когда формат данных нестандартный, преобразованием можно управлять самостоятельно.

Создание пользовательских конвертеров

Для особых случаев, когда стандартной сериализации или десериализации недостаточно, можно создать свой конвертер, наследуя от JsonConverter.

Пример создания пользовательского конвертера

public class TimespanConverter : JsonConverter
{
    public override bool CanConvert(Type objectType)
    {
        return objectType == typeof(TimeSpan);
    }

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        return TimeSpan.Parse((string)reader.Value);
    }

    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        writer.WriteValue(((TimeSpan)value).ToString());
    }
}

// Использование конвертера
[JsonConverter(typeof(TimespanConverter))]
public TimeSpan Duration { get; set; }

Этот код демонстрирует создание пользовательского конвертера для типа TimeSpan.

Заключение и Лучшие Практики

В завершение сравним подходы и подскажем, в каких случаях лучше полагаться на автоматику.

Когда использовать автоматическую генерацию

Автоматическая генерация классов наиболее полезна, когда вам нужно быстро начать работу с новым JSON или когда структура JSON стабильна и не требует сложной логики.

Лучшие практики

• Проверяйте и тестируйте сгенерированные классы, особенно если используете онлайн-инструменты.
• Используйте аттрибуты Json.NET для точной настройки сериализации и десериализации.
• Создавайте пользовательские конвертеры для специфичных сценариев.

Автоматическая генерация классов C# из JSON может значительно ускорить процесс разработки, минимизируя рутинную и скучную работу, а также уменьшить количество потенциальных ошибок. Используя представленные инструменты и советы, вы сможете эффективно интегрировать JSON-данные в свои C# проекты.