feat: add selectPage ignore total #37 (#45)

Author: afumu

gplus/dao.go

@@ -197,11 +197,17 @@ func SelectListMaps[T any](q *Query[T], opts ...OptionFunc) ([]map[string]any, *
 
 // SelectPage 根据条件分页查询记录
 func SelectPage[T any](page *Page[T], q *Query[T], opts ...OptionFunc) (*Page[T], *gorm.DB) {
-	total, countDb := SelectCount[T](q, opts...)
-	if countDb.Error != nil {
-		return page, countDb
+	option := getOption(opts)
+
+	// 如果需要分页忽略总数，不查询总数
+	if !option.IgnoreTotal {
+		total, countDb := SelectCount[T](q, opts...)
+		if countDb.Error != nil {
+			return page, countDb
+		}
+		page.Total = total
 	}
-	page.Total = total
+
 	resultDb := buildCondition(q, opts...)
 	var results []*T
 	resultDb.Scopes(paginate(page)).Find(&results)
@@ -213,11 +219,15 @@ func SelectPage[T any](page *Page[T], q *Query[T], opts ...OptionFunc) (*Page[T]
 // 第一个泛型代表数据库表实体
 // 第二个泛型代表返回记录实体
 func SelectPageModel[T any, R any](page *Page[R], q *Query[T], opts ...OptionFunc) (*Page[R], *gorm.DB) {
-	total, countDb := SelectCount[T](q, opts...)
-	if countDb.Error != nil {
-		return page, countDb
+	option := getOption(opts)
+	// 如果需要分页忽略总数，不查询总数
+	if !option.IgnoreTotal {
+		total, countDb := SelectCount[T](q, opts...)
+		if countDb.Error != nil {
+			return page, countDb
+		}
+		page.Total = total
 	}
-	page.Total = total
 	resultDb := buildCondition(q, opts...)
 	var results []*R
 	resultDb.Scopes(paginate(page)).Scan(&results)
@@ -227,11 +237,15 @@ func SelectPageModel[T any, R any](page *Page[R], q *Query[T], opts ...OptionFun
 
 // SelectPageMaps 根据条件分页查询，返回分页Map记录
 func SelectPageMaps[T any](page *Page[map[string]any], q *Query[T], opts ...OptionFunc) (*Page[map[string]any], *gorm.DB) {
-	total, countDb := SelectCount[T](q, opts...)
-	if countDb.Error != nil {
-		return page, countDb
+	option := getOption(opts)
+	// 如果需要分页忽略总数，不查询总数
+	if !option.IgnoreTotal {
+		total, countDb := SelectCount[T](q, opts...)
+		if countDb.Error != nil {
+			return page, countDb
+		}
+		page.Total = total
 	}
-	page.Total = total
 	resultDb := buildCondition(q, opts...)
 	var results []map[string]any
 	resultDb.Scopes(paginate(page)).Find(&results)
@@ -249,6 +263,11 @@ func SelectCount[T any](q *Query[T], opts ...OptionFunc) (int64, *gorm.DB) {
 	return count, resultDb
 }
 
+func Begin(opts ...*sql.TxOptions) *gorm.DB {
+	db := getDb()
+	return db.Begin(opts...)
+}
+
 func paginate[T any](p *Page[T]) func(db *gorm.DB) *gorm.DB {
 	page := p.Current
 	pageSize := p.Size
@@ -341,50 +360,49 @@ func getPkColumnName[T any]() string {
 }
 
 func getDb(opts ...OptionFunc) *gorm.DB {
-	var config Option
-	for _, op := range opts {
-		op(&config)
-	}
-
+	option := getOption(opts)
 	// Clauses()目的是为了初始化Db，如果db已经被初始化了,会直接返回db
 	var db = globalDb.Clauses()
 
-	if config.Db != nil {
-		db = config.Db.Clauses()
+	if option.Db != nil {
+		db = option.Db.Clauses()
 	}
 
 	// 设置需要忽略的字段
-	setOmitIfNeed(config, db)
+	setOmitIfNeed(option, db)
 
 	// 设置选择的字段
-	setSelectIfNeed(config, db)
+	setSelectIfNeed(option, db)
 
 	return db
 }
 
-func setSelectIfNeed(config Option, db *gorm.DB) {
-	if len(config.Selects) > 0 {
+func setSelectIfNeed(option Option, db *gorm.DB) {
+	if len(option.Selects) > 0 {
 		var columnNames []string
-		for _, column := range config.Selects {
+		for _, column := range option.Selects {
 			columnName := getColumnName(column)
 			columnNames = append(columnNames, columnName)
 		}
 		db.Select(columnNames)
 	}
 }
 
-func setOmitIfNeed(config Option, db *gorm.DB) {
-	if len(config.Omits) > 0 {
+func setOmitIfNeed(option Option, db *gorm.DB) {
+	if len(option.Omits) > 0 {
 		var columnNames []string
-		for _, column := range config.Omits {
+		for _, column := range option.Omits {
 			columnName := getColumnName(column)
 			columnNames = append(columnNames, columnName)
 		}
 		db.Omit(columnNames...)
 	}
 }
 
-func Begin(opts ...*sql.TxOptions) *gorm.DB {
-	db := getDb()
-	return db.Begin(opts...)
+func getOption(opts []OptionFunc) Option {
+	var config Option
+	for _, op := range opts {
+		op(&config)
+	}
+	return config
 }

gplus/option.go

@@ -20,27 +20,46 @@ package gplus
 import "gorm.io/gorm"
 
 type Option struct {
-	Omits   []any
-	Selects []any
 	Db      *gorm.DB
+	Selects []any
+	Omits   []any
+
+	IgnoreTotal bool
 }
 
 type OptionFunc func(*Option)
 
-func Omit(columns ...any) OptionFunc {
+// Db 使用传入的Db对象
+func Db(db *gorm.DB) OptionFunc {
 	return func(o *Option) {
-		o.Omits = append(o.Omits, columns...)
+		o.Db = db
 	}
 }
 
+// Session 创建回话
+func Session(session *gorm.Session) OptionFunc {
+	return func(o *Option) {
+		o.Db = globalDb.Session(session)
+	}
+}
+
+// Select 指定需要查询的字段
 func Select(columns ...any) OptionFunc {
 	return func(o *Option) {
 		o.Selects = append(o.Selects, columns...)
 	}
 }
 
-func Db(db *gorm.DB) OptionFunc {
+// Omit 指定需要忽略的字段
+func Omit(columns ...any) OptionFunc {
 	return func(o *Option) {
-		o.Db = db
+		o.Omits = append(o.Omits, columns...)
+	}
+}
+
+// IgnoreTotal 分页查询忽略总数 issue: https://github.com/acmestack/gorm-plus/issues/37
+func IgnoreTotal() OptionFunc {
+	return func(o *Option) {
+		o.IgnoreTotal = true
 	}
 }