一文详解下划线字段在 Golang 结构体中的应用

在 Go 语言的结构体（struct）中，下划线字段（如 _ field 或 _） 是一种特殊用法，主要用于处理 JSON/XML 解析时的字段映射、数据库 ORM 映射、空字段占位或显式忽略某些数据。虽然下划线本身不是 Go 语言的关键字，但在结构体标签（struct tag）和字段命名中，它常被赋予特定语义。以下是下划线字段在 Go 结构体中的典型应用场景及详细说明。

一、基础概念：Go 结构体字段的组成

Go 结构体的字段由 字段名（Name） 和 字段类型（Type） 组成，通常还包含 结构体标签（Struct Tag）（如 `json:"xxx"`）。例如：

type User struct {
    Name string `json:"name"`  // 标准字段：字段名 Name，JSON 映射为 name
    Age  int    `json:"age"`   // 标准字段：字段名 Age，JSON 映射为 age
}

而下划线字段的常见形式包括：

字段名以下划线开头（如 _id）：通常用于特殊语义（如 MongoDB 的 _id 主键）。
字段名仅为下划线（如 _）：通常用于忽略某些值（如函数返回的多值中忽略部分结果）。
结构体标签中包含下划线（如 `json:"_"`）：显式声明字段在序列化/反序列化时被忽略。

二、核心应用场景详解

场景 1：JSON/XML 序列化中忽略字段

通过结构体标签 `json:"_"` 或 `xml:"-"`，可以显式声明某个字段在序列化（转 JSON/XML）或反序列化（从 JSON/XML 解析）时被忽略。

示例：忽略字段

type User struct {
    Name string `json:"name"`  // 正常映射到 JSON 的 name 字段
    Age  int    `json:"_"`     // JSON 序列化/反序列化时忽略此字段
}

func main() {
    u := User{Name: "Alice", Age: 25}
    data, _ := json.Marshal(u)
    fmt.Println(string(data)) // 输出: {"name":"Alice"}（Age 被忽略）
}

作用：Age 字段虽然存在于结构体中，但由于标签为 `json:"_"`，在转换为 JSON 时不会包含该字段。
对比：若字段无标签（如 Age int），默认会以字段名的小写形式（age）出现在 JSON 中；若标签为 `json:"-"`（减号），则是更标准的“忽略”写法（推荐优先用 -）。

⚠️ 注意：严格来说，`json:"_"` 表示将字段映射到 JSON 的 _ 键（虽然极少使用），而 **`json:"-"` 才是标准写法，表示完全忽略该字段**。实际开发中若想忽略字段，优先用 `json:"-"` 或 `xml:"-"`。

场景 2：数据库 ORM 映射中的特殊字段

在使用 ORM（如 GORM、XORM）时，下划线字段常用于处理数据库表的特殊列（如主键、自增 ID、软删除标记等），或忽略某些不需要持久化的字段。

示例 1：GORM 中的主键 `_id`（MongoDB 风格）

许多 NoSQL 数据库（如 MongoDB）使用 _id 作为主键。在 Go 结构体中，可以通过标签指定该字段映射到数据库的 _id 列：

type MongoUser struct {
    ID    primitive.ObjectID `bson:"_id,omitempty"` // MongoDB 的 _id 主键，使用 bson 标签
    Name  string             `bson:"name"`
}

// 或使用 GORM 操作关系型数据库时，自定义主键列名（如 _id）
type SQLUser struct {
    ID   int    `gorm:"column:_id;primaryKey"` // 映射到数据库的 _id 列
    Name string `gorm:"column:name"`
}

作用：_id 是数据库表的保留列名（如 MongoDB 的默认主键），通过结构体标签显式声明映射关系。

示例 2：忽略不需要持久化的字段

若结构体中包含临时计算字段（如缓存值、衍生状态），但不需要存入数据库，可通过标签 `gorm:"-"` 或 `json:"-"` 忽略：

type Product struct {
    ID       int     `gorm:"primaryKey"`
    Name     string  `gorm:"column:name"`
    Price    float64 `gorm:"column:price"`
    TempCalc int     `gorm:"-"` // 临时计算字段，不存入数据库
}

作用：TempCalc 字段仅用于内存中的临时计算，不会被 ORM 操作（如 Create/Save）持久化到数据库。

场景 3：函数返回值中忽略部分结果

虽然不是结构体字段，但 Go 语言中常用下划线 _ 作为变量名，表示忽略函数的某个返回值（例如读取文件时忽略错误码，或解析数据时忽略多余字段）。

示例：忽略函数返回的错误

data, _ := ioutil.ReadFile("config.json") // 忽略可能的错误（不推荐生产环境使用）

类比结构体：在结构体中，字段名 _ 或标签中的下划线也有类似的“忽略”语义（如忽略序列化字段）。

场景 4：显式占位或预留字段

在某些场景下，开发者可能通过下划线字段（如 _reserved）显式占位，表示该位置为未来扩展预留，或用于内部调试（但不希望外部直接访问）。

示例：预留字段

type Config struct {
    APIKey    string `json:"api_key"`
    Timeout   int    `json:"timeout"`
    _Reserved string `json:"-"` // 内部预留字段，不参与序列化
}

作用：_Reserved 字段可能用于内部测试或未来功能扩展，但通过标签 `json:"-"` 确保不会被序列化暴露给外部。

三、常见误区与注意事项

1. 下划线字段名 vs 标签中的下划线

字段名以下划线开头（如 _id）：是合法的 Go 变量名（Go 不禁止以下划线开头的标识符），通常用于特殊语义（如数据库主键）。但需注意：Go 的导出规则要求字段名首字母大写才能被外部包访问（如 _ID 可导出，_id 不可导出）。 type User struct { _ID string // 不可导出（小写下划线开头），仅包内可用 Name string // 可导出（首字母大写） }
标签中的下划线（如 `json:"_"`）：表示将该字段映射到 JSON 的 _ 键（极少使用），但更常见的“忽略”写法是 `json:"-"`（减号）。

2. 推荐的标准忽略写法

若目标是 忽略字段的序列化/反序列化，优先使用标准标签值 -（减号）而非 _：

type User struct {
    Name string `json:"name"`
    Age  int    `json:"-"` // 标准写法：忽略 Age 字段（推荐）
}

原因：`json:"-"` 是 Go 生态中广泛认可的“忽略字段”标准，而 `json:"_"` 可能被误解为映射到 JSON 的 _ 键（实际很少需要这种场景）。

3. ORM 框架的特定标签

不同 ORM 框架（如 GORM、XORM）对下划线字段的处理可能不同，需参考具体文档：

GORM：通过 `gorm:"column:_id"` 指定数据库列名，或 `gorm:"-"` 忽略字段。
XORM：通过 `xorm:"'_id'"` 指定列名。

四、总结：下划线字段的核心用途

应用场景	典型写法	作用
JSON/XML 序列化忽略字段	`json:"-"` 或 `xml:"-"` “	声明字段不参与序列化/反序列化（推荐标准写法）。
映射数据库特殊列（如 _id）	`gorm:"column:_id"`	指定字段与数据库的保留列名（如 MongoDB 的 `_id`）关联。
忽略临时/内部字段	“ `json:"-"` 或字段名 `_`	避免临时计算字段或调试字段被持久化或暴露。
函数返回值忽略部分结果	`_` 变量名（非结构体字段）	忽略函数返回的多余值（如错误码），类比结构体中“忽略”的语义。