如何在Golang中实现基础的分页查询功能_Golang分页查询项目实战汇总

分页查询通过定义Pagination结构体接收页码和每页数量,利用GetOffset和GetLimit方法计算SQL的OFFSET和LIMIT值,结合数据库查询获取数据列表与总记录数,再通过PaginatedResult封装包含数据、总数、当前页等信息的响应结果,最后在Gin框架中绑定请求参数并返回分页数据,实现高效、可复用的分页功能。

在Go语言开发中,分页查询是处理数据库大量数据时最常见的需求之一。无论是后台管理系统、API接口还是Web应用,都需要将数据分批次展示,避免一次性加载过多内容导致性能下降。下面介绍如何在Golang中实现一个基础但实用的分页查询功能。

1. 定义分页参数结构体

为了统一管理分页请求的数据,通常会定义一个结构体来接收前端传入的分页信息:

type Pagination struct {
    Page     int `json:"page" form:"page"`         // 当前页码
    PageSize int `json:"page_size" form:"page_size"` // 每页数量
}

func (p Pagination) GetOffset() int { return (p.Page - 1) p.PageSize }

func (p *Pagination) GetLimit() int { return p.PageSize }

这里使用了form标签,方便与Gin等Web框架结合解析URL参数或JSON请求体。GetOffset和GetLimit方法用于生成SQL查询中的LIMIT和OFFSET值。

2. 数据库查询与总数统计

分页需要两个关键数据:当前页的数据列表和总记录数。以MySQL为例,假设有一个文章表articles

type Article struct {
    ID      int    `json:"id"`
    Title   string `json:"title"`
    Content string `json:"content"`
    Created time.Time `json:"created"`
}

func GetArticles(p *Pagination) ([]Article, int64, error) { var articles []Article var total int64

db := GetDB() // 获取数据库连接(*sql.DB 或 GORM DB)

// 先获取总数量
db.Model(&Article{}).Count(&total)

// 查询分页数据
result := db.Offset(p.GetOffset()).Limit(p.GetLimit()).Find(&articles)
if result.Error != nil {
    return nil, 0, result.Error
}

return articles, total, nil

}

如果你使用原生database/sql,可以这样写:

query := "SELECT id, title, content, created FROM articles LIMIT ? OFFSET ?"
rows, err := db.Query(query, p.GetLimit(), p.GetOffset())
...

3. 构建分页响应结果

返回给前端的数据应包含列表、总数、当前页、页大小等信息,便于前端控制翻页逻辑:

type PaginatedResult struct {
    Data       interface{} `json:"data"`
    Total      int64       `json:"total"`
    Page       int         `json:"page"`
    PageSize   int         `json:"page_size"`
    TotalPages int         `json:"total_pages"`
}

func NewPaginatedResult(data interface{}, total int64, page, pageSize int) *PaginatedResult { totalPages := int((total + int64(pageSize) - 1) / int64(pageSize)) return &PaginatedResult{ Data: data, Total: total, Page: page, PageSize: pageSize, TotalPages: totalPages, } }

4. 在HTTP接口中集成分页

以Gin框架为例,实现一个分页查询接口:

func GetArticlesHandler(c *gin.Context) {
    var pagination Pagination
// 绑定查询参数
if err := c.ShouldBindQuery(&pagination); err != nil {
    c.JSON(400, gin.H{"error": err.Error()})
    return
}

// 设置默认值
if pagination.Page == 0 {
    pagination.Page = 1
}
if pagination.PageSize == 0 {
    pagination.PageSize = 10
}

articles, total, err := GetArticles(&pagination)
if err != nil {
    c.JSON(500, gin.H{"error": "查询失败"})
    return
}

result := NewPaginatedResult(articles, total, pagination.Page, pagination.PageSize)
c.JSON(200, result)

}

前端可以通过/articles?page=1&page_size=10进行访问,后端自动完成分页处理。

基本上就这些。这套模式简单清晰,适用于大多数中小型项目。随着业务复杂度上升,可进一步封装成通用分页工具函数,支持排序、条件筛选等扩展功能。关键是理解分页的核心逻辑:偏移计算、数量限制和总数返回。