Chuyển JSON thành struct Go!

Nhập JSON để chuyển thành struct Go có thẻ json! Hỗ trợ Go (Golang) struct, json tags.
JSON
Kết quả

Chuyển JSON thành struct Go!

Chuyển JSON thành định nghĩa struct Go kèm tag encoding/json. Tên field theo quy tắc tên export của Go và danh sách từ viết tắt của golint (ID, URL, API, ...), các cột được căn thẳng như thể code đã qua gofmt.

Công cụ hữu ích khi bạn cần một kiểu để json.Unmarshal payload webhook hay response API vào, một struct body request cho handler net/http, Gin hoặc Echo, hay một struct cấu hình cho CLI.

Cách sử dụng

  1. Dán JSON. Với mảng nhiều dòng, field thiếu ở một số dòng được phát hiện và gắn tag omitempty.
  2. Nhập tên struct cấp cao nhất vào Tên struct (mặc định Root); nó được giữ trong URL dưới dạng ?name=.
  3. Dán kết quả vào file .go và thêm mệnh đề package. Nếu phát hiện field thời gian, import "time" sẽ được thêm vào.
  4. Dùng như var ev WebhookEvent; err := json.Unmarshal(body, &ev).

Ví dụ

Đầu vào (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
}
Đầu ra (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 thành EventID theo quy tắc từ viết tắt của golint, còn created_at, một chuỗi RFC 3339, được suy ra là time.Time, kéo theo import "time". retry_count là null nên không rõ kiểu: nó thành any kèm omitempty.

Tính năng hỗ trợ

  • Tag json:"originalKey" trên mọi field, cộng thêm ,omitempty cho field thiếu ở một số dòng hoặc chứa null.
  • Kiểu giá trị tùy chọn (int, string, bool, struct, time.Time) thành con trỏ (*int) để "không có" khác với giá trị zero. Slice và any vốn đã có thể nil nên không thành con trỏ.
  • Số: int cho số nguyên 32 bit, int64 khi vượt quá, float64 khi có số thập phân.
  • Chuỗi RFC 3339 như 2024-05-01T03:15:00Z được suy ra là time.Time.
  • Các từ viết tắt phổ biến giữ chữ hoa (user_id → UserID, home_url → HomeURL); key bắt đầu bằng chữ số nhận tiền tố Field.
  • Key không thể xuất hiện trong json tag của Go, như "", bị bỏ qua và được liệt kê trong comment phía trên struct.
  • Mảng object ở cấp cao nhất thành struct cho phần tử cộng một comment hướng dẫn unmarshal vào []Root.

Trường hợp sử dụng

Nhận webhook

Dựng struct từ một event mẫu do dịch vụ thanh toán hay Git hosting gửi đến và decode bằng json.NewDecoder(r.Body).Decode(&ev), thay vì type assertion liên tục trên map[string]any.

Bind request trong Gin hoặc Echo

Tạo struct cho c.ShouldBindJSON(&req) từ request mẫu của client, rồi thêm tag binding:"required" ở chỗ cần.

CLI đọc cấu hình JSON

Biến config.json thành struct một lần, rồi chỉ một lời gọi json.Unmarshal sau os.ReadFile là có toàn bộ cấu hình dưới dạng giá trị có kiểu.

Lưu ý và giới hạn

  • time.Time chỉ được suy ra cho chuỗi RFC 3339; giá trị như 2024-05-01 03:15:00 hay Unix timestamp vẫn là string hoặc int.
  • json.Unmarshal mặc định bỏ qua key lạ và so khớp key không phân biệt hoa/thường. Dùng Decoder.DisallowUnknownFields() nếu muốn decode chặt chẽ.
  • int là 64 bit trên nền tảng 64 bit, nhưng int64 chỉ được ghi khi giá trị mẫu vượt 32 bit. Với ID có thể tăng lớn, tự đổi sang int64 sẽ an toàn hơn.
  • Struct lồng nhau đều được định nghĩa thành kiểu cấp cao nhất riêng; không dùng struct inline ẩn danh.
  • Giá trị có kiểu lẫn lộn và giá trị chỉ toàn null thành any; hãy thay khi đã biết kiểu thật.

Câu hỏi thường gặp

Vì sao field tùy chọn lại là con trỏ như *int?

Field int thường sẽ là 0 khi thiếu key, không phân biệt được với số 0 thật. Con trỏ là nil khi key vắng mặt hoặc là null, và cùng với omitempty, key sẽ bị bỏ ra khi bạn marshal lại.

Có đặt tên field bằng chữ thường được không?

encoding/json chỉ đọc và ghi field đã export (viết hoa); field chữ thường bị bỏ qua kể cả khi có tag. Trong Go, tên vẫn viết hoa còn key JSON nằm trong tag.

Field null như retry_count lại ra any.

Khi mẫu chỉ có null thì không có gì để suy ra kiểu. Thêm một response khác có giá trị thật vào mảng rồi chuyển cả hai, hoặc tự đổi thành kiểu như *int.

Có biến struct Go ngược lại thành JSON mẫu được không?

Được. Dán struct vào tab Go struct → JSON ở phía trên; nó đọc tag và tạo JSON ví dụ.