快捷導(dǎo)航

Go語言結(jié)合Gin框架快速實(shí)現(xiàn)分頁查詢接口

更新時(shí)間：2025年08月19日 09:37:01 作者：程序員愛釣魚

在開發(fā)?Web?應(yīng)用時(shí),分頁查詢?是非常常見的需求,在?Go?語言中,我們可以結(jié)合?GORM?+?Gin?框架,快速實(shí)現(xiàn)分頁查詢接口,下面我們來看看具體實(shí)現(xiàn)方法吧

一、環(huán)境準(zhǔn)備

依賴庫安裝：

go get -u gorm.io/gorm
go get -u gorm.io/driver/mysql
go get -u github.com/gin-gonic/gin

數(shù)據(jù)庫使用 MySQL（也可換 SQLite、Postgres）。

二、定義用戶模型

我們以 User 模型作為例子：

package main

import (
    "github.com/gin-gonic/gin"
    "gorm.io/driver/mysql"
    "gorm.io/gorm"
    "log"
    "net/http"
)

// User 用戶模型
type User struct {
    ID    uint   `gorm:"primaryKey"`
    Name  string `gorm:"size:100"`
    Email string `gorm:"unique"`
    Age   int
}

var db *gorm.DB

func initDB() {
    dsn := "root:123456@tcp(127.0.0.1:3306)/testdb?charset=utf8mb4&parseTime=True&loc=Local"
    var err error
    db, err = gorm.Open(mysql.Open(dsn), &gorm.Config{})
    if err != nil {
        log.Fatal("數(shù)據(jù)庫連接失敗:", err)
    }
    // 自動(dòng)遷移
    _ = db.AutoMigrate(&User{})
}

三、實(shí)現(xiàn)分頁查詢接口

分頁查詢的核心就是 計(jì)算 offset 和 limit：

page 當(dāng)前頁（從 1 開始）
pageSize 每頁數(shù)量
offset = (page - 1) * pageSize

代碼實(shí)現(xiàn)：

// 分頁查詢接口
func getUsers(c *gin.Context) {
    // 獲取查詢參數(shù)，默認(rèn) page=1, pageSize=10
    page := c.DefaultQuery("page", "1")
    pageSize := c.DefaultQuery("pageSize", "10")

    var (
        users []User
        total int64
    )

    // 轉(zhuǎn)換為 int
    var p, ps int
    fmt.Sscanf(page, "%d", &p)
    fmt.Sscanf(pageSize, "%d", &ps)
    if p < 1 {
        p = 1
    }
    if ps < 1 {
        ps = 10
    }

    // 查詢總數(shù)
    db.Model(&User{}).Count(&total)

    // 分頁查詢
    db.Offset((p - 1) * ps).Limit(ps).Find(&users)

    // 返回 JSON
    c.JSON(http.StatusOK, gin.H{
        "page":     p,
        "pageSize": ps,
        "total":    total,
        "data":     users,
    })
}

在 main() 中注冊(cè)路由：

func main() {
    initDB()

    r := gin.Default()
    r.GET("/users", getUsers)

    r.Run(":8080")
}

四、接口調(diào)用效果

請(qǐng)求：

curl "http://localhost:8080/users?page=2&pageSize=5"

返回：

{
  "page": 2,
  "pageSize": 5,
  "total": 23,
  "data": [
    {"ID":6,"Name":"Alice","Email":"alice@test.com","Age":22},
    {"ID":7,"Name":"Bob","Email":"bob@test.com","Age":25},
    {"ID":8,"Name":"Tom","Email":"tom@test.com","Age":20},
    {"ID":9,"Name":"Jerry","Email":"jerry@test.com","Age":30},
    {"ID":10,"Name":"Lucy","Email":"lucy@test.com","Age":19}
  ]
}