JSON کو Go struct میں تبدیل کریں!

JSON درج کریں اور اسے json ٹیگ والے Go struct میں تبدیل کریں! Go (Golang) struct, json tags سپورٹ۔
JSON
نتیجہ

JSON کو Go struct میں تبدیل کریں!

JSON کو encoding/json tags والی Go struct definitions میں تبدیل کریں۔ فیلڈ نام Go کے exported-name اصول اور golint کی initialisms فہرست (ID، URL، API، ...) کے مطابق ہوتے ہیں، اور کالمز ایسے align ہوتے ہیں جیسے کوڈ gofmt سے گزرا ہو۔

یہ تب مفید ہے جب آپ کو webhook payload یا API response کو json.Unmarshal کرنے کے لیے type چاہیے، net/http، Gin یا Echo handlers کے لیے request-body struct، یا CLI کے لیے config struct۔

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

  1. JSON پیسٹ کریں۔ کئی rows والی array دینے پر کچھ rows میں غائب فیلڈز پہچان لیے جاتے ہیں اور ان پر omitempty tag لگتا ہے۔
  2. Struct کا نام میں سب سے اوپر والے struct کا نام لکھیں (ڈیفالٹ Root)؛ یہ URL میں ?name= کے طور پر رہتا ہے۔
  3. نتیجہ .go فائل میں پیسٹ کریں اور package clause شامل کریں۔ اگر وقت والے فیلڈز ملے ہوں تو import "time" شامل ہوتا ہے۔
  4. اسے var ev WebhookEvent; err := json.Unmarshal(body, &ev) کی طرح استعمال کریں۔

مثال

ان پٹ (JSON)
{
  "event_id": "evt_1Pq",
  "type": "invoice.paid",
  "created_at": "2024-05-01T03:15:00Z",
  "amount_cents": 4999,
  "customer": { "id": "cus_9", "email": "kim@example.com" },
  "retry_count": null
}
آؤٹ پٹ (Go)
import "time"

type WebhookEvent struct {
	EventID     string    `json:"event_id"`
	Type        string    `json:"type"`
	CreatedAt   time.Time `json:"created_at"`
	AmountCents int       `json:"amount_cents"`
	Customer    Customer  `json:"customer"`
	RetryCount  any       `json:"retry_count,omitempty"`
}

type Customer struct {
	ID    string `json:"id"`
	Email string `json:"email"`
}

golint کے initialism اصول کے تحت event_id بنتا ہے EventID، اور RFC 3339 string والا created_at، time.Time اندازہ لگایا جاتا ہے، جس سے import "time" شامل ہوتا ہے۔ retry_count، null ہے، اس لیے اس کی type نامعلوم ہے: یہ omitempty کے ساتھ any بنتا ہے۔

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

  • ہر فیلڈ پر json:"originalKey" tag، اور کچھ rows میں غائب یا null والے فیلڈز پر ,omitempty۔
  • اختیاری value types (int، string، bool، structs، time.Time) pointers (*int) بنتی ہیں تاکہ "غیر موجود" اور zero value میں فرق رہے۔ slices اور any پہلے ہی nil ہو سکتے ہیں اس لیے pointer نہیں بنتے۔
  • نمبر: 32-bit integers کے لیے int، اس سے بڑے کے لیے int64، decimals آنے پر float64۔
  • 2024-05-01T03:15:00Z جیسی RFC 3339 strings کا اندازہ time.Time لگایا جاتا ہے۔
  • عام initialisms بڑے حروف میں رہتے ہیں (user_id → UserID، home_url → HomeURL)؛ ہندسے سے شروع ہونے والی keys کے آگے Field prefix لگتا ہے۔
  • جو keys Go json tag میں نہیں آ سکتیں، جیسے ""، چھوڑ دی جاتی ہیں اور struct کے اوپر comment میں درج کی جاتی ہیں۔
  • objects کی سب سے اوپر والی array سے element کے لیے struct اور []Root میں unmarshal کرنے کا comment بنتا ہے۔

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

webhook وصول کرنے والے

ادائیگی یا Git hosting سروس کے بھیجے گئے نمونہ event سے struct بنائیں اور map[string]any پر بار بار type assertions کرنے کے بجائے اسے json.NewDecoder(r.Body).Decode(&ev) سے decode کریں۔

Gin یا Echo میں request binding

client request کے نمونے سے c.ShouldBindJSON(&req) کے لیے struct بنائیں، پھر جہاں ضرورت ہو binding:"required" tags شامل کریں۔

JSON config پڑھنے والے CLIs

config.json کو ایک بار struct میں بدلیں، اور os.ReadFile کے بعد ایک json.Unmarshal سے پوری config typed values کی صورت میں مل جاتی ہے۔

نوٹس اور حدود

  • time.Time کا اندازہ صرف RFC 3339 strings کے لیے لگایا جاتا ہے؛ 2024-05-01 03:15:00 جیسی values یا Unix timestamps، string یا int رہتے ہیں۔
  • json.Unmarshal بطور ڈیفالٹ نامعلوم keys نظر انداز کرتا ہے اور keys کو case-insensitive طریقے سے ملاتا ہے۔ سخت decoding چاہیے تو Decoder.DisallowUnknownFields() استعمال کریں۔
  • 64-bit platforms پر int بھی 64-bit ہوتا ہے، لیکن int64 صرف تب لکھا جاتا ہے جب کوئی نمونہ value 32 bits سے بڑی ہو۔ بڑھ سکنے والی IDs کے لیے خود int64 کر دینا زیادہ محفوظ ہے۔
  • تمام nested structs الگ top-level types کے طور پر بیان ہوتے ہیں؛ کوئی anonymous inline structs استعمال نہیں ہوتے۔
  • ملی جلی type والی values اور ہمیشہ null رہنے والی values، any بنتی ہیں؛ اصل type معلوم ہونے پر انہیں بدل دیں۔

عام سوالات

اختیاری فیلڈز *int جیسے pointers کیوں ہیں؟

سادہ int فیلڈ key غائب ہونے پر 0 ہوتا ہے، جو اصلی 0 سے الگ نہیں پہچانا جا سکتا۔ pointer، key غائب یا null ہونے پر nil ہوتا ہے، اور omitempty کے ساتھ دوبارہ marshal کرنے پر key چھوڑ دی جاتی ہے۔

کیا میں فیلڈ نام چھوٹے حروف میں رکھ سکتا ہوں؟

encoding/json صرف exported (بڑے حرف والے) فیلڈز پڑھتا اور لکھتا ہے؛ چھوٹے حروف والے فیلڈز tag کے باوجود نظر انداز ہوتے ہیں۔ Go میں نام بڑے حرف ہی سے رہتے ہیں اور JSON key، tag میں جاتی ہے۔

retry_count جیسا null فیلڈ any کی صورت میں آیا۔

نمونے میں صرف null ہونے پر type کا اندازہ لگانے کو کچھ نہیں ہوتا۔ کسی array میں اصلی value والا دوسرا response شامل کر کے دونوں تبدیل کریں، یا اسے ہاتھ سے *int جیسی type میں بدل دیں۔

کیا میں Go struct کو واپس نمونہ JSON میں بدل سکتا ہوں؟

جی ہاں۔ struct کو اوپر کے Go struct → JSON ٹیب میں پیسٹ کریں؛ وہ tags پڑھ کر مثالی JSON بناتا ہے۔