模型定义
模型一般基于 Go 的基本数据类型、实现了 Scanner 和 Valuer 接口的自定义类型以及它们的指针/别名
例如:
type User struct {ID uintName stringEmail *stringAge uint8Birthday *time.TimeMemberNumber sql.NullStringActivedAt sql.NullTimeCreatedAt time.TimeUpdatedAt time.Time}
约定
GORM 倾向于约定,而不是配置。默认情况下,GORM 使用 ID 作为主键,使用结构体名的 蛇形复数 作为表名,字段名的 蛇形 作为列名,并使用 CreatedAt、UpdatedAt 字段追踪创建、更新时间
遵循 GORM 已有的约定,可以减少您的配置和代码量。如果约定不符合您的需求,GORM 允许您自定义配置它们
gorm.Model
GORM 定义一个 gorm.Model 结构体,其包括字段 ID、CreatedAt、UpdatedAt、DeletedAt
// gorm.Model 的定义type Model struct {ID uint `gorm:"primaryKey"`CreatedAt time.TimeUpdatedAt time.TimeDeletedAt gorm.DeletedAt `gorm:"index"`}
您可以将它嵌入到您的结构体中,以包含这几个字段,详情请参考 嵌入结构体
type User struct {gorm.ModelName string}// 等效于type User struct {ID uint `gorm:"primaryKey"`CreatedAt time.TimeUpdatedAt time.TimeDeletedAt gorm.DeletedAt `gorm:"index"`Name string}
高级选项
字段级权限控制
可导出的字段在使用 GORM 进行 CRUD 时拥有全部的权限,此外,GORM 允许您用标签控制字段级别的权限。这样您就可以让一个字段的权限是只读、只写、只创建、只更新或者被忽略
type User struct {Name string `gorm:"<-:create"` // 允许读和创建Name string `gorm:"<-:update"` // 允许读和更新Name string `gorm:"<-"` // 允许读和写(创建和更新)Name string `gorm:"<-:false"` // 允许读,禁止写Name string `gorm:"->"` // 只读(除非有自定义配置,否则禁止写)Name string `gorm:"->;<-:create"` // 允许读和写Name string `gorm:"->:false;<-:create"` // 仅创建(禁止从 db 读)Name string `gorm:"-"` // 读写操作均会忽略该字段}
Creating/Updating Time/Unix (Milli/Nano) Seconds Tracking
GORM 约定使用 CreatedAt、UpdatedAt 追踪创建/更新时间。如果您定义了他们,GORM 在创建/更新时会自动填充 当前时间 至这些字段,支持 time.Time,(纳) 秒级 UNIX 时间戳等形式。
要使用不同名称的字段,您可以配置 autoCreateTim、autoUpdateTim 标签
如果您想要保存(纳)秒级 UNIX 时间戳,而不是时间,您只需简单地将 time.Time 修改为 int 即可
type User struct {CreatedAt time.Time // Set to current time if it is zero on creatingUpdatedAt int // Set to current unix seconds on updaing or if it is zero on creatingUpdated int64 `gorm:"autoUpdateTime:nano"` // Use unix Nano seconds as updating timeUpdated int64 `gorm:"autoUpdateTime:milli"` // Use unix Milli seconds as updating timeCreated int64 `gorm:"autoCreateTime"` // Use unix seconds as creating time}
嵌入结构体
对于匿名字段,GORM 会将其字段包含在父结构体中,例如:
type User struct {gorm.ModelName string}// 等效于type User struct {ID uint `gorm:"primaryKey"`CreatedAt time.TimeUpdatedAt time.TimeDeletedAt gorm.DeletedAt `gorm:"index"`Name string}
对于正常的结构体字段,你也可以通过标签 embedded 将其嵌入,例如:
type Author struct {Name stringEmail string}type Blog struct {ID intAuthor Author `gorm:"embedded"`Upvotes int32}// 等效于type Blog struct {ID int64Name stringEmail stringUpvotes int32}
并且,您可以使用标签 embeddrefix 来为 db 中的字段名添加前缀,例如:
type Blog struct {ID intAuthor Author `gorm:"embedded;embeddedPrefix:author_"`Upvotes int32}// 等效于type Blog struct {ID int64AuthorName stringAuthorEmail stringUpvotes int32}
字段标签
在声明模型时,标签是可选的,GORM 支持以下标签:
标签名对大小写不敏感,但建议使用 小驼峰(camelCase) 的命名方式。
| 标签名 | 说明 |
|---|---|
| column | 指定 db 列名 |
| type | 列数据类型,推荐使用兼容性好的通用类型,例如:bool、int、uint、float、string、time、bytes。并可与其他标签一起使用,例如:not null、size, autoIncrement… 像 varbinary(8) 这样指定数据库数据类型也是支持的。在使用指定数据库数据类型时,它需要是完整的数据库数据类型,如:MEDIUMINT UNSINED not NULL AUTO_INSTREMENT |
| size | 指定列大小,例如:size:256 |
| primaryKey | 指定列为主键 |
| unique | 指定列为唯一 |
| default | 指定列的默认值 |
| precision | 指定列的精度 |
| not null | 指定列为 NOT NULL |
| autoIncrement | 指定列为自动增长 |
| embedded | 嵌套字段 |
| embeddedPrefix | 嵌套字段的前缀 |
| autoCreateTime | track current time when creating, for int fields, it will track unix seconds, use value nano/milli to track unix nano/milli seconds, e.g: autoCreateTime:nano |
| autoUpdateTime | track current time when creating/updating, for int fields, it will track unix seconds, use value nano/milli to track unix nano/milli seconds, e.g: autoUpdateTime:milli |
| index | 根据参数创建索引,多个字段拥有相同的名称则创建复合索引,参考 索引 获取详情 |
| uniqueIndex | 与 index 相同,但创建的是唯一索引 |
| check | 创建检查约束,例如 check:(age > 13),查看 约束 获取详情 |
| <- | 设置字段写入的权限, <-:create 只创建、<-:update 只更新、<-:false 无权限 |
| -> | 设置字段读取权限 |
| - | 忽略此字段(禁止读写) |
关联标签
GORM 允许通过标签为关联配置外键、约束、many2many 表,详情请参考 关联部分