基本介绍

在分页查询场景中，我们往往需要先调用Scan方法结合Limit/Page链式操作方法查询列表，随后再去掉Limit/Page链式操作方法查询总数量。这一过程较为繁琐，因此从v2.5.0版本开始，框架提供了ScanAndCount方法，用于简化分页查询的场景。

使用示例

示例代码来源于业务项目案例，仅供参考理解，无法独立运行。

使用传统的分页查询逻辑代码：

  1. // GetList 获取实例的用户列表.
  2. func (s sUserInfo) GetList(ctx context.Context, in model.UserInfoGetListInput) (items []entity.UserInfo, total int, err error) {
  3.     items = make([]entity.UserInfo, 0)
  4.     orm := dao.UserInfo.Ctx(ctx).OmitEmpty().Where(do.UserInfo{
  5.         ResourceId: in.ResourceId,
  6.         Status:     in.Statuses,
  7.     })
  8.     err = orm.Order(in.OrderBy, in.OrderDirection).Limit(in.Offset, in.Limit).Scan(&items)
  9.     if err != nil {
  10.         return
  11.     }
  12.     total, err = orm.Count()
  13.     return
  14. }

使用ScanAndCount方法实现分页查询：

  1. // GetList 获取实例的用户列表.
  2. func (s sUserInfo) GetList(ctx context.Context, in model.UserInfoGetListInput) (items []entity.UserInfo, total int, err error) {
  3.     items = make([]entity.UserInfo, 0)
  4.     err = dao.UserInfo.Ctx(ctx).OmitEmpty().
  5.         Where(do.UserInfo{
  6.             ResourceId: in.ResourceId,
  7.             Status:     in.Statuses,
  8.         }).
  9.         Order(in.OrderBy, in.OrderDirection).
  10.         Limit(in.Offset, in.Limit).
  11.         ScanAndCount(&items, &total, true)
  12.     return
  13. }

注意事项

  • 仅用于需要同时查询数据和总数量的场景，一般为分页场景。
  • ScanAndCount的第3个参数useFieldForCount表示是否在执行Count操作的时候将Fields作为Count参数，一般为true即可。传递false表示执行COUNT(1)查询总数量。