JSON do klasy C#

Czym jest konwersja JSON do C#?

Konwersja JSON do C# to proces generowania silnie typowanych definicji klas C# z danych JSON. Gdy aplikacja .NET odbiera JSON z API, pliku konfiguracyjnego lub kolejki wiadomości, potrzebuje klas C# do deserializacji tych danych do obiektów. Ręczne pisanie tych klas jest żmudne i podatne na błędy, szczególnie gdy JSON zawiera zagnieżdżone obiekty, tablice i typy mieszane.

Generator klas C# z JSON analizuje strukturę i wartości w Twoim JSON, wnioskuje odpowiedni typ C# dla każdego pola i produkuje definicje klas z akcesory właściwości oraz atrybutami serializacji. Wyjście przestrzega konwencji nazewniczych .NET: nazwy właściwości w PascalCase, atrybuty JsonPropertyName do mapowania na oryginalne klucze JSON w camelCase lub snake_case, oraz poprawne użycie List'<'T'>' dla tablic.

Ta konwersja jest szczególnie powszechna w ASP.NET Core web API, Azure Functions i każdym serwisie .NET konsumującym zewnętrzne dane JSON. Zamiast używać dynamic lub Dictionary'<'string, object'>', typowane klasy zapewniają bezpieczeństwo podczas kompilacji, obsługę IntelliSense i ochronę przed literówkami w nazwach pól, które w przeciwnym razie ujawniłyby się dopiero w czasie działania. Wklej swój JSON do tego narzędzia i natychmiast otrzymaj gotowe do użycia klasy C#.

Dlaczego warto używać generatora JSON do C#?

Ręczne pisanie klas modeli C# z próbek JSON zajmuje czas i wprowadza błędy ludzkie. Generator przejmuje powtarzalne części, dzięki czemu możesz skupić się na logice biznesowej.

Przypadki użycia JSON do C#

Tabela mapowania typów JSON do C#

Każdy typ wartości JSON mapuje się na konkretny typ C#. Generator analizuje rzeczywiste wartości, aby wybrać najbardziej precyzyjny typ. Na przykład liczba JSON bez przecinka dziesiętnego staje się int, podczas gdy 3.14 staje się double. Wartości null produkują object? (typ referencyjny dopuszczający null), ponieważ rzeczywistego typu nie można wywnioskować wyłącznie z null.

System.Text.Json a Newtonsoft.Json

.NET ma dwie główne biblioteki serializacji JSON. Wygenerowane klasy z tego narzędzia używają atrybutów System.Text.Json (JsonPropertyName), które są wbudowaną opcją od .NET Core 3.0. Jeśli Twój projekt używa Newtonsoft.Json, możesz zamienić atrybuty.

Przykłady kodu

Te przykłady pokazują, jak definiować i używać klas C# wygenerowanych z JSON, z użyciem obu głównych bibliotek serializacji, a także jak zautomatyzować generowanie z wiersza poleceń.

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

Często zadawane pytania