Tukar JSON kepada struct Go!

Masukkan JSON untuk menukarnya kepada struct Go dengan tag json! Menyokong Go (Golang) struct, json tags.
JSON
Hasil

Tukar JSON kepada struct Go!

Tukar JSON kepada definisi struct Go dengan tag encoding/json. Nama field mengikut peraturan nama eksport Go dan senarai initialism golint (ID, URL, API, ...), dan lajur dijajarkan seolah-olah kod telah melalui gofmt.

Ia berguna apabila anda memerlukan jenis untuk json.Unmarshal payload webhook atau response API, struct body request untuk handler net/http, Gin atau Echo, atau struct konfigurasi untuk CLI.

Cara menggunakan

  1. Tampal JSON. Dengan array beberapa baris, field yang tiada dalam sesetengah baris akan dikesan dan diberi tag omitempty.
  2. Masukkan nama struct peringkat atas dalam Nama struct (lalai Root); ia kekal dalam URL sebagai ?name=.
  3. Tampal hasil ke dalam fail .go dan tambah klausa package. Jika field masa ditemui, import "time" turut disertakan.
  4. Gunakannya sebagai var ev WebhookEvent; err := json.Unmarshal(body, &ev).

Contoh

Input (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
}
Output (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"`
}

event_id menjadi EventID mengikut peraturan initialism golint, dan created_at, iaitu string RFC 3339, disimpulkan sebagai time.Time, yang menambah import "time". retry_count ialah null, jadi jenisnya tidak diketahui: ia menjadi any dengan omitempty.

Ciri yang disokong

  • Tag json:"originalKey" pada setiap field, serta ,omitempty untuk field yang tiada dalam sesetengah baris atau mengandungi null.
  • Jenis nilai opsyenal (int, string, bool, struct, time.Time) menjadi pointer (*int) supaya "tiada" berbeza daripada zero value. Slice dan any memang boleh bernilai nil dan kekal bukan pointer.
  • Nombor: int untuk integer 32-bit, int64 jika melebihinya, float64 apabila ada perpuluhan.
  • String RFC 3339 seperti 2024-05-01T03:15:00Z disimpulkan sebagai time.Time.
  • Initialism biasa kekal dalam huruf besar (user_id → UserID, home_url → HomeURL); kunci yang bermula dengan digit diberi awalan Field.
  • Kunci yang tidak boleh muncul dalam tag json Go, seperti "", dilangkau dan disenaraikan dalam komen di atas struct.
  • Array objek peringkat atas menjadi struct untuk elemennya serta komen untuk unmarshal ke dalam []Root.

Kes penggunaan

Penerima webhook

Bina struct daripada sampel event yang dihantar oleh perkhidmatan pembayaran atau hosting Git dan decode-kannya dengan json.NewDecoder(r.Body).Decode(&ev), daripada membuat type assertion berulang kali pada map[string]any.

Binding request dalam Gin atau Echo

Jana struct untuk c.ShouldBindJSON(&req) daripada sampel request klien, kemudian tambah tag binding:"required" di tempat yang perlu.

CLI yang membaca konfigurasi JSON

Tukar config.json kepada struct sekali sahaja, dan satu json.Unmarshal selepas os.ReadFile memberikan seluruh konfigurasi sebagai nilai berjenis.

Nota dan had

  • time.Time hanya disimpulkan untuk string RFC 3339; nilai seperti 2024-05-01 03:15:00 atau Unix timestamp kekal sebagai string atau int.
  • json.Unmarshal mengabaikan kunci yang tidak dikenali dan memadankan kunci tanpa mengira huruf besar kecil secara lalai. Gunakan Decoder.DisallowUnknownFields() jika anda mahukan decoding yang ketat.
  • int ialah 64-bit pada platform 64-bit, tetapi int64 hanya ditulis apabila nilai sampel melebihi 32 bit. Untuk ID yang boleh membesar, lebih selamat menukarnya sendiri kepada int64.
  • Semua struct bersarang ditakrifkan sebagai jenis peringkat atas yang berasingan; tiada anonymous inline struct digunakan.
  • Nilai berjenis campuran dan nilai yang hanya pernah null menjadi any; gantikannya apabila jenis sebenar diketahui.

Soalan lazim

Kenapa field opsyenal menjadi pointer seperti *int?

Field int biasa bernilai 0 apabila kunci tiada, dan tidak dapat dibezakan daripada 0 yang sebenar. Pointer bernilai nil apabila kunci tiada atau null, dan bersama omitempty kunci itu ditinggalkan apabila anda marshal semula.

Bolehkah saya menjadikan nama field huruf kecil?

encoding/json hanya membaca dan menulis field yang dieksport (bermula dengan huruf besar); field huruf kecil diabaikan walaupun ada tag. Dalam Go, nama kekal bermula dengan huruf besar dan kunci JSON diletakkan dalam tag.

Field null seperti retry_count keluar sebagai any.

Dengan hanya null dalam sampel, tiada apa-apa untuk menyimpulkan jenis. Tambah satu lagi response yang mempunyai nilai sebenar ke dalam array dan tukar kedua-duanya, atau tukarkannya secara manual kepada sesuatu seperti *int.

Bolehkah saya menukar struct Go kembali kepada JSON sampel?

Boleh. Tampal struct ke dalam tab Go struct → JSON di bahagian atas; ia membaca tag dan menghasilkan contoh JSON.