JSON کو C# class میں تبدیل کریں!

JSON درج کریں اور nested objects سمیت C# class کوڈ بنائیں! System.Text.Json [JsonPropertyName], .NET, ASP.NET Core سپورٹ۔
JSON
نتیجہ
 

JSON کو C# class میں تبدیل کریں!

JSON کو System.Text.Json کے لیے C# کلاسز میں تبدیل کریں۔ property نام PascalCase میں بدلے جاتے ہیں، اور ہر property پر [JsonPropertyName] attribute ہوتا ہے تاکہ وہ بالکل اصل key سے bind ہو۔

یہ ASP.NET Core کے request اور response ماڈلز، بیرونی APIs کو HttpClient.GetFromJsonAsync<T>() calls کے لیے types، اور Unity یا MAUI ایپس میں ڈیٹا کلاسز کے لیے کاپی کر کے ٹائپ کرنے کی محنت بچاتا ہے۔

استعمال کا طریقہ

  1. JSON response یا configuration فائل پیسٹ کریں۔
  2. ٹائپ کا نام میں root کلاس کا نام لکھیں (مثلاً PaymentResult)۔
  3. بنائی گئی کلاسز کو .cs فائل میں ڈالیں اور اپنا namespace شامل کریں۔
  4. اسے JsonSerializer.Deserialize<PaymentResult>(json) یا GetFromJsonAsync<PaymentResult>(url) کے ساتھ استعمال کریں۔

مثال

