แปลง JSON เป็น Go struct!

ป้อน JSON เพื่อแปลงเป็น Go struct พร้อมแท็ก json! รองรับ Go (Golang) struct, json tags
JSON
ผลลัพธ์

แปลง JSON เป็น Go struct!

แปลง JSON เป็นนิยาม struct ของ Go พร้อมแท็ก encoding/json ชื่อฟิลด์เป็นไปตามกฎชื่อแบบ export ของ Go และรายการตัวย่อของ golint (ID, URL, API, ...) และคอลัมน์ถูกจัดแนวเหมือนผ่าน gofmt มาแล้ว

มีประโยชน์เมื่อต้องการไทป์สำหรับ json.Unmarshal payload ของ webhook หรือ response ของ API, struct ของ request body สำหรับ handler ของ net/http, Gin หรือ Echo หรือ struct คอนฟิกของ CLI

วิธีใช้

  1. วาง JSON ถ้าเป็นอาร์เรย์หลายแถว ฟิลด์ที่ขาดไปในบางแถวจะถูกตรวจพบและติดแท็ก omitempty
  2. ใส่ชื่อ struct ระดับบนสุดใน ชื่อ struct (ค่าเริ่มต้น Root) ค่านี้จะอยู่ใน URL เป็น ?name=
  3. วางผลลัพธ์ลงในไฟล์ .go แล้วเพิ่มบรรทัด package ถ้าพบฟิลด์เวลา จะมี 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"`
}

event_id กลายเป็น EventID ตามกฎตัวย่อของ golint และ created_at ซึ่งเป็นสตริง RFC 3339 ถูกอนุมานเป็น time.Time จึงมีการเพิ่ม import "time" ส่วน retry_count เป็น null จึงไม่รู้ไทป์ และกลายเป็น any ที่มี omitempty

ฟีเจอร์ที่รองรับ

  • ทุกฟิลด์มีแท็ก json:"originalKey" และเพิ่ม ,omitempty ให้ฟิลด์ที่ขาดไปในบางแถวหรือมีค่า null
  • value type ที่ไม่บังคับ (int, string, bool, struct, time.Time) กลายเป็นพอยน์เตอร์ (*int) เพื่อแยก "ไม่มีค่า" ออกจากค่าศูนย์ ส่วน slice และ any เป็น nil ได้อยู่แล้วจึงไม่เป็นพอยน์เตอร์
  • ตัวเลข: int สำหรับจำนวนเต็ม 32 บิต, int64 เมื่อเกินกว่านั้น และ float64 เมื่อมีทศนิยม
  • สตริง RFC 3339 อย่าง 2024-05-01T03:15:00Z ถูกอนุมานเป็น time.Time
  • ตัวย่อที่ใช้กันทั่วไปคงเป็นตัวพิมพ์ใหญ่ (user_id → UserID, home_url → HomeURL) และคีย์ที่ขึ้นต้นด้วยตัวเลขจะได้คำนำหน้า Field
  • คีย์ที่ใส่ในแท็ก json ของ Go ไม่ได้ เช่น "" จะถูกข้ามและระบุไว้ในคอมเมนต์เหนือ struct
  • อาร์เรย์ของออบเจ็กต์ระดับบนสุดจะได้ struct สำหรับสมาชิก พร้อมคอมเมนต์ให้ unmarshal เข้า []Root

กรณีการใช้งาน

ตัวรับ webhook

สร้าง struct จาก event ตัวอย่างที่บริการชำระเงินหรือ Git hosting ส่งมา แล้ว decode ด้วย json.NewDecoder(r.Body).Decode(&ev) แทนการทำ type assertion ซ้ำ ๆ บน map[string]any

การ bind request ใน Gin หรือ Echo

สร้าง struct สำหรับ c.ShouldBindJSON(&req) จากตัวอย่าง request ของไคลเอนต์ แล้วเพิ่มแท็ก binding:"required" ตรงที่ต้องการ

CLI ที่อ่านคอนฟิก JSON

แปลง config.json เป็น struct ครั้งเดียว แล้วเรียก json.Unmarshal ครั้งเดียวหลัง os.ReadFile ก็ได้คอนฟิกทั้งหมดเป็นค่าที่มีไทป์

ข้อควรระวังและข้อจำกัด

  • time.Time จะถูกอนุมานเฉพาะสตริง RFC 3339 ค่าอย่าง 2024-05-01 03:15:00 หรือ Unix timestamp ยังเป็น string หรือ int
  • json.Unmarshal ไม่สนใจคีย์ที่ไม่รู้จักและจับคู่คีย์แบบไม่แยกตัวพิมพ์เป็นค่าเริ่มต้น ถ้าต้องการ decode แบบเข้มงวดให้ใช้ Decoder.DisallowUnknownFields()
  • int มีขนาด 64 บิตบนแพลตฟอร์ม 64 บิต แต่จะเขียน int64 เฉพาะเมื่อค่าตัวอย่างเกิน 32 บิต สำหรับ ID ที่อาจโตขึ้น การเปลี่ยนเป็น int64 เองปลอดภัยกว่า
  • struct ที่ซ้อนกันทั้งหมดถูกนิยามแยกเป็นไทป์ระดับบนสุด ไม่ใช้ anonymous struct แบบ inline
  • ค่าที่ไทป์ปนกันและค่าที่เป็น null อย่างเดียวจะเป็น any ควรเปลี่ยนเมื่อรู้ไทป์จริงแล้ว

คำถามที่พบบ่อย

ทำไมฟิลด์ที่ไม่บังคับถึงเป็นพอยน์เตอร์อย่าง *int?

ฟิลด์ int ธรรมดาจะเป็น 0 เมื่อไม่มีคีย์ ซึ่งแยกไม่ออกจาก 0 จริง พอยน์เตอร์จะเป็น nil เมื่อไม่มีคีย์หรือเป็น null และเมื่อใช้คู่กับ omitempty คีย์นั้นจะถูกตัดออกตอน marshal กลับ

ทำให้ชื่อฟิลด์เป็นตัวพิมพ์เล็กได้ไหม?

encoding/json อ่านและเขียนเฉพาะฟิลด์ที่ export (ขึ้นต้นด้วยตัวพิมพ์ใหญ่) ฟิลด์ตัวพิมพ์เล็กจะถูกข้ามแม้มีแท็ก ใน Go ชื่อฟิลด์จึงขึ้นต้นด้วยตัวพิมพ์ใหญ่และใส่คีย์ JSON ไว้ในแท็ก

ฟิลด์ null อย่าง retry_count ออกมาเป็น any

ถ้าตัวอย่างมีแต่ null ก็ไม่มีข้อมูลให้อนุมานไทป์ ให้เพิ่ม response อีกตัวที่มีค่าจริงลงในอาร์เรย์แล้วแปลงทั้งสองพร้อมกัน หรือแก้เองเป็นอย่าง *int

แปลง Go struct กลับเป็น JSON ตัวอย่างได้ไหม?

ได้ วาง struct ลงในแท็บ Go struct → JSON ด้านบน เครื่องมือจะอ่านแท็กแล้วสร้าง JSON ตัวอย่างให้