Go 结构体标签 (Struct Tags) 深度解析与实用指南

type MyStruct struct {
    FieldName FieldType `key:"value" anotherKey:"anotherValue"`
}

package main

import (
    "encoding/json"
    "fmt"
)

// User 结构体定义，包含各种 JSON 标签
type User struct {
    ID        int    `json:"user_id"`                  // 自定义键名 "user_id"
    Username  string `json:"username,omitempty"`       // 自定义键名，且为空时忽略
    Email     string `json:"-"`                        // 忽略此字段
    Age       int    `json:",omitempty"`               // 使用默认键名 "Age"，但为空时忽略
    CreatedAt string `json:"created_at"`               // 自定义键名 "created_at"
    IsActive  bool   `json:"active_status,omitempty"`  // 自定义键名，且为空时忽略
}

func main() {
    // --- 序列化 (Marshal) 示例 ---
    fmt.Println("--- JSON 序列化示例 ---")

    // 示例 1: 所有字段都有值
    user1 := User{
        ID:        101,
        Username:  "alice_smith",
        Email:     "alice@example.com",
        Age:       30,
        CreatedAt: "2023-01-01T10:00:00Z",
        IsActive:  true,
    }
    jsonData1, err := json.MarshalIndent(user1, "", "  ") // 使用 MarshalIndent 格式化输出
    if err != nil {
        fmt.Println("序列化错误:", err)
        return
    }
    fmt.Println("用户1 (所有字段有值):")
    fmt.Println(string(jsonData1))
    /* 预期输出:
    {
      "user_id": 101,
      "username": "alice_smith",
      "Age": 30,
      "created_at": "2023-01-01T10:00:00Z",
      "active_status": true
    }
    注意: Email 字段被忽略，因为 `json:"-"`。
    */

    fmt.Println("\n--------------------")

    // 示例 2: 部分字段为空值或零值
    user2 := User{
        ID:        102,
        Username:  "", // 空字符串
        Email:     "bob@example.com",
        Age:       0,  // 零值
        CreatedAt: "2023-02-01T11:00:00Z",
        IsActive:  false, // 零值
    }
    jsonData2, err := json.MarshalIndent(user2, "", "  ")
    if err != nil {
        fmt.Println("序列化错误:", err)
        return
    }
    fmt.Println("用户2 (部分字段为空/零值):")
    fmt.Println(string(jsonData2))
    /* 预期输出:
    {
      "user_id": 102,
      "created_at": "2023-02-01T11:00:00Z"
    }
    注意: Username, Age, IsActive 因 `omitempty` 且值为零而被忽略。
    Email 因 `json:"-"` 被忽略。
    */

    // --- 反序列化 (Unmarshal) 示例 ---
    fmt.Println("\n--- JSON 反序列化示例 ---")

    jsonString := `{
        "user_id": 201,
        "username": "charlie_brown",
        "Email": "charlie@example.com",
        "Age": 25,
        "created_at": "2023-03-01T12:00:00Z",
        "active_status": true
    }`
    var user3 User
    err = json.Unmarshal([]byte(jsonString), &user3)
    if err != nil {
        fmt.Println("反序列化错误:", err)
        return
    }
    fmt.Println("反序列化后的用户3:")
    fmt.Printf("ID: %d, Username: %s, Email: %s, Age: %d, CreatedAt: %s, IsActive: %t\n",
        user3.ID, user3.Username, user3.Email, user3.Age, user3.CreatedAt, user3.IsActive)
    /* 预期输出:
    ID: 201, Username: charlie_brown, Email: , Age: 25, CreatedAt: 2023-03-01T12:00:00Z, IsActive: true
    注意: 尽管 JSON 字符串中包含 "Email" 字段，但由于 User 结构体中 Email 字段的 `json:"-"` 标签，
    它在反序列化时被忽略，所以 user3.Email 仍然是其零值（空字符串）。
    */
}

package main

import (
    "fmt"
    "reflect"
)

type ServerConfig struct {
    Host string `env:"SERVER_HOST" default:"localhost"`
    Port int    `env:"SERVER_PORT" default:"8080"`
    Debug bool  `env:"DEBUG_MODE" default:"false"`
}

func main() {
    configType := reflect.TypeOf(ServerConfig{})

    for i := 0; i < configType.NumField(); i++ {
        field := configType.Field(i) // 获取结构体的每个字段

        // 获取字段的标签
        tag := field.Tag

        // 使用 Tag.Get("key") 方法获取特定键的值
        envTagValue := tag.Get("env")
        defaultTagValue := tag.Get("default")

        fmt.Printf("字段名: %s\n", field.Name)
        fmt.Printf("  env 标签值: %s\n", envTagValue)
        fmt.Printf("  default 标签值: %s\n", defaultTagValue)
        fmt.Println("---")
    }
}