JSON به کلاس C#

تبدیل JSON به C# چیست؟

تبدیل JSON به C# فرایند تولید تعریف کلاس‌های C# با strongly typed از داده‌های JSON است. وقتی یک برنامه .NET داده JSON از یک API، فایل پیکربندی یا صف پیام دریافت می‌کند، برای تبدیل آن داده به اشیا به کلاس‌های C# نیاز دارد. نوشتن این کلاس‌ها به‌صورت دستی خسته‌کننده و مستعد خطاست، به‌ویژه وقتی JSON شامل اشیاء تودرتو، آرایه‌ها و نوع‌های ترکیبی است.

یک مولد کلاس C# از JSON ساختار و مقادیر JSON شما را بررسی می‌کند، نوع مناسب C# را برای هر فیلد استنتاج می‌کند، و تعریف کلاس‌ها را با accessor های ویژگی و ویژگی‌های سریال‌سازی تولید می‌کند. خروجی از قراردادهای نام‌گذاری .NET پیروی می‌کند: نام ویژگی‌ها به‌صورت PascalCase، ویژگی‌های JsonPropertyName برای نگاشت به کلیدهای JSON اصلی با فرمت camelCase یا snake_case، و استفاده صحیح از List'<'T'>' برای آرایه‌ها.

این تبدیل به‌ویژه در web API های ASP.NET Core، Azure Functions، و هر سرویس .NET که داده JSON خارجی مصرف می‌کند رایج است. به‌جای استفاده از dynamic یا Dictionary'<'string, object'>'، کلاس‌های نوع‌بندی‌شده ایمنی در زمان کامپایل، پشتیبانی IntelliSense، و محافظت در برابر اشتباه تایپی در نام فیلدها را فراهم می‌کنند که در غیر این صورت فقط در زمان اجرا آشکار می‌شوند. JSON خود را در این ابزار پیست کنید و کلاس‌های C# آماده استفاده را فوری دریافت کنید.

چرا از مولد JSON به C# استفاده کنیم؟

نوشتن دستی کلاس‌های مدل C# از نمونه‌های JSON زمان می‌برد و خطای انسانی ایجاد می‌کند. یک مولد بخش‌های تکراری را مدیریت می‌کند تا بتوانید روی منطق تجاری تمرکز کنید.

موارد استفاده JSON به C#

جدول مرجع نگاشت نوع JSON به C#

هر نوع مقدار JSON به یک نوع C# خاص نگاشت می‌شود. مولد مقادیر واقعی را تحلیل می‌کند تا دقیق‌ترین نوع را انتخاب کند. به‌عنوان مثال، یک عدد JSON بدون نقطه اعشار به int تبدیل می‌شود، در حالی که 3.14 به double تبدیل می‌شود. مقادیر null نوع object? (نوع مرجع nullable) تولید می‌کنند زیرا نوع واقعی را نمی‌توان تنها از null استنتاج کرد.

System.Text.Json در مقابل Newtonsoft.Json

.NET دو کتابخانه اصلی سریال‌سازی JSON دارد. کلاس‌های تولیدشده توسط این ابزار از ویژگی‌های System.Text.Json (JsonPropertyName) استفاده می‌کنند که از .NET Core 3.0 گزینه داخلی است. اگر پروژه شما از Newtonsoft.Json استفاده می‌کند، می‌توانید ویژگی‌ها را جابجا کنید.

نمونه کد

این مثال‌ها نشان می‌دهند چگونه کلاس‌های C# تولیدشده از JSON را با استفاده از هر دو کتابخانه اصلی سریال‌سازی تعریف و استفاده کنید، به‌علاوه نحوه خودکارسازی تولید از خط فرمان.

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

سوالات متداول