分页查询API需定义含页码和每页数量的请求结构,使用goRM通过Offset和Limit实现数据库分页,先查总数再查数据,响应包含数据列表、总数、当前页、每页数及总页数,建议校验参数并优化count性能。

在golang中实现分页查询API,关键在于合理设计请求参数、数据库查询逻辑以及响应结构。下面是一个清晰、实用的实现方式,适用于大多数Web服务场景。
定义分页请求参数
客户端通常通过URL查询参数传递分页信息,常见的参数包括页码和每页数量,或偏移量与限制数。
可以定义一个结构体来解析这些参数:
type Pagination struct { Page int `json:"page" query:"page"` Limit int `json:"limit" query:"limit"` }
默认值建议设置:Page为1,Limit为10或20。在处理时做校验:
立即学习“go语言免费学习笔记(深入)”;
- 若Page小于1,设为1
- 若Limit超出范围(如大于100),设为最大允许值
构建数据库查询(以GORM为例)
使用流行的ORM库如GORM时,分页可通过Offset和Limit实现。
示例代码:
func GetUsers(pagination Pagination) ([]User, int64, error) { var users []User var total int64 <pre class='brush:php;toolbar:false;'>offset := (pagination.Page - 1) * pagination.Limit db.Model(&User{}).Count(&total) err := db.Offset(offset).Limit(pagination.Limit).Find(&users).Error return users, total, err
}
这里先获取总数用于计算总页数,再执行带分页的查询。
返回分页响应结构
API响应应包含数据列表、总数、当前页、每页数量等信息,方便前端处理。
定义响应结构:
type PagedResponse struct { Data interface{} `json:"data"` Total int64 `json:"total"` Page int `json:"page"` Limit int `json:"limit"` TotalPages int `json:"total_pages"` } </font><p>计算总页数:</p><font face="Courier New"><pre class="brush:php;toolbar:false;"> totalPages := int((total + int64(limit) - 1) / int64(limit))
users, total, err := GetUsers(pagination) if err != nil { // 处理错误 } response := PagedResponse{ Data: users, Total: total, Page: pagination.Page, Limit: pagination.Limit, TotalPages: totalPages, } c.JSON(200, response)
优化建议
- 缓存总数(适用于不频繁变更的数据)
- 使用游标分页(Cursor-based Pagination),基于排序字段(如ID或时间)进行下一页查询,避免OFFSET
- 接口支持按创建时间范围过滤,减少扫描数据量
基本上就这些。分页看似简单,但结合实际业务时要注意边界处理和性能影响。只要参数清晰、结构统一,就能提供稳定易用的API。


