快速熟悉掌握一個框架/庫:
- 常備文檔,
快速查詢
: gorm文檔 https://github.com/go-gorm/gorm.io , 文檔在pages/docs/
目錄下 - 按照官方文檔快速過一遍, 建立索引, 方便進行第一步的
快速查詢
, 詳細見後續的 index 章節- 小技巧: 文檔添加到 vscode, 可通過
cmd-p
通過文件名快速查詢&打開
- 小技巧: 文檔添加到 vscode, 可通過
- 常備test環境, 隨時隨地coding進行細節驗證, 並記錄
- 持續步驟3, 最終就能沉澱出 框架/庫 的使用指南和最佳實踐
本篇 blog 即爲 GORM 學習/實踐/總結 的成果
資源
go get -u gorm.io/gorm
go get -u gorm.io/driver/sqlite
go get -u gorm.io/plugin/soft_delete
go package | github |
---|---|
gorm.io/gorm | github.com/go-gorm/gorm |
gorm.io/driver/sqlite | github.com/go-gorm/sqlite |
gorm.io/plugin/soft_delete | github.com/go-gorm/soft_delete |
新 | 舊.棄用 |
---|---|
gorm.io/gorm | github.com/jinzhu/gorm |
- 易錯點: struct->忽略0值->指定值
index
- model
- database: driver
- CURD: create query update delete sql_builder
- associations: belongs_to has_one has_many many_to_many associations preload
- tutorial: context err.
errors.go
method session hook transcation migration logger perf data_type scope convention setting - advance: dbresolver.多數據源 sharding serializer Prometheus hint index constraint.外鍵 gorm_config write(plugin.callback driver)
model 定義
- type
- Go基礎類型
- pointer alia
- custom types implementing Scanner and Valuer interfaces
- Convention.約定
- ID as primary key
- pluralizes struct name to snake_cases as table name, snake_case as column name -> json默認和struct一致, 需要手動指定
- uses CreatedAt, UpdatedAt to track creating/updating time
- 日期時間
- datetime/date/timesatmp -> time.Time, 運算使用 carbon 庫
- time -> 使用 string
- 不推薦null, 可以爲null使用指針或者對應對應null類型
- mark
- tag:
gorm:"-"
.ignore - 內嵌字段
gorm.Model
-
gorm:"default:galeone"
: insert +0值
時使用 - 由於
TableName()
僅在初次解析後即緩存,後續不再解析,因此無法通過TableName()來實現動態表名,但可以通過Table()來實現動態表名
- tag:
gorm | mysql | 示例 | |
---|---|---|---|
數值 | ✅ | ✅ | |
字符串 | ✅ | ✅ | |
指針 | null |
*int sql.NullTime gorm.DeleteAt
|
|
string | datetime | ||
time.Time | timesatmp | ||
string | timesatmp | ||
time.Time | datetime | ||
string | date | 2021-08-12T00:00:00+08:00 | |
time.Time | date | {time.Time} 2023-01-03 20:55:09 +0800 | |
string | time | 22:50:08 |
-- 建表語句推薦
CREATE TABLE `tdb_person` (
-- 默認字段
`id` bigint unsigned NOT NULL AUTO_INCREMENT primary key,
`create_at` datetime DEFAULT CURRENT_TIMESTAMP, -- 使用數據庫自動更新
`update_at` datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
`delete_at` datetime,
`is_del` tinyint not null default 0,
-- 基礎數據類型
`username` varchar(32) NOT NULL DEFAULT '' COMMENT '用戶名',
`sex` tinyint NOT NULL DEFAULT '0' COMMENT '性別',
`email` varchar(255) NOT NULL DEFAULT '' COMMENT '郵箱',
`person_type` tinyint DEFAULT NULL, -- 驗證null字段, 數據庫不推薦null
-- 日期時間: 默認都爲null, 需要顯式設置
`in_date` date NOT NULL COMMENT '進入日期',
`in_time` time NOT NULL COMMENT '進入時間',
`in_dt` datetime NOT NULL COMMENT '進入日期時間',
`in_ts` int NOT NULL COMMENT '進入時間戳',
UNIQUE KEY `uni_username` (`username`),
KEY `idx_create_at` (`create_at`),
KEY `idx_update_at` (`update_at`)
) COMMENT ='tdb-person';
import (
"time"
"gorm.io/gorm"
"gorm.io/plugin/soft_delete"
)
type Model struct {
Id uint `gorm:"primarykey" json:"id"`
CreateAt time.Time `gorm:"->" json:"create_at"`
UpdateAt string `gorm:"->" json:"update_at"`
DeleteAt gorm.DeletedAt `json:"delete_at"`
IsDel soft_delete.DeletedAt `gorm:"softDelete:flag,DeletedAtField:DeleteAt" json:"is_del"` // use `1` `0`
}
type PersonModel struct {
Model
Username string
Sex int
Email string
PersonType *int
InDate time.Time
InDt time.Time
InTime string
InTs int64
More string `gorm:"-"` // 數據庫沒有字段
}
// gorm.Model
type Model struct {
ID uint `gorm:"primarykey"`
CreatedAt time.Time
UpdatedAt time.Time
DeletedAt DeletedAt `gorm:"index"`
}
讀
- 書寫順序 -> 默認和sql保持一致
select xxx from xxx where xxx order by xxx limit xxx
T表示model的struct D表示對應model的DAO的struct定義
db.
Model(&M{}). // 查詢結果指定T可省略model; *T/T 指定id查詢; Table() ❌ 不推薦
Select(). // 推薦使用 string; 根據定義的struct返回
Where(). // 避免fmt導致sql注入
Order().
Limit().Offset()
.Take() // 獲取結果 -> 主鍵/where
- where: id []id str map struct.0值.指定字段 Scopes
- result
- Error
- 返回值:
單個值 *T []*T map[string]any []map[string]any
- 單個值: 使用 int 而非
type Status int
- 單個值: 使用 int 而非
- row: Take First Last
-
db.Limit(1).Find(&user)
: ErrRecordNotFound 必須使用Limit.Find會查詢出所有數據
-
- rows: Find Scan FindInBatches
- 單列:
Distinc().Pluck("xxx")
Distinc("xxx").Count()
- 其他
-
Join() Joins()
❌ 不推薦: 沒必要再學習一個 queryBuild 語法 - FirstOrInit FirstOrCreate
-
func (d *D) Get(id) (*T, error) {
var row T
err := db.Take(&row, 1).Error
if err != nil {
if errors.Is(err, gorm.ErrRecordNotFound) {
return nil, err
}
return nil, err
}
return &row, nil
}
func (d *D) List(id) (*T, error) {
var row []*T
err := db.Find(&row).Error
if err != nil {
if errors.Is(err, gorm.ErrRecordNotFound) {
return nil, err
}
return nil, err
}
return &row, nil
}
寫
- create: Create(&row) Create(&rows) Omit()/Select() CreateInBatches(users, 100) upsert
- update: Save.所有字段 Update.單列 Updates.多列(map struc.0值.指定列) ErrMissingWhereClause.
wherer("1=1")
UpdateColumn.UpdateColumns - delete: Delete(*T id []id) ErrMissingWhereClause ReturnDeletedRows.
Delete(&rows)
- SoftDelete:
gorm.DeletedAt
db.Unscoped().Where() db.Unscoped().Delete()
- SoftDelete:
- sql_builder:
Raw().Exce() Raw().Scan()
ToSQL
user := User{Name: "Jinzhu", Age: 18, Birthday: time.Now()}
result := db.Create(&user) // pass pointer of data to Create
user.ID // returns inserted data's primary key
result.Error // returns error
result.RowsAffected // returns inserted records count
more
soft_delete
transcation
db.Transaction(func(tx *gorm.DB) error { // begin
if err := tx.Create(&Animal{Name: "Giraffe"}).Error; err != nil {
return err // rollback
}
if err := tx.Create(&Animal{Name: "Lion"}).Error; err != nil {
return err
}
return nil // commit
})
- gorm中有3類method: chain finisher session ->
*gorm.DB
使用 session 方法來共享 chain
db, err := gorm.Open(sqlite.Open("test.db"), &gorm.Config{})
db.Where("name = ?", "jinzhu").Where("age = ?", 18).Find(&users)
// SELECT * FROM users WHERE name = 'jinzhu' AND age = 18;
db.Where("name = ?", "jinzhu2").Where("age = ?", 20).Find(&users)
// SELECT * FROM users WHERE name = 'jinzhu2' AND age = 20;
db.Find(&users)
// SELECT * FROM users;
tx := db.Where("name = ?", "jinzhu")
tx.Where("age = ?", 18).Find(&users)
// SELECT * FROM users WHERE name = 'jinzhu' AND age = 18;
tx.Where("age = ?", 28).Find(&users)
// SELECT * FROM users WHERE name = 'jinzhu' AND age = 18 AND age = 28; ❌
// session
tx := db.Where("name = ?", "jinzhu").Session(&gorm.Session{})
tx := db.Where("name = ?", "jinzhu").WithContext(context.Background())
tx := db.Where("name = ?", "jinzhu").Debug()
tx.Where("age = ?", 18).Find(&users)
// SELECT * FROM users WHERE name = 'jinzhu' AND age = 18;
tx.Where("age = ?", 28).Find(&users)
// SELECT * FROM users WHERE name = 'jinzhu' AND age = 28;
- scope
func TableOfYear(user *User, year int) func(db *gorm.DB) *gorm.DB {
return func(db *gorm.DB) *gorm.DB {
tableName := user.TableName() + strconv.Itoa(year)
return db.Table(tableName)
}
}
DB.Scopes(TableOfYear(user, 2019)).Find(&users)
// SELECT * FROM users_2019;