Теги полей и JSON

Теги в полях структуры представляют собой строки метаданных, считываемые посредством отражения. такими библиотеками, как encoding/json, encoding/xml, валидаторами, ORM. Они записываются между обратными кавычками (необработанной строкой) сразу после типа поля.

Синтаксис

type User struct {
    Name string `json:"nome"`
    Age  int    `json:"eta,omitempty"`
}

Соглашение о формате: key:"value", разделенные пробелами (НЕ запятые) для нескольких ключей:

type User struct {
    Email string `json:"email" validate:"required,email"`
}

Тег json: параметры

Наиболее распространенный вариант — json, используемый encoding/json:

type User struct {
    Name     string `json:"nome"`
    Age      int    `json:"eta,omitempty"`
    Password string `json:"-"`
}

u := User{Name: "Ada", Age: 0, Password: "segreto"}
b, _ := json.Marshal(u)
fmt.Println(string(b))   // {"nome":"Ada"}

Age опущен (нулевое значение 0 + omitempty); Password — это исключено полностью.

Маршал и унмаршал

// struct -> JSON
b, err := json.Marshal(u)

// JSON -> struct (needs a POINTER)
var u2 User
err = json.Unmarshal(b, &u2)

Unmarshal принимает только указатель, поскольку он должен записывать в поля значений.

Другие распространенные теги

• xml:"..." — encoding/xml
• yaml:"..." — yaml.v3
• db:"..." — sqlx/pgx
• validate:"..." — го-площадка/валидатор
• form:"..." — привязка джин/эхо

Библиотеки читают их посредством отражения (reflect.StructTag.Get("json")): это всего лишь строки, пока кто-нибудь их не интерпретирует.

Попробуйте это

u := User{Name: "Ada", Age: 36}
b, _ := json.Marshal(u)
fmt.Println(string(b))

Резюме

• Теги представляют собой необработанные строки между обратными кавычками: `key:"value" key2:"value2"`.
• json:"nome": переименовать. omitempty: пропустить, если значение равно нулю. -: исключить.
• НЕэкспортируемые поля (строчные) игнорируются encoding/json.
• json.Marshal(v) ↔ json.Unmarshal(data, &v) (указатель).
• Тот же механизм для xml, yaml, db, validate, form, …