什么是 goose 以及为什么需要它

goose 库（Go 面向对象 SQL 环境）是 Go 生态系统中用于管理数据库迁移的强大工具。与内置解决方案不同，goose 提供了一种声明式的方法来对数据库模式进行版本控制，允许开发者用 SQL 或 Go 代码描述更改。goose 的主要任务是自动化应用和回滚数据库结构更改的过程，这对于团队开发和 CI/CD 管道至关重要。

为什么需要 goose？首先，它解决了开发者之间数据库模式同步的问题：团队中的每个成员都可以通过一个命令应用最新的迁移。其次，goose 支持版本控制——每个迁移都有一个唯一的编号，从而可以精确确定哪些更改已经应用。第三，该库能够通过统一的接口与各种数据库管理系统（PostgreSQL、MySQL、SQLite、ClickHouse 等）配合使用，从而简化了环境之间的切换。

goose 相对于同类工具（例如 golang-migrate/migrate）的关键优势在于它支持 Go 语言编写的迁移，而不仅仅是 SQL。您可以编写包含业务逻辑的复杂迁移，使用事务并调用外部 API。此外，goose 提供了对 embed（将迁移嵌入到二进制文件中）的内置支持，这非常适合生产环境。

安装

通过标准的 Go 包管理器即可完成 goose 的安装。首先，请确保您已安装 Go 1.18 或更高版本。

go install github.com/pressly/goose/v3/cmd/goose@latest

安装后，检查版本：

goose --version

要在项目中作为库使用 goose，请添加依赖项：

go get github.com/pressly/goose/v3

您还需要一个适用于您数据库管理系统的驱动程序。例如，对于 PostgreSQL：

go get github.com/lib/pq

对于 MySQL：

go get github.com/go-sql-driver/mysql

对于 SQLite：

go get github.com/mattn/go-sqlite3

快速入门——最小工作示例

让我们创建一个简单的项目来演示 goose 的基本功能。

1. 创建项目目录并初始化模块：

mkdir goose-demo && cd goose-demo\ngo mod init goose-demo

2. 创建迁移目录：

mkdir migrations

3. 创建第一个 SQL 迁移。文件 migrations/001_create_users.sql：

-- +goose Up\nCREATE TABLE users (\n    id SERIAL PRIMARY KEY,\n    name VARCHAR(255) NOT NULL,\n    email VARCHAR(255) UNIQUE NOT NULL,\n    created_at TIMESTAMP DEFAULT NOW()\n);\n\n-- +goose Down\nDROP TABLE users;

4. 创建 main.go 文件以编程方式运行迁移：

package main\n\nimport (\n    "database/sql"\n    "embed"\n    "log"\n\n    "github.com/pressly/goose/v3"\n    _ "github.com/lib/pq"\n)\n\n//go:embed migrations/*.sql\nvar migrations embed.FS\n\nfunc main() {\n    // 连接到数据库\n    db, err := sql.Open("postgres", "host=localhost port=5432 user=postgres password=postgres dbname=testdb sslmode=disable")\n    if err != nil {\n        log.Fatal(err)\n    }\n    defer db.Close()\n\n    // 从 embed.FS 设置迁移源\n    goose.SetBaseFS(migrations)\n\n    // 执行迁移到最新版本