Gorm分頁新方案,你學會了嗎?
Gorm是Go語言中最常用的ORM(對象關系映射)包之一,但它在某些功能上仍有不足,其中之一就是分頁。分頁是管理Web應用程序中大數據集的基本功能。通過分頁,可以限制和顯示數據庫中的部分數據,而不必一次性檢索整個表的數據。
雖然Gorm的文檔中介紹了如何使用Scopes來實現分頁,但在靈活性和可用性上仍有改進空間。本文介紹了一種利用Gorm的Clauses特性來簡化分頁并擴展其功能的優雅替代方案。
使用Gorm的Scopes進行分頁
Gorm的文檔中將Scopes介紹為重用常用代碼的方法。在文檔示例中,我們可以看到定義了一個類似于以下的分頁Scope函數:
func Paginate(page, pageSize int) func(db *gorm.DB) *gorm.DB {
return func (db *gorm.DB) *gorm.DB {
// validate page and pageSize
...
offset := (page - 1) * pageSize
return db.Offset(offset).Limit(pageSize)
}
}
page := 0
pageSize := 10
db.Scopes(Paginate(page, pageSize)).Find(&users)
因此,為了應用分頁,我們需要使用代碼db.Scopes(Paginate(page, pageSize))。
使用Clauses進行分頁
另一種更為優雅的方法是使用Gorm的Clauses。這種方法與使用Scopes略有不同,因為Clauses負責修改數據庫查詢,特別是WHERE子句。
首先定義分頁結構體:
type Pagination struct {
page int
pageSize int
}
func (p *Pagination) GetPage() int { return p.page }
func (p *Pagination) GetPageSize() int { return p.pageSize }
然后,實現使用該結構體的gorm子句函數所需的兩個接口:
func (p *Pagination) ModifyStatement(stm *gorm.Statement) {
// 修改語句以添加分頁
db := stm.DB
stm.DB.Limit(p.pageSize).Offset((p.page - 1) * p.pageSize)
}
func (p *Pagination) Build(_ clause.Builder) {
// Build方法留空,因為分頁不需要額外的SQL子句
}
之后,可以按如下方式使用分頁:
pagination := Pagination{
page: 0,
pageSize: 10,
}
db.Clauses(&pagination).Find(&users)
為了使這種方法可重用并增強其功能,我開發了Pagorminator——一個簡化Gorm分頁并添加高級功能的庫,例如未分頁請求和自動元數據填充(如總頁數和總計數)。使用方法如下:
// 添加插件
_ = db.Use(pagorminator.PaGormMinator{})
pageRequest, _ := pagorminator.PageRequest(0, 10)
db.Clauses(pageRequest).Find(&users)
// 這將應用分頁,并填充pageRequest,包括:
// - 總頁數
// - 總計數
分頁是數據庫驅動應用程序的關鍵功能。通過利用Clauses和類似Pagorminator的工具,可以在Gorm中實現強大且可重用的分頁功能。