JSON to C# Class

Vad är JSON till C#-konvertering?

JSON till C#-konvertering innebär att man genererar starkt typade C#-klassdefinitioner från JSON-data. När en .NET-applikation tar emot JSON från ett API, en konfigurationsfil eller en meddelandekö behöver den C#-klasser för att deserialisera den datan till objekt. Att skriva dessa klasser för hand är tidskrävande och felbenäget, särskilt när JSON innehåller nästlade objekt, arrayer och blandade typer.

En JSON till C#-klassgenerator analyserar strukturen och värdena i din JSON, härleder lämplig C#-typ för varje fält och producerar klassdefinitioner med egenskapsaccessorer och serialiseringsattribut. Utdata följer .NET:s namnkonventioner: PascalCase-egenskapsnamn, JsonPropertyName-attribut för mappning till de ursprungliga camelCase- eller snake_case-JSON-nycklarna samt korrekt användning av List'<'T'>' för arrayer.

Den här konverteringen är särskilt vanlig i ASP.NET Core-webb-API:er, Azure Functions och alla .NET-tjänster som konsumerar extern JSON-data. Istället för att använda dynamic eller Dictionary'<'string, object'>' ger typade klasser dig typsäkerhet vid kompileringstid, IntelliSense-stöd och skydd mot stavfel i fältnamn som annars bara skulle uppstå vid körningstid. Klistra in din JSON i det här verktyget och få färdiga C#-klasser direkt.

Varför använda en JSON till C#-generator?

Att skriva C#-modellklasser manuellt från JSON-exempel tar tid och introducerar mänskliga fel. En generator hanterar de repetitiva delarna så att du kan fokusera på affärslogiken.

Användningsfall för JSON till C#

Referens för JSON till C#-typmappning

Varje JSON-värdetyp mappas till en specifik C#-typ. Generatorn analyserar faktiska värden för att välja den mest precisa typen. Ett JSON-tal utan decimalpunkt blir till exempel int, medan 3.14 blir double. Null-värden ger object? (nullbar referenstyp) eftersom den faktiska typen inte kan härledas från null ensamt.

System.Text.Json vs Newtonsoft.Json

.NET har två stora JSON-serialiseringsbibliotek. Klasserna som genereras av det här verktyget använder System.Text.Json-attribut (JsonPropertyName), vilket är det inbyggda alternativet sedan .NET Core 3.0. Om ditt projekt använder Newtonsoft.Json kan du byta ut attributen.

Kodexempel

Dessa exempel visar hur man definierar och använder C#-klasser genererade från JSON, med båda de stora serialiseringsbiblioteken, samt hur man automatiserar generering från kommandoraden.

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

Vanliga frågor