JSON to C# Class

Was ist die JSON-zu-C#-Konvertierung?

Die JSON-zu-C#-Konvertierung ist der Prozess, bei dem aus JSON-Daten typsichere C#-Klassendefinitionen erzeugt werden. Wenn eine .NET-Anwendung JSON von einer API, einer Konfigurationsdatei oder einer Message Queue empfängt, benötigt sie C#-Klassen, um diese Daten in Objekte zu deserialisieren. Diese Klassen von Hand zu schreiben ist mühsam und fehleranfällig – besonders wenn das JSON verschachtelte Objekte, Arrays und gemischte Typen enthält.

Ein JSON-zu-C#-Klassengenerator analysiert die Struktur und die Werte in deinem JSON, leitet den passenden C#-Typ für jedes Feld ab und erzeugt Klassendefinitionen mit Property-Accessoren und Serialisierungsattributen. Die Ausgabe folgt den .NET-Namenskonventionen: PascalCase-Eigenschaftsnamen, JsonPropertyName-Attribute zur Zuordnung zu den ursprünglichen camelCase- oder snake_case-JSON-Schlüsseln sowie korrekter Einsatz von List'<'T'>' für Arrays.

Diese Konvertierung ist besonders in ASP.NET Core Web-APIs, Azure Functions und allen .NET-Diensten verbreitet, die externe JSON-Daten verarbeiten. Statt dynamic oder Dictionary'<'string, object'>' zu verwenden, bieten typisierte Klassen Typsicherheit zur Kompilierzeit, IntelliSense-Unterstützung und Schutz vor Tippfehlern bei Feldnamen, die sonst erst zur Laufzeit auffallen würden. Füge dein JSON in dieses Tool ein und erhalte sofort einsatzbereite C#-Klassen.

Warum einen JSON-zu-C#-Generator verwenden?

C#-Modellklassen manuell aus JSON-Beispielen zu schreiben kostet Zeit und führt zu menschlichen Fehlern. Ein Generator übernimmt die repetitiven Aufgaben, damit du dich auf die Geschäftslogik konzentrieren kannst.

Anwendungsfälle für JSON-zu-C#

JSON-zu-C#-Typzuordnung: Referenz

Jeder JSON-Wertetyp wird auf einen bestimmten C#-Typ abgebildet. Der Generator analysiert die tatsächlichen Werte, um den präzisesten Typ zu wählen. Eine JSON-Zahl ohne Dezimalstelle wird beispielsweise zu int, während 3.14 zu double wird. Null-Werte ergeben object? (nullable Referenztyp), da der eigentliche Typ aus null allein nicht abgeleitet werden kann.

System.Text.Json vs. Newtonsoft.Json

.NET verfügt über zwei wichtige JSON-Serialisierungsbibliotheken. Die von diesem Tool generierten Klassen verwenden System.Text.Json-Attribute (JsonPropertyName), die integrierte Option seit .NET Core 3.0. Falls dein Projekt Newtonsoft.Json verwendet, kannst du die Attribute einfach austauschen.

Code-Beispiele

Diese Beispiele zeigen, wie C#-Klassen, die aus JSON generiert wurden, definiert und verwendet werden – mit beiden wichtigen Serialisierungsbibliotheken sowie der automatisierten Generierung über die Kommandozeile.

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

Häufig gestellte Fragen