增刪改查
1. 插入數據
// api
func SaveUser(ctx *gin.Context) {result := &common.Result{}user := &dao.User{}err := ctx.ShouldBindJSON(&user)if err != nil {ctx.JSON(http.StatusOK, result.Fail(400, "請使用json數據格式傳值"))return}// 調用驗證函數if err := validate.ValidateUser(user); err != nil {ctx.JSON(http.StatusBadRequest, result.Fail(400, err.Error()))return}user.CreateTime = time.Now().Unix()_, err = dao.SaveUser(user)if err != nil {ctx.JSON(http.StatusOK, result.Fail(400, err.Error()))return}ctx.JSON(http.StatusOK, result.Success("添加成功"))
}// dao
func SaveUser(user *User) (bool, error) {var count int64err := DB.Model(&User{}).Where("username = ?", user.Username).Count(&count).Errorif err != nil {return false, err}if count > 0 {return false, fmt.Errorf("該用戶(%s)已存在", user.Username)}tx := DB.Create(user)if tx.Error != nil {log.Println("insert fail : ", tx.Error)return false, tx.Error}return true, nil
}
1.1 用指定的字段創建:
func SelectUser() {var user Useruser.Username = "test"user.Password = "123456"DB.Model(&User{}).Select("username", "password").Create(&user)
}
1.2 忽略字段
func SelectUser() {var user Useruser.Username = "test"user.Password = "123456"user.CreateTime = time.Now().UnixMilli()DB.Model(&User{}).Omit("username").Create(&user)
}//結果:INSERT INTO `users` (`password`,`createtime`) VALUES ('123456',1752196334754)
1.3 批量插入:
func SelectUser() {var user []UserhashedPassword := fmt.Sprintf("%x", md5.Sum([]byte("123456")))for i := 0; i < 10; i++ {user = append(user, User{Username: fmt.Sprintf("test_%d", i+1),Password: hashedPassword,CreateTime: time.Now().UnixMilli(),})}DB.Model(&User{}).Create(&user)
}[8.110ms] [rows:10] INSERT INTO `users` (`username`,`password`,`createtime`) VALUES ('test_1','e10adc3949ba59abbe56e057f20f883e',1752197175608),('test_2','e10adc3949ba59abbe56e057f20f883e',1752197175608),('test_3','e10adc3949ba59abbe56e057f20f883e',1752197175608),('test_4','e10adc3949ba59abbe56e057f20f883e',1752197175608),('test_5','e10adc3949ba59abbe56e057f20f883e',1752197175608),('test_6','e10adc3949ba59abbe56e057f20f883e',1752197175608),('test_7','e10adc3949ba59abbe56e057f20f883e',1752197175608),('test_8','e10adc3949ba59abbe56e057f20f883e',1752197175608),('test_9','e10adc3949ba59abbe56e057f20f883e',1752197175608),('test_10','e10adc3949ba59abbe56e057f20f883e',1752197175608)
使用 CreateInBatches
分批創建時,你可以指定每批的數量,例如:
var users = []User{{Username: "jinzhu_1"}, ...., {Username: "jinzhu_10000"}}// 數量為 100
db.CreateInBatches(users, 100)
1.4 使用map創建:
db.Model(&User{}).Create(map[string]interface{}{"Name": "xxp", "Age": 18,
})// batch insert from `[]map[string]interface{}{}`
db.Model(&User{}).Create([]map[string]interface{}{{"Name": "damao", "Age": 18},{"Name": "xiaomao", "Age": 20},
})
map創建注意,主鍵不會被填充。
1.5 sql表達式:
DB.Model(&User{}).Create(map[string]interface{}{"username": "jinzhu","password": clause.Expr{SQL: "md5(?)", Vars: []interface{}{"123456"}},})
1.6 使用原生sql語句:
Exec 通常是用戶操作不返回的 例如:insert,update,
db.Exec("insert into users (username,password,createtime) values (?,?,?)", user.Username, user.Password, user.CreateTime)
Exec 通常是用戶操作不返回的 例如:insert,update,
func SelectUser() {var user []Usertx := DB.Raw("select * from users where id = ?", 1).Scan(&user).Errorif tx != nil {log.Println("select fail : ", tx)return}fmt.Println(user)
}
2. 更新數據
在創建一個表
CREATE TABLE `goods` (`id` int(11) NOT NULL AUTO_INCREMENT COMMENT '商品id',`title` varchar(100) NOT NULL COMMENT '商品名',`price` decimal(10, 2) NULL DEFAULT 0.00 COMMENT '商品價格',`stock` int(11) DEFAULT '0' COMMENT '商品庫存',`type` int(11) DEFAULT '0' COMMENT '商品類型',`create_time` datetime NOT NULL COMMENT '商品創建時間',PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;
package daoimport "time"type Goods struct {Id intTitle stringPrice float64Stock intType intCreateTime time.Time
}func (v Goods) TableName() string {return "goods"
}func SaveGoods(goods Goods) {DB.Create(&goods)
}
package daoimport ("testing""time"
)func TestSaveGoods(t *testing.T) {goods := Goods{Title: "毛巾",Price: 25,Stock: 100,Type: 0,CreateTime: time.Now(),}SaveGoods(goods)
}
2.1 保存數據
goods := Goods{}DB.Where("id = ?", 1).Take(&goods)goods.Price = 100//UPDATE `goods` SET `title`='毛巾',`price`=100.000000,`stock`=100,`type`=0,`create_time `='2022-11-25 13:03:48' WHERE `id` = 1DB.Save(&goods)
2.2 更新單個列
goods := Goods{}DB.Where("id = ?", 2).Take(&goods)DB.Model(&goods).Update("title", "hello")
2.3 更新多列
goods := Goods{}DB.Where("id = ?", 2).Take(&goods)//更新非零值的字段 也可以使用mapDB.Model(&goods).Updates(Goods{Title: "hello",Stock: 200,})
2.4 更新選定的字段
goods := Goods{}DB.Where("id = ?", 2).Take(&goods)DB.Model(&goods).Select("title").Updates(Goods{Title: "hello",Stock: 200,})
排除:
goods := Goods{}DB.Where("id = ?", 2).Take(&goods)DB.Model(&goods).Omit("title").Updates(Goods{Title: "hello",Stock: 200,})
也可以組合使用
Select("*").Omit("title")
gorm更新必須帶條件進行更新,否則會返回錯誤gorm.ErrMissingWhereClause
,或者啟用 AllowGlobalUpdate
模式
db.Session(&gorm.Session{AllowGlobalUpdate: true}).Model(&User{}).Update("name", "jinzhu")
2.5 表達式
db.Model(&goods).Update("stock", gorm.Expr("stock + 1"))
db.Model(&goods).Update(map[string]interface{}{"stock": gorm.Expr("stock + 1")})
2.6 子查詢更新
goods := Goods{}DB.Where("id = ?", 2).Take(&goods)DB.Model(&goods).Update("title", DB.Model(&User{}).Select("username").Where("id=?", 2))
3. 刪除數據
goods := Goods{}DB.Where("id = ?", 2).Take(&goods)DB.Delete(&goods)
//根據主鍵刪除
DB.Delete(&Goods{}, 1)
同樣的道理,不帶條件不能進行刪除,必須加一些條件,或者使用原生 SQL,或者啟用 AllowGlobalUpdate
模式
db.Session(&gorm.Session{AllowGlobalUpdate: true}).Delete(&User{})
// DELETE FROM users
4. 查詢數據
4.1 查詢函數
-
Take:查詢一條記錄
db.Take(&goods)
-
First: 根據主鍵正序排序后,查詢第一條數據
db.First(&goods)
-
Last:根據主鍵倒序排序后,查詢最后一條記錄
db.Last(&goods)
-
Find:查詢多條記錄
db.Find(&goods)
-
Pluck:查詢一列值
var titles []string db.Model(&Goods{}).Pluck("title", &titles)
當 First、Last、Take 方法找不到記錄時,GORM 會返回 ErrRecordNotFound 錯誤,可以通過對比gorm.ErrRecordNotFound
進行判斷,或者使用Find和Limit的組合進行查詢。
db.Limit(1).Find(&user)
4.2 where
通過db.Where函數設置條件
函數說明:
db.Where(query interface{}, args ...interface{})
參數說明:
參數名 | 說明 |
---|---|
query | sql語句的where子句, where子句中使用問號(?)代替參數值,則表示通過args參數綁定參數 |
args | where子句綁定的參數,可以綁定多個參數 |
比如:
db.Where("id in (?)", []int{1,2,5,6}).Take(&goods)
4.3 select
設置select子句, 指定返回的字段
var goods Goods
DB.Select("id", "title").Find(&goods)
也可以寫聚合函數
var total int
DB.Model(&Goods{}).Select("count(*) as total").Pluck("total", &total)
fmt.Println(total)
4.4 order
排序
var goods []GoodsDB.Order("id desc").Find(&goods)
4.5 分頁
通過limit和Offset實現
var goods []Goods
DB.Order("create_time desc").Limit(10).Offset(10).Find(&goods)
4.6 count
返回查詢匹配的行數
var total int64 = 0
DB.Model(Goods{}).Count(&total)
fmt.Println(total)
4.7 分組
//統計每個商品分類下面有多少個商品
//定一個Result結構體類型,用來保存查詢結果
type Result struct {Type intTotal int
}
var results []Result
//等價于: SELECT type, count(*) as total FROM `goods` GROUP BY type HAVING (total > 0)
db.Model(Goods{}).Select("type, count(*) as total").Group("type").Having("total > 0").Scan(&results)//scan類似Find都是用于執行查詢語句,然后把查詢結果賦值給結構體變量,區別在于scan不會從傳遞進來的結構體變量提取表名.
//這里因為我們重新定義了一個結構體用于保存結果,但是這個結構體并沒有綁定goods表,所以這里只能使用scan查詢函數。
Group函數必須搭配Select函數一起使用
4.8 直接執行sql語句
sql := "SELECT type, count(*) as total FROM `goods` where create_time > ? GROUP BY type HAVING (total > 0)"
//因為sql語句使用了一個問號(?)作為綁定參數, 所以需要傳遞一個綁定參數(Raw第二個參數).
//Raw函數支持綁定多個參數
db.Raw(sql, "2022-11-06 00:00:00").Scan(&results)
fmt.Println(results)
事務和Hook
1. 會話Session
為了避免共用db導致的一些問題,gorm提供了會話模式,通過新建session的形式,將db的操作分離,互不影響。
創建session的時候,有一些配置:
// Session 配置
type Session struct {DryRun bool //生成 SQL 但不執行PrepareStmt bool //預編譯模式NewDB bool //新db 不帶之前的條件Initialized bool //初始化新的dbSkipHooks bool //跳過鉤子SkipDefaultTransaction bool //禁用默認事務DisableNestedTransaction bool //禁用嵌套事務AllowGlobalUpdate bool //允許不帶條件的更新FullSaveAssociations bool //允許更新關聯數據QueryFields bool //select(字段)Context context.ContextLogger logger.InterfaceNowFunc func() time.Time //允許改變 GORM 獲取當前時間的實現CreateBatchSize int
}
比如說可以禁用默認的事務,從而提供性能,官方說大致能提升30%左右:
// 持續會話模式
tx := db.Session(&Session{SkipDefaultTransaction: true})
tx.First(&user, 1)
tx.Find(&users)
tx.Model(&user).Update("Age", 18)
比如使用PreparedStmt
在執行任何 SQL 時都會創建一個 prepared statement 并將其緩存,以提高后續的效率
// 會話模式
tx := db.Session(&Session{PrepareStmt: true})
tx.First(&user, 1)
tx.Find(&users)
tx.Model(&user).Update("Age", 18)// returns prepared statements manager
stmtManger, ok := tx.ConnPool.(*PreparedStmtDB)// 關閉 *當前會話* 的預編譯模式
stmtManger.Close()// 為 *當前會話* 預編譯 SQL
stmtManger.PreparedSQL // => []string{}// 為當前數據庫連接池的(所有會話)開啟預編譯模式
stmtManger.Stmts // map[string]*sql.Stmtfor sql, stmt := range stmtManger.Stmts {sql // 預編譯 SQLstmt // 預編譯模式stmt.Close() // 關閉預編譯模式
}
還有,gorm的db默認是協程安全的,如果使用初始化參數,則db不在協程安全:
tx := db.Session(&gorm.Session{Initialized: true})
比如context:
timeoutCtx, _ := context.WithTimeout(context.Background(), time.Second)
tx := db.Session(&Session{Context: timeoutCtx})tx.First(&user) // 帶有 context timeoutCtx 的查詢操作
tx.Model(&user).Update("role", "admin") // 帶有 context timeoutCtx 的更新操作
2. 事務
2.1 自動事務
db.Transaction(func(tx *gorm.DB) error {// 在事務中執行一些 db 操作(從這里開始,您應該使用 'tx' 而不是 'db')if err := tx.Create(&Animal{Name: "Giraffe"}).Error; err != nil {// 返回任何錯誤都會回滾事務return err}if err := tx.Create(&Animal{Name: "Lion"}).Error; err != nil {return err}// 返回 nil 提交事務return nil
})
2.2 嵌套事務
GORM 支持嵌套事務,您可以回滾較大事務內執行的一部分操作,例如:
db.Transaction(func(tx *gorm.DB) error {tx.Create(&user1)tx.Transaction(func(tx2 *gorm.DB) error {tx2.Create(&user2)return errors.New("rollback user2") // Rollback user2})tx.Transaction(func(tx2 *gorm.DB) error {tx2.Create(&user3)return nil})return nil
})// Commit user1, user3
2.3 手動事務
// 開始事務
tx := db.Begin()// 在事務中執行一些 db 操作(從這里開始,您應該使用 'tx' 而不是 'db')
tx.Create(...)// ...// 遇到錯誤時回滾事務
tx.Rollback()// 否則,提交事務
tx.Commit()
比如
// 開啟事務
tx := db.Begin()//在事務中執行數據庫操作,使用的是tx變量,不是db。
//庫存減一
//等價于: UPDATE `goods` SET `stock` = stock - 1 WHERE `goods`.`id` = '2' and stock > 0
//RowsAffected用于返回sql執行后影響的行數
rowsAffected := tx.Model(&goods).Where("stock > 0").Update("stock", gorm.Expr("stock - 1")).RowsAffected
if rowsAffected == 0 {//如果更新庫存操作,返回影響行數為0,說明沒有庫存了,結束下單流程//這里回滾作用不大,因為前面沒成功執行什么數據庫更新操作,也沒什么數據需要回滾。//這里就是舉個例子,事務中可以執行多個sql語句,錯誤了可以回滾事務tx.Rollback()return
}
err := tx.Create(保存訂單).Error//保存訂單失敗,則回滾事務
if err != nil {tx.Rollback()
} else {tx.Commit()
}
2.4 保存點
GORM 提供了 SavePoint
、Rollbackto
方法,來提供保存點以及回滾至保存點功能,例如:
tx := db.Begin()
tx.Create(&user1)tx.SavePoint("sp1")
tx.Create(&user2)
tx.RollbackTo("sp1") // Rollback user2tx.Commit() // Commit user1
3. Hook
Hook 是在創建、查詢、更新、刪除等操作之前、之后調用的函數。
如果您已經為模型定義了指定的方法,它會在創建、更新、查詢、刪除時自動被調用。如果任何回調返回錯誤,GORM 將停止后續的操作并回滾事務。
鉤子方法的函數簽名應該是 func(*gorm.DB) error
3.1 創建
創建時可用的 hook
// 開始事務
BeforeSave
BeforeCreate
// 關聯前的 save
// 插入記錄至 db
// 關聯后的 save
AfterCreate
AfterSave
// 提交或回滾事務
func (u *User) BeforeCreate(tx *gorm.DB) (err error) {u.UUID = uuid.New()if !u.IsValid() {err = errors.New("can't save invalid data")}return
}func (u *User) AfterCreate(tx *gorm.DB) (err error) {if u.ID == 1 {tx.Model(u).Update("role", "admin")}return
}
在 GORM 中保存、刪除操作會默認運行在事務上, 因此在事務完成之前該事務中所作的更改是不可見的,如果您的鉤子返回了任何錯誤,則修改將被回滾。
func (u *User) AfterCreate(tx *gorm.DB) (err error) {if !u.IsValid() {return errors.New("rollback invalid user")}return nil
}
3.2 更新
更新時可用的 hook
// 開始事務
BeforeSave
BeforeUpdate
// 關聯前的 save
// 更新 db
// 關聯后的 save
AfterUpdate
AfterSave
// 提交或回滾事務
代碼示例:
func (u *User) BeforeUpdate(tx *gorm.DB) (err error) {if u.readonly() {err = errors.New("read only user")}return
}// 在同一個事務中更新數據
func (u *User) AfterUpdate(tx *gorm.DB) (err error) {if u.Confirmed {tx.Model(&Address{}).Where("user_id = ?", u.ID).Update("verfied", true)}return
}
3.3 刪除
刪除時可用的 hook
// 開始事務
BeforeDelete
// 刪除 db 中的數據
AfterDelete
// 提交或回滾事務
代碼示例:
// 在同一個事務中更新數據
func (u *User) AfterDelete(tx *gorm.DB) (err error) {if u.Confirmed {tx.Model(&Address{}).Where("user_id = ?", u.ID).Update("invalid", false)}return
}
3.4 查詢
查詢時可用的 hook
// 從 db 中加載數據
// Preloading (eager loading)
AfterFind
代碼示例:
func (u *User) AfterFind(tx *gorm.DB) (err error) {if u.MemberShip == "" {u.MemberShip = "user"}return
}
高級查詢
1. scope
作用域允許你復用通用的邏輯,這種共享邏輯需要定義為類型func(*gorm.DB) *gorm.DB
。
例子:
func Paginate(r *http.Request) func(db *gorm.DB) *gorm.DB {return func (db *gorm.DB) *gorm.DB {q := r.URL.Query()page, _ := strconv.Atoi(q.Get("page"))if page == 0 {page = 1}pageSize, _ := strconv.Atoi(q.Get("page_size"))switch {case pageSize > 100:pageSize = 100case pageSize <= 0:pageSize = 10}offset := (page - 1) * pageSizereturn db.Offset(offset).Limit(pageSize)}
}db.Scopes(Paginate(r)).Find(&users)
db.Scopes(Paginate(r)).Find(&articles)
2. 智能選擇字段
type User struct {ID uintName stringAge intGender string// 假設后面還有幾百個字段...
}type APIUser struct {ID uintName string
}// 查詢時會自動選擇 `id`, `name` 字段
db.Model(&User{}).Limit(10).Find(&APIUser{})
// SELECT `id`, `name` FROM `users` LIMIT 10
3. 子查詢
db.Where("amount > (?)", db.Table("orders").Select("AVG(amount)")).Find(&orders)
// SELECT * FROM "orders" WHERE amount > (SELECT AVG(amount) FROM "orders");
from子查詢
db.Table("(?) as u", db.Model(&User{}).Select("name", "age")).Where("age = ?", 18).Find(&User{})
// SELECT * FROM (SELECT `name`,`age` FROM `users`) as u WHERE `age` = 18subQuery1 := db.Model(&User{}).Select("name")
subQuery2 := db.Model(&Pet{}).Select("name")
db.Table("(?) as u, (?) as p", subQuery1, subQuery2).Find(&User{})
4. 關聯操作
CREATE TABLE `gorm`.`user_profiles` (`id` int(20) NOT NULL AUTO_INCREMENT,`sex` tinyint(4) NULL DEFAULT NULL,`age` int(10) NULL DEFAULT NULL,`user_id` int(20) NULL DEFAULT NULL,PRIMARY KEY (`id`) USING BTREE
) ENGINE = InnoDB CHARACTER SET = utf8mb4;
比如有一個用戶屬性表,查詢用戶的時候需要將其的性別和年齡查詢出來:
type UserProfile struct {ID int64UserId int64Sex intAge int}func (u UserProfile) TableName() string {return "user_profiles"
}
type User struct {ID int64Username string `gorm:"column:username"`Password string `gorm:"column:password"`CreateTime int64 `gorm:"column:createtime"`UserProfile UserProfile
}
保存User
var user = User{Username: "ms",Password: "ms",CreateTime: time.Now().UnixMilli(),UserProfile: UserProfile{Sex: 0,Age: 20,},}DB.Save(&user)
會產生兩條sql,users表和user_profiles表都有數據
這是因為默認的外鍵是結構體名字+下劃線+id,即UserId或者表字段是user_id
如果將user_profiles表中的user_id改為other_id就會失敗。
type User struct {ID int64Username string `gorm:"column:username"`Password string `gorm:"column:password"`CreateTime int64 `gorm:"column:createtime"`UserProfile UserProfile `gorm:"foreignKey:OtherId"`
}
只要給UserProfile添加上相應的tag即可。
關聯標簽
標簽 | 描述 |
---|---|
foreignKey | 指定當前模型的列作為連接表的外鍵 |
references | 指定引用表的列名,其將被映射為連接表外鍵 |
polymorphic | 指定多態類型,比如模型名 |
polymorphicValue | 指定多態值、默認表名 |
many2many | 指定連接表表名 |
joinForeignKey | 指定連接表的外鍵列名,其將被映射到當前表 |
joinReferences | 指定連接表的外鍵列名,其將被映射到引用表 |
constraint | 關系約束,例如:OnUpdate 、OnDelete |
4.1 查詢
var users []Usererr := DB.Preload("UserProfile").Find(&users).Errorfmt.Println(err)fmt.Println(users)
Preload預加載,直接加載關聯關系
也可以使用joins進行加載關聯數據:
var users []Usererr := DB.Joins("UserProfile").Find(&users).Errorfmt.Println(err)fmt.Println(users)
從sql中能看的出來,使用了left join。
如果不想要User的數據,只想要關聯表的數據,可以這么做:
var user UserDB.Where("id=?", 25).Take(&user)var userProfile UserProfileerr := DB.Model(&user).Association("UserProfile").Find(&userProfile)fmt.Println(err)fmt.Println(userProfile)