JSON vers Classe C#

Qu'est-ce que la conversion JSON vers C# ?

La conversion JSON vers C# est le processus de génération de définitions de classes C# fortement typées à partir de données JSON. Lorsqu'une application .NET reçoit du JSON provenant d'une API, d'un fichier de configuration ou d'une file de messages, elle a besoin de classes C# pour désérialiser ces données en objets. Écrire ces classes à la main est fastidieux et source d'erreurs, surtout lorsque le JSON contient des objets imbriqués, des tableaux et des types mixtes.

Un générateur de classes C# à partir de JSON inspecte la structure et les valeurs de votre JSON, déduit le type C# approprié pour chaque champ et produit des définitions de classes avec des accesseurs de propriétés et des attributs de sérialisation. La sortie suit les conventions de nommage .NET : noms de propriétés en PascalCase, attributs JsonPropertyName pour mapper les clés JSON originales en camelCase ou snake_case, et utilisation correcte de List'<'T'>' pour les tableaux.

Cette conversion est particulièrement courante dans les APIs web ASP.NET Core, les Azure Functions et tout service .NET qui consomme des données JSON externes. Plutôt que d'utiliser dynamic ou Dictionary'<'string, object'>', les classes typées vous offrent la sûreté à la compilation, le support IntelliSense et une protection contre les fautes de frappe dans les noms de champs qui ne se manifesteraient autrement qu'à l'exécution. Collez votre JSON dans cet outil et obtenez des classes C# prêtes à l'emploi instantanément.

Pourquoi utiliser un générateur JSON vers C# ?

Écrire manuellement des classes de modèles C# à partir d'exemples JSON prend du temps et introduit des erreurs humaines. Un générateur prend en charge les parties répétitives afin que tu puisses te concentrer sur la logique métier.

Cas d'usage JSON vers C#

Référence de mappage de types JSON vers C#

Chaque type de valeur JSON se mappe à un type C# spécifique. Le générateur analyse les valeurs réelles pour choisir le type le plus précis. Par exemple, un nombre JSON sans décimale devient int, tandis que 3,14 devient double. Les valeurs null produisent object? (type référence nullable) car le type réel ne peut pas être déduit d'un null seul.

System.Text.Json vs Newtonsoft.Json

.NET dispose de deux grandes bibliothèques de sérialisation JSON. Les classes générées par cet outil utilisent les attributs de System.Text.Json (JsonPropertyName), qui est l'option intégrée depuis .NET Core 3.0. Si ton projet utilise Newtonsoft.Json, tu peux remplacer les attributs.

Exemples de code

Ces exemples montrent comment définir et utiliser des classes C# générées à partir de JSON, avec les deux principales bibliothèques de sérialisation, ainsi que comment automatiser la génération depuis la ligne de commande.

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

Foire aux questions