Gorm Cursor Paginator 项目教程

1. 项目的目录结构及介绍

gorm-cursor-paginator/
├── example/
│   └── main.go
├── internal/
│   └── util/
├── paginator/
├── .gitignore
├── .travis.yml
├── LICENSE
├── Makefile
├── README.md
├── docker-compose.yml
├── go.mod
├── go.sum

目录结构介绍

• example/: 包含项目的示例代码，展示了如何使用 gorm-cursor-paginator 进行分页。
• internal/util/: 包含项目内部使用的工具函数或模块。
• paginator/: 包含分页器的主要实现代码。
• .gitignore: Git 忽略文件，指定哪些文件或目录不需要被版本控制。
• .travis.yml: Travis CI 配置文件，用于持续集成。
• LICENSE: 项目的开源许可证文件。
• Makefile: 包含项目的构建和测试命令。
• README.md: 项目的说明文档，包含项目的介绍、安装和使用方法。
• docker-compose.yml: Docker 配置文件，用于容器化部署。
• go.mod: Go 模块文件，定义了项目的依赖关系。
• go.sum: Go 模块的校验文件，确保依赖的完整性和安全性。

2. 项目的启动文件介绍

项目的启动文件位于 example/main.go，该文件展示了如何使用 gorm-cursor-paginator 进行分页。以下是 main.go 文件的简要介绍：

package main

import (
    "github.com/pilagod/gorm-cursor-paginator/v2/paginator"
    "gorm.io/gorm"
    "gorm.io/driver/sqlite"
)

func main() {
    // 初始化数据库连接
    db, err := gorm.Open(sqlite.Open("test.db"), &gorm.Config{})
    if err != nil {
        panic("failed to connect database")
    }

    // 定义模型
    type User struct {
        ID        int
        JoinedAt  time.Time `gorm:"column:created_at"`
    }

    // 创建分页器
    p := paginator.New(&paginator.Config{
        Keys: []string{"ID", "JoinedAt"},
    })

    // 执行分页查询
    var users []User
    db.Scopes(p.Paginate(&users)).Find(&users)

    // 输出结果
    for _, user := range users {
        fmt.Println(user.ID, user.JoinedAt)
    }
}

启动文件介绍

• main.go: 该文件展示了如何初始化数据库连接、定义模型、创建分页器并执行分页查询。通过该文件，用户可以快速了解如何在自己的项目中使用 gorm-cursor-paginator。

3. 项目的配置文件介绍

项目的配置文件主要包括 go.mod 和 docker-compose.yml。

go.mod

go.mod 文件定义了项目的依赖关系，以下是 go.mod 文件的简要内容：

module github.com/pilagod/gorm-cursor-paginator

go 1.16

require (
    github.com/go-sql-driver/mysql v1.6.0
    github.com/jinzhu/gorm v1.9.16
    github.com/mattn/go-sqlite3 v1.14.7
    gorm.io/driver/sqlite v1.1.4
    gorm.io/gorm v1.21.12
)

docker-compose.yml

docker-compose.yml 文件用于定义项目的容器化部署配置，以下是 docker-compose.yml 文件的简要内容：

version: '3'
services:
  app:
    build: .
    ports:
      - "8080:8080"
    volumes:
      - .:/app
    depends_on:
      - db
  db:
    image: mysql:5.7
    environment:
      MYSQL_ROOT_PASSWORD: example
    ports:
      - "3306:3306"

配置文件介绍

• go.mod: 定义了项目的 Go 模块及其依赖关系，确保项目在不同环境中的一致性。
• docker-compose.yml: 定义了项目的容器化部署配置，包括应用服务和数据库服务的配置。

通过以上配置文件，用户可以轻松地在本地或生产环境中部署和运行 gorm-cursor-paginator 项目。