ان پٹ (JSON)
{
  "paymentId": "pay_8f2k",
  "amount": 15000,
  "currency": "KRW",
  "approved": true,
  "approvedAt": "2024-05-01T12:30:00Z",
  "card": { "issuer": "VISA", "last4": "4242" },
  "metadata": null
}
آؤٹ پٹ (C# · System.Text.Json)
using System.Collections.Generic;
using System.Text.Json;
using System.Text.Json.Serialization;

public class PaymentResult
{
    [JsonPropertyName("paymentId")]
    public string PaymentId { get; set; } = string.Empty;

    [JsonPropertyName("amount")]
    public int Amount { get; set; }

    [JsonPropertyName("currency")]
    public string Currency { get; set; } = string.Empty;

    [JsonPropertyName("approved")]
    public bool Approved { get; set; }

    [JsonPropertyName("approvedAt")]
    public string ApprovedAt { get; set; } = string.Empty;

    [JsonPropertyName("card")]
    public Card Card { get; set; } = new();

    [JsonPropertyName("metadata")]
    public JsonElement? Metadata { get; set; }
}

public class Card
{
    [JsonPropertyName("issuer")]
    public string Issuer { get; set; } = string.Empty;

    [JsonPropertyName("last4")]
    public string Last4 { get; set; } = string.Empty;
}

ہر property پر [JsonPropertyName] ہے، اس لیے paymentId ↔ PaymentId casing قواعد سے قطع نظر میل کھاتے ہیں۔ metadata ہمیشہ null ہی ہے، اس لیے اس کی type نامعلوم ہے اور یہ JsonElement? بنتا ہے۔ string اور آبجیکٹ properties کو string.Empty / new() initializers ملتے ہیں تاکہ کوڈ nullable warnings کے بغیر compile ہو۔

معاون خصوصیات

  • ہر property پر [JsonPropertyName("originalKey")]، using System.Text.Json.Serialization; کے ساتھ۔
  • types: string، int، 32 bits سے بڑے integers کے لیے long، decimals کے لیے double، bool، اور arrays کے لیے List<T>۔
  • ملی جلی یا نامعلوم type والی values، JsonElement بنتی ہیں، اور using System.Text.Json; شامل ہو جاتا ہے۔
  • کچھ items میں غائب یا null والی properties، nullable (int?، string?) بنتی ہیں۔
  • nullable reference warning CS8618 سے بچنے کے لیے لازمی properties کو = string.Empty; یا = new(); initializers ملتے ہیں۔
  • C# میں property کا اپنی کلاس کے نام والا ہونا جائز نہیں، اس لیے ایسی property کو Value لاحقہ ملتا ہے (مثلاً RootValue)۔
  • سب سے اوپر کی array سے // Root: List<RootItem> comment اور element کلاس ملتی ہے۔

استعمال کے کیس

HttpClient سے بیرونی APIs کال کرنا

ادائیگی یا shipment-tracking API کا نمونہ response تبدیل کریں اور اسے JsonDocument سے ایک ایک فیلڈ نکالنے کے بجائے await http.GetFromJsonAsync<PaymentResult>(url) میں type کے طور پر استعمال کریں۔

ASP.NET Core میں webhook payload ماڈلز

کوئی third-party سروس آپ کو جو payload بھیجتی ہے اس سے کلاسز بنائیں اور انہیں [FromBody] parameter کے طور پر قبول کریں، تاکہ model binding اور validation معمول کے مطابق کام کریں۔

appsettings اور گیم ڈیٹا فائلیں

Unity یا console ایپ کی پڑھی جانے والی JSON ڈیٹا فائل کا ڈھانچہ کلاسز سے باندھنے کا مطلب ہے کہ ڈیٹا فائل بدلنے پر فوراً deserialization error سامنے آ جاتی ہے۔

نوٹس اور حدود

  • Newtonsoft.Json ([JsonProperty]) والا آؤٹ پٹ نہیں بنتا۔ اگر آپ Json.NET استعمال کرتے ہیں تو attributes کو [JsonProperty("key")] میں بدلیں۔
  • تاریخ والی strings، string رہتی ہیں۔ ISO 8601 values کے لیے type کو DateTime یا DateTimeOffset کرنا System.Text.Json کے parse کرنے کے لیے کافی ہے۔
  • target-typed new() اور string?، C# 9+ اور فعال nullable context فرض کرتے ہیں (.NET 6 سے ڈیفالٹ)۔
  • کوئی record یا required آؤٹ پٹ نہیں۔ ناقابلِ تبدیل ماڈلز کے لیے { get; set; } کو { get; init; } کر دیں۔
  • تمام کلاسز ایک ہی بلاک میں آتی ہیں؛ فائلیں اور namespaces خود تقسیم کریں۔

عام سوالات

key پہلے سے میل کھانے پر بھی [JsonPropertyName] کیوں لگایا جاتا ہے؟

System.Text.Json بطور ڈیفالٹ case-sensitive ہے۔ custom JsonSerializerOptions کے بغیر console یا worker پروجیکٹس میں paymentId، PaymentId سے bind نہیں ہوگا، اس لیے configuration سے قطع نظر کام کرنے کی خاطر attribute ہمیشہ لکھا جاتا ہے۔

JsonElement? property کیسے پڑھوں؟

ValueKind چیک کریں، پھر GetString()، GetInt32() یا Deserialize<T>() استعمال کریں۔ جب اصل type معلوم ہو جائے تو JsonElement کو اس سے بدل دینا زیادہ صاف طریقہ ہے۔

کیا میں camelCase property نام رکھ سکتا ہوں؟

آؤٹ پٹ C# کے PascalCase رواج پر چلتا ہے۔ اصل key، [JsonPropertyName] میں ہوتی ہے، اس لیے جب تک attribute رہے آپ properties کے نام آزادانہ بدل سکتے ہیں۔

کیا یہ Unity کے JsonUtility کے ساتھ چلتا ہے؟

JsonUtility صرف [Serializable] کلاسز کے public fields سنبھالتا ہے، properties نہیں، اور [JsonPropertyName] کو نظر انداز کرتا ہے۔ Unity میں آؤٹ پٹ کو اس کے بجائے Newtonsoft.Json package یا System.Text.Json کے ساتھ استعمال کریں۔