JSON to C# Class

Wat is JSON naar C#-conversie?

JSON naar C#-conversie is het proces waarbij sterk getypeerde C#-klassedefinities worden gegenereerd vanuit JSON-data. Wanneer een .NET-applicatie JSON ontvangt van een API, configuratiebestand of berichtenwachtrij, heeft ze C#-klassen nodig om die data te deserialiseren naar objecten. Die klassen met de hand schrijven is omslachtig en foutgevoelig, zeker als de JSON geneste objecten, arrays en gemengde typen bevat.

Een JSON naar C#-klassegenerator analyseert de structuur en waarden in je JSON, leidt het juiste C#-type af voor elk veld en produceert klassedefinities met property-accessors en serialisatieattributen. De uitvoer volgt de .NET-naamgevingsconventies: PascalCase-propertynamen, JsonPropertyName-attributen voor de koppeling aan de oorspronkelijke camelCase- of snake_case-JSON-sleutels, en correct gebruik van List'<'T'>' voor arrays.

Deze conversie komt vooral voor in ASP.NET Core web-API's, Azure Functions en elke .NET-service die externe JSON-data verwerkt. In plaats van dynamic of Dictionary'<'string, object'>' te gebruiken, geven getypeerde klassen je compile-time veiligheid, IntelliSense-ondersteuning en bescherming tegen typefouten in veldnamen die anders pas op runtime aan het licht komen. Plak je JSON in dit hulpmiddel en krijg direct gebruiksklare C#-klassen.

Waarom een JSON naar C#-generator gebruiken?

C#-modelklassen handmatig schrijven vanuit JSON-voorbeelden kost tijd en introduceert menselijke fouten. Een generator neemt de repetitieve delen voor zijn rekening zodat jij je kunt concentreren op de bedrijfslogica.

Gebruiksscenario's voor JSON naar C#

JSON naar C#-typemapping referentie

Elk JSON-waardetype wordt gekoppeld aan een specifiek C#-type. De generator analyseert de werkelijke waarden om het meest precieze type te kiezen. Zo wordt een JSON-getal zonder decimaalpunt een int, terwijl 3.14 een double wordt. Null-waarden produceren object? (nullable referentietype) omdat het werkelijke type niet kan worden afgeleid uit null alleen.

System.Text.Json vs Newtonsoft.Json

.NET heeft twee belangrijke JSON-serialisatiebibliotheken. De gegenereerde klassen van dit hulpmiddel gebruiken System.Text.Json-attributen (JsonPropertyName), de ingebouwde optie sinds .NET Core 3.0. Als je project Newtonsoft.Json gebruikt, kun je de attributen vervangen.

Codevoorbeelden

Deze voorbeelden laten zien hoe C#-klassen gegenereerd vanuit JSON worden gedefinieerd en gebruikt, met beide belangrijke serialisatiebibliotheken, plus hoe generatie via de opdrachtregel kan worden geautomatiseerd.

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

Veelgestelde vragen