Golang GORM系列：GORM分页和排序

news2025/3/12 17:55:11

高效的数据检索和表示是应用程序开发的关键方面。GORM是健壮的Go对象关系映射库，它为开发人员提供了强大的工具来实现这一点。无论你是在构建动态web应用程序还是数据密集型服务，掌握GORM中的分页和排序使您能够提供无缝且高效的用户体验。本文我们将深入研究GORM中的分页和排序。到最后，你将熟练地实现这些功能，以简化数据表示并增强Go项目中的用户体验。

在这里插入图片描述

GORM实现分页

分页使您能够在可管理的块中检索和呈现数据，从而提高性能和可用性。

第一步：Limit 和 Offset

使用GORM的‘ Limit ’和‘ Offset ’方法来实现分页：

var products []Product
db.Limit(10).Offset(20).Find(&products)

步骤2：用页码进行分页

使用页码和每页固定数量的记录实现分页：

pageNumber := 2
pageSize := 10
var products []Product
db.Limit(pageSize).Offset((pageNumber - 1) * pageSize).Find(&products)

GORM查询结果排序

根据特定的标准对查询结果进行排序，增强了数据的表示和可用性。

步骤1：对查询结果进行排序

使用GORM的‘ Order ’方法对查询结果进行排序：

var sortedProducts []Product
db.Order("price desc").Find(&sortedProducts)

示例：使用GORM按多列排序

要按多列对查询结果排序，请在‘ Order ’方法中使用逗号分隔的列表：

var products []Product
db.Order("category asc, price desc").Find(&products)

完整示例

假设我们有一个电商平台，其中有一个商品表 products，表结构如下：

CREATE TABLE products (
    id INT PRIMARY KEY AUTO_INCREMENT,
    name VARCHAR(255) NOT NULL,
    price DECIMAL(10, 2) NOT NULL,
    created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
);

我们需要实现一个功能：查询所有商品，并按照价格从高到低排序，同时支持分页。

GORM 实现分页和排序

定义模型

首先，我们需要定义一个与 products 表对应的 GORM 模型：

type Product struct {
    ID        uint      `gorm:"primaryKey"`
    Name      string    `gorm:"size:255;not null"`
    Price     float64   `gorm:"type:decimal(10,2);not null"`
    CreatedAt time.Time `gorm:"default:CURRENT_TIMESTAMP"`
}

分页和排序查询

接下来，我们实现一个函数来查询商品列表，并支持分页和排序：

package main

import (
    "fmt"
    "gorm.io/driver/mysql"
    "gorm.io/gorm"
    "time"
)

type Product struct {
    ID        uint      `gorm:"primaryKey"`
    Name      string    `gorm:"size:255;not null"`
    Price     float64   `gorm:"type:decimal(10,2);not null"`
    CreatedAt time.Time `gorm:"default:CURRENT_TIMESTAMP"`
}

func main() {
    dsn := "user:password@tcp(127.0.0.1:3306)/dbname?charset=utf8mb4&parseTime=True&loc=Local"
    db, err := gorm.Open(mysql.Open(dsn), &gorm.Config{})
    if err != nil {
        panic("failed to connect database")
    }

    // 自动迁移 schema
    db.AutoMigrate(&Product{})

    // 查询商品列表，支持分页和排序
    page := 1
    pageSize := 10
    var products []Product
    result := db.Order("price desc").Offset((page - 1) * pageSize).Limit(pageSize).Find(&products)
    if result.Error != nil {
        panic(result.Error)
    }

    // 输出查询结果
    for _, product := range products {
        fmt.Printf("ID: %d, Name: %s, Price: %.2f, CreatedAt: %s\n", product.ID, product.Name, product.Price, product.CreatedAt)
    }
}

代码解释

连接数据库：使用 gorm.Open 连接 MySQL 数据库。
自动迁移：db.AutoMigrate(&Product{}) 会自动创建或更新表结构。
分页和排序查询：
- Order("price desc")：按照 price 字段降序排列。
- Offset((page - 1) * pageSize)：计算偏移量，跳过前面的记录。
- Limit(pageSize)：限制每页的记录数。
- Find(&products)：执行查询并将结果存储到 products 切片中。
输出结果：遍历 products 切片并输出每个商品的信息。

分页和排序的扩展

在实际项目中，分页和排序的需求可能会更加复杂。例如：

多字段排序：可以按照多个字段进行排序，例如先按价格排序，再按创建时间排序：
```
db.Order("price desc, created_at asc").Offset((page - 1) * pageSize).Limit(pageSize).Find(&products)
```

动态分页和排序：可以根据用户输入的参数动态调整分页和排序条件：

func GetProducts(db *gorm.DB, page, pageSize int, sortField, sortOrder string) ([]Product, error) {
    var products []Product
    query := db.Model(&Product{})
    if sortField != "" {
        order := fmt.Sprintf("%s %s", sortField, sortOrder)
        query = query.Order(order)
    }
    result := query.Offset((page - 1) * pageSize).Limit(pageSize).Find(&products)
    return products, result.Error
}