JSON to C# Class

Co je převod JSON na C#?

Převod JSON na C# je proces generování silně typovaných definic tříd C# z dat JSON. Když aplikace .NET přijme JSON z API, konfiguračního souboru nebo fronty zpráv, potřebuje třídy C# pro deserializaci těchto dat do objektů. Ruční psaní těchto tříd je zdlouhavé a náchylné k chybám, zvláště pokud JSON obsahuje vnořené objekty, pole a různé typy.

Generátor tříd C# z JSON prozkoumá strukturu a hodnoty vašeho JSON, odvodí odpovídající typ C# pro každé pole a vytvoří definice tříd s přístupovými vlastnostmi a atributy serializace. Výstup respektuje konvence pojmenování .NET: názvy vlastností v PascalCase, atributy JsonPropertyName pro mapování na původní klíče JSON v camelCase nebo snake_case a správné použití List'<'T'>' pro pole.

Tento převod je obzvláště běžný ve webových API ASP.NET Core, Azure Functions a jakékoli službě .NET, která konzumuje externí data JSON. Místo použití dynamic nebo Dictionary'<'string, object'>' vám typované třídy poskytují bezpečnost při kompilaci, podporu IntelliSense a ochranu před překlepy v názvech polí, které by se jinak projevily až za běhu. Vložte svůj JSON do tohoto nástroje a získejte třídy C# připravené k použití okamžitě.

Proč použít generátor JSON na C#?

Ruční psaní modelových tříd C# ze vzorků JSON je časově náročné a přináší lidské chyby. Generátor zvládá opakující se části, takže se můžete soustředit na business logiku.

Případy použití JSON na C#

Referenční tabulka mapování typů JSON na C#

Každý typ hodnoty JSON se mapuje na konkrétní typ C#. Generátor analyzuje skutečné hodnoty, aby zvolil nejpřesnější typ. Například číslo JSON bez desetinné tečky se stane int, zatímco 3.14 se stane double. Hodnoty null produkují object? (typ s možnou hodnotou null), protože skutečný typ nelze odvodit pouze z hodnoty null.

System.Text.Json vs Newtonsoft.Json

.NET má dvě hlavní knihovny pro serializaci JSON. Vygenerované třídy z tohoto nástroje používají atributy System.Text.Json (JsonPropertyName), což je vestavěná možnost od .NET Core 3.0. Pokud váš projekt používá Newtonsoft.Json, můžete atributy vyměnit.

Příklady kódu

Tyto příklady ukazují, jak definovat a používat třídy C# vygenerované z JSON, s využitím obou hlavních serializačních knihoven, a také jak automatizovat generování z příkazové řádky.

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

Často kladené otázky