GORM 默认模型
GORM内置了一个gorm.Model结构体。gorm.Model是一个包含了ID, CreatedAt, UpdatedAt, DeletedAt四个字段的Golang结构体。
代码语言:txt复制// gorm.Model 定义
type Model struct {
ID uint `gorm:"primary_key"`
CreatedAt time.Time
UpdatedAt time.Time
DeletedAt *time.Time
}
也可以继承到自己的结构体中
代码语言:txt复制// 将 `ID`, `CreatedAt`, `UpdatedAt`, `DeletedAt`字段注入到`Student`模型中
type Student struct {
gorm.Model
Name string
Age int
}
Model 定义
代码语言:txt复制type User struct {
gorm.Model
Name string
Age sql.NullInt64
Birthday *time.Time
Email string `gorm:"type:varchar(100);unique_index"`
Role string `gorm:"size:255"` // 设置字段大小为255
MemberNumber *string `gorm:"unique;not null"` // 设置会员号(member number)唯一并且不为空
Num int `gorm:"AUTO_INCREMENT"` // 设置 num 为自增类型
Address string `gorm:"index:addr"` // 给address字段创建名为addr的索引
IgnoreMe int `gorm:"-"` // 忽略本字段
}
User 结构体的属性 Birthday 和 MemberNumber,使用指针,是有什么含义么?
默认所有字段的零值, 比如 0, '', false 或者其它 零值,都不会保存到数据库内,使用指针可以避免这种情况。
结构体标记(tags)
使用结构体声明模型时,标记(tags)是可选项。
打标记的作用:
是对数据表的字段做修饰,例如(自增,主键,大小,类型,索引........)
结构体标记
| 结构体标记(Tag) | 描述 |
| --------------- | ----------------------------- |
| Column | 指定列名 |
| Type | 指定列数据类型 |
| Size | 指定列大小, 默认值255 |
| PRIMARY_KEY | 将列指定为主键 |
| UNIQUE | 将列指定为唯一 |
| DEFAULT | 指定列默认值 |
| PRECISION | 指定列精度 |
| NOT NULL | 将列指定为非 NULL |
| AUTO_INCREMENT | 指定列是否为自增类型 |
| INDEX | 创建具有或不带名称的索引, 如果多个索引同名则创建复合索引 |
| UNIQUE_INDEX | 和 INDEX 类似,只不过创建的是唯一索引 |
| EMBEDDED | 将结构设置为嵌入 |
| EMBEDDED_PREFIX | 设置嵌入结构的前缀 |
| - | 忽略此字段 |
关联相关标记
| 结构体标记(Tag) | 描述 |
| -------------------------------- | -------------------- |
| MANY2MANY | 指定连接表 |
| FOREIGNKEY | 设置外键 |
| ASSOCIATION_FOREIGNKEY | 设置关联外键 |
| POLYMORPHIC | 指定多态类型 |
| POLYMORPHIC_VALUE | 指定多态值 |
| JOINTABLE_FOREIGNKEY | 指定连接表的外键 |
| ASSOCIATION_JOINTABLE_FOREIGNKEY | 指定连接表的关联外键 |
| SAVE_ASSOCIATIONS | 是否自动完成 save 的相关操作 |
| ASSOCIATION_AUTOUPDATE | 是否自动完成 update 的相关操作 |
| ASSOCIATION_AUTOCREATE | 是否自动完成 create 的相关操作 |
| ASSOCIATION_SAVE_REFERENCE | 是否自动完成引用的 save 的相关操作 |
| PRELOAD | 是否自动完成预加载的相关操作 |
主键. 表名. 列名约定
主键
GORM 默认会使用名为ID的字段作为表的主键。
代码语言:txt复制type User struct {
ID string // 名为`ID`的字段会默认作为表的主键
Name string
}
// 使用`StudentlID`作为主键
type Student struct {
StudentID int64 `gorm:"primary_key"`
Name string
Age int64
}
表名
- 表名默认是结构体名称的复数, 也可以取消默认复数表名
type User struct {} // 默认表名是 `users`
// 将 User 的表名设置为 `user`
func (User) TableName() string {
return "user"
}
// 禁用默认表名的复数形式,如果置为 true,则 `User` 的默认表名是 `user`
db.SingularTable(true)
- 也可以通过Table()指定表名:
// 使用User结构体创建名为`student`的表
db.Table("student").CreateTable(&User{})
- GORM还支持更改默认表名称规则:
gorm.DefaultTableNameHandler = func (db *gorm.DB, defaultTableName string) string {
return "prefix_" defaultTableName;
}
"prefix_" 可任意名称
列名
列名由字段名称进行下划线分割来生成 , 结构体字段为驼峰命名时,第二个单词会在前面以下划线显示 ,例如:
AddressInfo ---> address_info
代码语言:txt复制type User struct {
ID uint // column name is `id`
Name string // column name is `name`
Birthday time.Time // column name is `birthday`
CreatedAt time.Time // column name is `created_at`
}
**可以使用结构体Tag 指定列名**
代码语言:txt复制type Animal struct {
AnimalId int64 `gorm:"column:beast_id"` // set column name to `beast_id`
Birthday time.Time `gorm:"column:day_of_the_beast"` // set column name to `day_of_the_beast`
Age int64 `gorm:"column:age_of_the_beast"` // set column name to `age_of_the_beast`
}
时间戳跟踪
CreatedAt
如果模型有 CreatedAt字段,该字段的值将会是初次创建记录的时间。
代码语言:txt复制db.Create(&user) // `CreatedAt`将会是当前时间
// 可以使用`Update`方法来改变`CreateAt`的值
db.Model(&user).Update("CreatedAt", time.Now())
UpdatedAt
如果模型有UpdatedAt字段,该字段的值将会是每次更新记录的时间。
代码语言:txt复制db.Save(&user) // `UpdatedAt`将会是当前时间
db.Model(&user).Update("name", "jinzhu")
// `UpdatedAt`将会是当前时间
DeletedAt
如果模型有DeletedAt字段,调用Delete删除该记录时,将会设置DeletedAt字段为当前时间,而不是直接将记录从数据库中删除。