Gormigrate - Golang数据库模式迁移助手

Gormigrate是一个用于Golang的数据库迁移库，专门为GORM设计。它可以帮助你管理数据库模式的变更，类似于Ruby on Rails的迁移或Django的migrations。

主要特性

• 基于GORM构建
• 支持事务性迁移
• 可以回滚迁移
• 迁移历史记录
• 支持初始化函数
• 简单的API设计

安装

go get -u github.com/go-gormigrate/gormigrate/v2

基本用法

1. 初始化Gormigrate

package main

import (
	"log"
	
	"github.com/go-gormigrate/gormigrate/v2"
	"gorm.io/gorm"
	"gorm.io/driver/sqlite"
)

func main() {
	db, err := gorm.Open(sqlite.Open("test.db"), &gorm.Config{})
	if err != nil {
		log.Fatal(err)
	}
	
	m := gormigrate.New(db, gormigrate.DefaultOptions, []*gormigrate.Migration{
		// 在这里添加你的迁移
	})
	
	if err = m.Migrate(); err != nil {
		log.Fatalf("Could not migrate: %v", err)
	}
	log.Printf("Migration did run successfully")
}

2. 创建迁移

每个迁移需要定义一个唯一的ID、Migrate函数和Rollback函数：

type User struct {
	gorm.Model
	Name string
	Email string
}

// 创建users表的迁移
createUsersTable := &gormigrate.Migration{
	ID: "202108010000", // 使用时间戳确保唯一性
	Migrate: func(tx *gorm.DB) error {
		return tx.AutoMigrate(&User{})
	},
	Rollback: func(tx *gorm.DB) error {
		return tx.Migrator().DropTable("users")
	},
}

// 添加age字段到users表
addAgeToUsers := &gormigrate.Migration{
	ID: "202108010001",
	Migrate: func(tx *gorm.DB) error {
		// 检查字段是否已存在
		if tx.Migrator().HasColumn(&User{}, "age") {
			return nil
		}
		return tx.Migrator().AddColumn(&User{}, "Age")
	},
	Rollback: func(tx *gorm.DB) error {
		return tx.Migrator().DropColumn(&User{}, "Age")
	},
}

3. 完整示例

package main

import (
	"log"
	
	"github.com/go-gormigrate/gormigrate/v2"
	"gorm.io/gorm"
	"gorm.io/driver/sqlite"
)

type User struct {
	gorm.Model
	Name  string
	Email string `gorm:"unique"`
	Age   int
}

func main() {
	db, err := gorm.Open(sqlite.Open("mydb.db"), &gorm.Config{})
	if err != nil {
		log.Fatal(err)
	}
	
	// 设置迁移选项
	options := &gormigrate.Options{
		TableName:      "migrations",
		IDColumnName:   "id",
		IDColumnSize:   255,
		UseTransaction: true,
	}
	
	// 初始化迁移
	m := gormigrate.New(db, options, []*gormigrate.Migration{
		// 初始迁移 - 创建users表
		{
			ID: "202108010000",
			Migrate: func(tx *gorm.DB) error {
				return tx.AutoMigrate(&User{})
			},
			Rollback: func(tx *gorm.DB) error {
				return tx.Migrator().DropTable("users")
			},
		},
		// 第二次迁移 - 添加age字段
		{
			ID: "202108010001",
			Migrate: func(tx *gorm.DB) error {
				if tx.Migrator().HasColumn(&User{}, "age") {
					return nil
				}
				return tx.Migrator().AddColumn(&User{}, "Age")
			},
			Rollback: func(tx *gorm.DB) error {
				return tx.Migrator().DropColumn(&User{}, "Age")
			},
		},
	})
	
	// 执行迁移
	if err = m.Migrate(); err != nil {
		log.Fatalf("Could not migrate: %v", err)
	}
	
	log.Println("Migration did run successfully")
}

高级用法

1. 初始化函数

你可以在第一次迁移前执行初始化代码：

m := gormigrate.New(db, options, []*gormigrate.Migration{
    // 你的迁移
})

m.InitSchema(func(tx *gorm.DB) error {
    // 初始化数据库模式
    err := tx.AutoMigrate(&User{}, &Product{})
    if err != nil {
        return err
    }
    
    // 添加外键
    if err := tx.Table("products").AddForeignKey("user_id", "users(id)", "RESTRICT", "RESTRICT").Error; err != nil {
        return err
    }
    
    return nil
})

2. 回滚迁移

可以回滚到特定迁移：

// 回滚到特定迁移ID
err := m.RollbackTo("202108010000")
if err != nil {
    log.Fatal(err)
}

// 回滚最后一步迁移
err := m.RollbackLast()
if err != nil {
    log.Fatal(err)
}

3. 使用事务

默认情况下，Gormigrate会在事务中执行每个迁移。你可以通过选项控制：

options := &gormigrate.Options{
    UseTransaction: true, // 默认为true
}

4. 自定义迁移表

可以自定义存储迁移历史的表名和列名：

options := &gormigrate.Options{
    TableName:      "custom_migrations",
    IDColumnName:   "migration_id",
    IDColumnSize:   100,
}

最佳实践

1. 迁移ID命名：使用时间戳格式(YYYYMMDDhhmmss)确保唯一性和顺序
2. 幂等性：确保迁移可以安全地多次运行
3. 小步迁移：每个迁移应该只做一件事
4. 测试迁移：在生产环境运行前测试迁移和回滚
5. 版本控制：将迁移文件纳入版本控制系统

Gormigrate是一个简单但功能强大的迁移工具，特别适合与GORM一起使用。它提供了数据库模式变更所需的基本功能，同时保持了API的简洁性。