登录
首页 >  Golang >  Go教程

Golang实现REST API分页查询方法

时间:2026-05-16 17:11:21 422浏览 收藏

本文深入讲解了在Golang中构建高性能、健壮的REST API分页查询功能的完整实践:从定义带默认值与安全校验的分页结构体,到精准计算offset/limit并结合原生SQL或GORM高效查询数据,再到封装包含总记录数、总页数、当前页等关键元信息的标准响应,同时强调限制最大页尺寸防范深分页风险,并前瞻性指出游标分页作为高并发场景下的性能优化方案——掌握这些要点,你将能快速落地生产就绪的分页API。

如何在Golang中处理REST API分页查询

在Golang中处理REST API分页查询,核心是解析客户端传入的分页参数,构造带限制条件的数据库查询,并返回带有分页元信息的结果。关键点包括:定义分页结构体、校验和设置默认值、与数据库交互、返回标准化响应。

定义分页参数结构体

创建一个结构体来接收客户端传来的分页参数,通常包括页码和每页数量,也可支持偏移量和限制条数模式。

type Pagination struct {
    Page int `json:"page"`
    PageSize int `json:"page_size"`
}

在实际处理中,若未提供参数,应设置默认值,比如 page=1,page_size=10,并限制最大值防止恶意请求。

func (p *Pagination) SetDefaults() {
    if p.Page < 1 {
        p.Page = 1
    }
    if p.PageSize < 1 || p.PageSize > 100 {
        p.PageSize = 10
    }
}

构建数据库查询语句

使用计算出的 offset 和 limit 来构造 SQL 查询或 ORM 查询。以 OFFSET/LIMIT 模式为例:

offset := (p.Page - 1) * p.PageSize
query := "SELECT id, name, email FROM users LIMIT ? OFFSET ?"
rows, err := db.Query(query, p.PageSize, offset)

如果使用 GORM 等 ORM,可链式调用:

var users []User
db.Offset(offset).Limit(p.PageSize).Find(&users)

返回分页结果与元信息

除了数据列表,还应返回总记录数、当前页、每页大小等,方便前端控制翻页。

type PaginatedResponse struct {
    Data []User `json:"data"`
    Total int `json:"total"`
    Page int `json:"page"`
    PageSize int `json:"page_size"`
    Pages int `json:"pages"`
}

计算总页数:

var total int64
db.Model(&User{}).Count(&total)
pages := int(total) / p.PageSize
if int(total)%p.PageSize > 0 {
    pages++
}

最终将结果封装返回:

response := PaginatedResponse{
    Data: users,
    Total: int(total),
    Page: p.Page,
    PageSize: p.PageSize,
    Pages: pages,
}
json.NewEncoder(w).Encode(response)

基本上就这些。合理封装分页逻辑,能提升API可用性和性能。注意避免深分页问题,必要时可改用游标分页(cursor-based pagination)。

本篇关于《Golang实现REST API分页查询方法》的介绍就到此结束啦,但是学无止境,想要了解学习更多关于Golang的相关知识,请关注golang学习网公众号!

资料下载
相关阅读
更多>
最新阅读
更多>
课程推荐
更多>