GORM 通过 gorm:"table_name:xxx" 控制表名、gorm:"column:xxx" 控制字段名,优先级高于默认蛇形命名;TableName() 方法支持动态逻辑,优先级更高;embedded 需显式声明,not null/type 等约束在 AutoMigrate 中仅对新列生效。

如何用 GORM 的 struct tag 控制表名和字段名
默认情况下,GORM 会把结构体名转成蛇形小写作为表名(如 UserProfile → user_profiles),字段名也按同样规则映射。但多数业务场景需要精确控制——比如对接遗留数据库、避免关键字冲突、或统一前缀。最直接的方式是用 struct tag。
关键 tag 是 gorm:,里面用 table_name 控制表名,column: 控制字段名,primaryKey、not null 等修饰行为。
-
type User struct { ... }上加gorm:"table_name:sys_user",该 struct 全局生效,不再走默认命名逻辑 - 字段上写
gorm:"column:user_id;primaryKey",表示数据库列名是user_id,且是主键;注意:此时 GORM 不再自动识别ID字段为默认主键 - 如果字段名和列名一致,但想禁用某字段映射(比如只读计算字段),用
gorm:"-",例如FullName string `gorm:"-"` - 别漏掉
gorm:"type:varchar(255)"这类类型声明——尤其在迁移时,GORM 不会从 struct 类型反推长度,string默认建varchar(255),但你可能需要text或更长
为什么 TableName() 方法比 tag 更灵活
当表名需要动态生成(比如分表、租户隔离),struct tag 就不够用了。TableName() 是一个方法,返回 string,GORM 在每次操作前都会调用它,所以可以嵌入逻辑。
- 必须定义为指针接收者方法:
func (u *User) TableName() string,否则 GORM 找不到 - 返回值会被直接用作表名,不经过任何转换,所以要自己处理大小写和前缀,例如
return "tenant_" + u.TenantID + "_users" - 注意:这个方法只影响当前 struct 实例的查询/写入,关联表(如
HasMany)不会自动继承,需单独为关联 struct 定义 - 如果同时用了
gorm:"table_name:xxx"和TableName(),后者优先级更高
嵌套结构体和匿名字段的字段映射陷阱
嵌套结构体默认不会展开成字段,除非显式启用。常见误判是以为匿名字段能自动“扁平化”映射到数据库列。
- 匿名字段如
BaseModel加了gorm:"embedded"tag,其字段才会被提升到当前表中,例如ID uint变成id列;否则它只是个普通嵌套对象,GORM 会尝试序列化成 JSON 存进单列(触发driver.Valuer接口) - 嵌入时若字段名冲突(比如两个 embedded struct 都有
CreatedAt),GORM 会 panic,必须用gorm:"embeddedPrefix:log_"加前缀区分 -
gorm:"embedded"不会继承TableName()行为,嵌入的 struct 自己的TableName()完全无效——它根本不会被当独立表用 - 别依赖 IDE 自动补全 tag 内容,
embeddedPrefix拼错成embedded_prefix会导致静默失效,字段照常映射但无前缀
迁移时字段类型与 NULL 约束不生效的原因
很多人写了 gorm:"not null" 却发现数据库列仍是 nullable,或者 type:text 没生效——问题往往出在迁移方式和已有表结构上。
-
AutoMigrate默认只新增列、索引,不会修改已有列的类型或约束。如果列已存在且允许 NULL,not nulltag 不会回填数据或加约束,得手动ALTER TABLE -
typetag 对 MySQL 生效(如type:longtext),但对 SQLite 会被忽略,它只认TEXT;PostgreSQL 则严格区分text和varchar,tag 必须写成type:varchar(100) - 使用
gorm:"default:0"时,GORM 仅在 Go 层做默认赋值,不会给数据库加DEFAULT约束,除非额外加default:0(无冒号)或用serverDefault - 真正保险的做法是:开发期用
AutoMigrate+ 人工核对 SQL 日志;生产环境用显式 migration 文件,不依赖 tag 自动生成
最易被忽略的一点:GORM 的 tag 解析是静态的,所有映射关系在程序启动时就确定了。如果你在运行时修改 struct 定义并热重载(比如插件系统),这些 tag 不会重新扫描——得重启服务或自己实现 registry 重注册逻辑。


















