Create
模型声明
Gorm通过将Go结构体struct映射到数据库表来简化数据库交互。模型是使用普通结构体定义的,这些结构体可以包含具有基本Go类型、指针或这些类型的别名。
type Student struct {
Name string `json:"name"`
Age uint `json:"age"`
}
gorm.Model
Gorm提供了一个预定义的结构体gorm.Model,其中包含常用字段:
type Model struct {
ID uint `gorm:"primaryKey"`
CreatedAt time.Time
UpdatedAt time.Time
DeletedAt gorm.DeletedAt `gorm:"index"`
}
可直接在结构体中嵌入gorm.Model,以便自动包含这些字段:
ID:每个记录的唯一标识符(主键)。CreatedAt:在创建记录时自动设置为当前时间。UpdatedAt:每当记录更新时,自动更新为当前时间。DeletedAt:用于软删除(将记录标记为已删除,而实际上并未从数据库中删除)。
type Student struct {
gorm.Model
Name string `json:"name"`
Age uint `json:"age"`
}
但由于gorm.Model是预定义结构体,无法指定在转为json时的字段名称,因此可基于进行改造:
type GormModel struct {
ID uint `json:"id" gorm:"primarykey"`
CreatedAt time.Time `json:"createdAt"`
UpdatedAt time.Time `json:"updatedAt"`
DeletedAt sql.NullTime `json:"deletedAt" gorm:"index"`
}
type Student struct {
GormModel
Name string `json:"name" gorm:"unique;default:游客"`
Age uint `json:"age"`
}
同步模型
同步模型即同步模型到数据库,可采用如下方式:
// AutoMigrate可同时同步多张表
db.AutoMigrate(&Student{})
字段标签
标签在声明模型时是可选的,Gorm支持以下标签:
- 标签不区分大小写,但推荐使用
camelCase风格。 - 如果使用多个标签,应使用分号
;分隔。 - 具有特殊意义的字符可以用反斜杠
\进行转义,以便作为参数值使用。
| 标签名 | 说明 |
|---|---|
column | 指定数据库列名 |
type | 列数据类型,推荐使用兼容性好的通用类型,例如:所有数据库都支持 bool、int、uint、float、string、time、bytes。也可以指定数据库特定的数据类型,如 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 | 迁移时为字段添加注释 |
创建记录
单条记录
创建记录可通过Create方法:
s := Student{
Name: "Tom",
Age: 22,
}
result := db.Create(&s)
// Error为nil表明创建成功
fmt.Println(result.Error)
// 创建成功条数
fmt.Println(result.RowsAffected)
多条记录
s1 := Student{
Name: "Lily",
Age: 23,
}
s2 := Student{
Name: "Jason",
Age: 21,
}
studens := []*Student{
&s1,
&s2,
}
result := db.Create(studens)
fmt.Println(result.Error)
指定字段
创建记录时,可为指定字段赋值:
s := Student{
Name: "Jack",
Age: 19,
}
db.Select("Age").Create(&s)
如上,仅为指定的Age字段赋值,即使也为Name指定了值,但也不会生效。
忽略字段
创建记录时,可忽略指定字段:
s := Student{
Name: "Jack2",
Age: 19,
}
db.Omit("Age").Create(&s)
批量插入
要高效地插入大量记录,可将切片传递给Create方法,Gorm将生成一条SQL来插入所有数据,以返回所有主键值,并触发Hook方法。
s1 := Student{
Name: "Lily",
Age: 23,
}
s2 := Student{
Name: "Jason",
Age: 21,
}
students := []Student{
s1,
s2,
}
db.Create(&students)
for _, stu := range students {
fmt.Println(stu.ID)
}
在数据较多的情况下,可通过CreateInBatches方法指定批量插入的批次大小:
db.CreateInBatches(students, 1)
如上,将批量插入的批次指定为1,两条数据则会分两次插入,并生成两条SQL语句。
map创建
Gorm支持通过map[string]interface{}与[]map[string]interface{}{}来创建记录。
type StudentMap = map[string]interface{}
m := StudentMap{
"name": "Lisa1",
"age": 23,
}
// 创建单条
db.Model(&Student{}).Create(m)
m1 := StudentMap{
"name": "Cystal1",
"age": 16,
}
m2 := StudentMap{
"name": "Richard2",
"age": 17,
}
// 批量创建
db.Model(&Student{}).Create([]StudentMap{
m1,
m2,
})
- 使用
map创建记录时,钩子方法不会执行,关联不会被保存且不会回写主键。 - 使用
map创建记录,只会插入指定的字段的值,未指定的字段均不会生效(包括默认值)。
Hook
Hook是在创建、查询、更新、删除等操作之前、之后调用的函数。所有的函数都会都会被自动调用,如果任何回调返回错误,Gorm将停止后续的操作并回滚事务。
- 创建对象:
BeforeSave、BeforeCreate、AfterCreate、AfterSave。 - 更新对象:
BeforeSave、BeforeUpdate、AfterUpdate、AfterSave。 - 删除对象:
BeforeDelete、AfterDelete。 - 查询对象:
AfterFind。
下面以创建为例:
func (s *Student) BeforeSave(tx *gorm.DB) (err error) {
fmt.Println("BeforeCreate")
return err
}
func (s *Student) BeforeCreate(tx *gorm.DB) (err error) {
fmt.Println("AfterCreate")
return err
}
func (s *Student) AfterCreate(tx *gorm.DB) (err error) {
fmt.Println("AfterCreate")
return err
}
func (s *Student) AfterSave(tx *gorm.DB) (err error) {
fmt.Println("AfterSave")
return err
}