JSON in Classe C#

Cos'è la conversione da JSON a C#?

La conversione da JSON a C# è il processo di generazione di definizioni di classi C# fortemente tipizzate a partire da dati JSON. Quando un'applicazione .NET riceve JSON da un'API, da un file di configurazione o da una coda di messaggi, ha bisogno di classi C# per deserializzare quei dati in oggetti. Scrivere queste classi a mano è tedioso e soggetto a errori, specialmente quando il JSON contiene oggetti annidati, array e tipi misti.

Un generatore da JSON a classi C# ispeziona la struttura e i valori del JSON, deduce il tipo C# appropriato per ogni campo e produce definizioni di classi con accessori di proprietà e attributi di serializzazione. L'output segue le convenzioni di denominazione .NET: nomi di proprietà in PascalCase, attributi JsonPropertyName per la mappatura alle chiavi JSON originali in camelCase o snake_case, e utilizzo corretto di List'<'T'>' per gli array.

Questa conversione è particolarmente comune nelle web API ASP.NET Core, in Azure Functions e in qualsiasi servizio .NET che consuma dati JSON esterni. Invece di usare dynamic o Dictionary'<'string, object'>', le classi tipizzate offrono sicurezza in fase di compilazione, supporto IntelliSense e protezione dagli errori di battitura nei nomi dei campi che altrimenti emergerebbero solo a runtime. Incolla il tuo JSON in questo strumento e ottieni subito classi C# pronte all'uso.

Perché usare un generatore da JSON a C#?

Scrivere manualmente classi modello C# da esempi JSON richiede tempo e introduce errori umani. Un generatore gestisce le parti ripetitive così puoi concentrarti sulla logica di business.

Casi d'uso di JSON in C#

Riferimento per la mappatura dei tipi JSON-C#

Ogni tipo di valore JSON si mappa a un tipo C# specifico. Il generatore analizza i valori effettivi per scegliere il tipo più preciso. Ad esempio, un numero JSON senza punto decimale diventa int, mentre 3.14 diventa double. I valori null producono object? (tipo riferimento nullable) poiché il tipo effettivo non può essere dedotto dal solo null.

System.Text.Json vs Newtonsoft.Json

.NET dispone di due principali librerie di serializzazione JSON. Le classi generate da questo strumento usano gli attributi System.Text.Json (JsonPropertyName), l'opzione integrata dal .NET Core 3.0. Se il tuo progetto usa Newtonsoft.Json, puoi sostituire gli attributi.

Esempi di codice

Questi esempi mostrano come definire e usare le classi C# generate da JSON, con entrambe le principali librerie di serializzazione, e come automatizzare la generazione dalla riga di comando.

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

Domande frequenti