GORM 标签使用

Double`C 收录于技术

2025-01-12 约 200 字预计阅读 1 分钟

一、 GORM 标签简介

GORM 的标签是一种特殊的属性，可以附加在模型的字段上。这些标签在 GORM 执行 CRUD 操作时起作用，它们可以用来定义字段的数据库映射、验证规则、业务逻辑等。通过合理地使用标签，我们可以减少大量的样板代码，使业务逻辑更加清晰。

二、 GORM 标签的分类

数据库相关标签

gorm:“column:name;primary_key;type:string” 这个标签指定了字段在数据库中对应的列名、是否为主键以及数据类型。

验证相关标签

gorm:“size:10;not_blank;” 这个标签指定了字段的长度限制和是否允许为空值。

业务逻辑标签

gorm:“before_save:do_something” 这个标签定义了在保存记录之前需要执行的业务逻辑。

三、 GORM 标签的使用场景

字段映射

当数据库的表结构与 Go 模型的字段名称不完全匹配时，可以使用 gorm:“column:name” 来指定映射关系。示例：数据库中有一个名为 user_id 的字段，而 Go 模型中对应的字段名为 UserId。在这种情况下，我们可以在模型中这样定义：

1
2
3
4


type User struct {
    gorm.Model
    UserId int `gorm:"column:user_id"`
}

验证规则

使用 GORM 提供的验证标签，如 required, email, max:size 等，可以在模型层对输入数据进行验证。示例：假设我们有一个 Registration 结构体，它代表了用户注册信息，其中 Email 和 Password 字段必须填写，且 Email 必须是有效的电子邮箱格式。我们可以这样定义模型：

1
2
3
4
5


type Registration struct {
    gorm.Model
    Email string `gorm:"size:100;validation:Email"`
    Password string `gorm:"size:30;validation:Required"`
}

业务逻辑

在某些业务场景中，我们可能需要在数据持久化到数据库之前或之后执行特定的业务逻辑。GORM 的生命周期钩子（如 BeforeSave 和 AfterCreate）正是为这些场景设计的。

字段标签

声明 model 时，tag 是可选的，GORM 支持以下 tag： tag 名大小写不敏感，但建议使用 camelCase 风格。

标签名	说明
`column`	指定 db 列名
`type`	列数据类型，推荐使用兼容性好的通用类型，例如：所有数据库都支持 bool、int、uint、float、string、time、bytes 并且可以和其他标签一起使用，例如：`not null`、`size`, `autoIncrement`… 像 `varbinary(8)` 这样指定数据库数据类型也是支持的。在使用指定数据库数据类型时，它需要是完整的数据库数据类型，如：`MEDIUMINT UNSIGNED not NULL AUTO_INCREMENT`
`serializer`	指定将数据序列化或反序列化到数据库中的序列化器, 例如: `serializer:json/gob/unixtime`
`size`	定义列数据类型的大小或长度，例如 `size:256`
`primaryKey`	将列定义为主键
`unique`	将列定义为唯一键
`default`	定义列的默认值
`precision`	指定列的精度
`scale`	指定列大小
`not null`	指定列为 `NOT NULL`
`autoIncrement`	指定列为自动增长
`autoIncrementIncrement`	自动步长，控制连续记录之间的间隔
`embedded`	嵌套字段
`embeddedPrefix`	嵌入字段的列名前缀
`autoCreateTime`	创建时追踪当前时间，对于 `int` 字段，它会追踪时间戳秒数，您可以使用 `nano`/`milli` 来追踪纳秒、毫秒时间戳，例如：`autoCreateTime:nano`
`autoUpdateTime`	创建/更新时追踪当前时间，对于 `int` 字段，它会追踪时间戳秒数，您可以使用 `nano`/`milli` 来追踪纳秒、毫秒时间戳，例如：`autoUpdateTime:milli`
`index`	根据参数创建索引，多个字段使用相同的名称则创建复合索引，查看索引获取详情
`uniqueIndex`	与 `index` 相同，但创建的是唯一索引
`check`	创建检查约束，例如 `check:age > 13`，查看约束获取详情
`<-`	设置字段写入的权限， `<-:create` 只创建、`<-:update` 只更新、`<-:false` 无写入权限、`<-` 创建和更新权限
`->`	设置字段读的权限，`->:false` 无读权限忽略该字段，`-` 表示无读写，`-:migration` 表示无迁移权限，`-:all` 表示无读写迁移权限
`comment`	迁移时为字段添加注释

转载来源 Golang 之 gorm 标签介绍