Golang实现REST API分页查询方法
时间:2026-05-16 17:11:21 422浏览 收藏
本文深入讲解了在Golang中构建高性能、健壮的REST API分页查询功能的完整实践:从定义带默认值与安全校验的分页结构体,到精准计算offset/limit并结合原生SQL或GORM高效查询数据,再到封装包含总记录数、总页数、当前页等关键元信息的标准响应,同时强调限制最大页尺寸防范深分页风险,并前瞻性指出游标分页作为高并发场景下的性能优化方案——掌握这些要点,你将能快速落地生产就绪的分页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.PageSizequery := "SELECT id, name, email FROM users LIMIT ? OFFSET ?"
rows, err := db.Query(query, p.PageSize, offset)
如果使用 GORM 等 ORM,可链式调用:
var users []Userdb.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 int64db.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学习网公众号!
相关阅读
更多>
-
505 收藏
-
503 收藏
-
502 收藏
-
502 收藏
-
502 收藏
最新阅读
更多>
-
128 收藏
-
433 收藏
-
418 收藏
-
263 收藏
-
422 收藏
-
396 收藏
-
105 收藏
-
369 收藏
-
330 收藏
-
443 收藏
-
433 收藏
-
215 收藏
课程推荐
更多>
-
- 前端进阶之JavaScript设计模式
- 设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
- 立即学习 543次学习
-
- GO语言核心编程课程
- 本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
- 立即学习 516次学习
-
- 简单聊聊mysql8与网络通信
- 如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
- 立即学习 500次学习
-
- JavaScript正则表达式基础与实战
- 在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
- 立即学习 487次学习
-
- 从零制作响应式网站—Grid布局
- 本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
- 立即学习 485次学习