悠悠楠杉
网站页面
如何用Golang编写一个数据库迁移工具
11/28
![]()
在现代软件开发中，数据库结构的持续演进是不可避免的。随着业务需求变化，我们不断需要添加新表、修改字段、调整索引或重命名列。如果这些变更不能被有效追踪和自动化部署，团队协作将变得混乱，生产环境的数据一致性也难以保障。因此，一个可靠的数据库迁移工具显得尤为重要。
Golang 凭借其简洁的语法、出色的并发支持以及跨平台编译能力，非常适合用来编写这类基础设施类工具。本文将带你一步步实现一个基于 Golang 的数据库迁移工具，它能读取 SQL 脚本文件、按版本顺序执行，并记录已执行的迁移状态，确保每次部署都能安全、可重复地更新数据库结构。
首先，我们需要明确迁移工具的核心设计原则：幂等性、可追溯性和自动化。这意味着每一次迁移只能执行一次，执行结果应被记录，且整个流程可通过命令行一键触发。为此，我们将采用“版本号 + 时间戳”的命名方式来管理迁移脚本，例如 001_create_users_table.sql、002_add_email_index.sql，并使用一张元数据表（如 schema_migrations）来存储已应用的版本。
项目结构建议如下：
migrate/
├── main.go
├── migrate.go
├── scripts/
│ ├── 001_init.sql
│ └── 002_add_status.sql
└── config.json
在 main.go 中，我们使用 flag 包解析命令行参数，支持 up 和 down 子命令。up 表示执行未完成的迁移，down 可用于回滚（本文暂不展开）。核心逻辑封装在 migrate.go 中，负责连接数据库、扫描脚本目录、比对已执行版本并执行新增脚本。
数据库连接通过 database/sql 包实现，配合 github.com/go-sql-driver/mysql 或 lib/pq 等驱动。启动时，程序会先检查 schema_migrations 表是否存在，若无则创建。该表仅需两个字段：version（整数或字符串）和 applied_at（时间戳）。
接下来是脚本扫描逻辑。我们使用 os.ReadDir 遍历 scripts/ 目录，过滤出以 .sql 结尾的文件，并按文件名排序。这里要注意命名规范的强制校验——如果发现跳号或格式错误，应提前报错，避免后续执行混乱。
每条未执行的脚本将被逐个读取内容，使用 db.Exec() 执行其 SQL 语句。关键点在于：所有操作应在同一个事务中进行，确保原子性。一旦某个脚本执行失败，整个迁移过程应回滚，并输出清晰的错误信息，包括文件名和错误详情，方便开发者定位问题。
执行成功后，程序将当前脚本的版本号插入 schema_migrations 表，并提交事务。这样下次运行时，该脚本将被自动跳过。为了提升用户体验，可以在控制台输出彩色日志，标记“跳过”、“执行”、“失败”等状态，让流程更加直观。
此外，配置文件 config.json 用于存储数据库连接信息，如 host、port、user、password、dbname 等，避免硬编码。程序启动时读取该文件，动态构建 DSN（Data Source Name），提高可移植性。
这个工具虽然轻量，但已具备实用价值。它可以集成到 CI/CD 流程中，在代码部署前自动执行数据库迁移，减少人为失误。同时，由于使用 Go 编写，最终可编译为单个二进制文件，无需依赖运行环境，极大简化了部署流程。
未来可扩展方向包括支持多数据库适配、生成迁移脚本模板、添加 --dry-run 模式预览执行计划，甚至支持 Go 代码形式的迁移（而非纯 SQL）。但无论如何演进，保持简单、可靠和透明始终是这类工具的设计核心。
