Go GORM中的迁移系统，实现自动迁移与手动迁移

在Golang生态系统中，GORM作为一个广泛使用的ORM框架，不仅在数据库操作方面提供了友好的API支持，其迁移系统（Migration System）同样功能强大且易于使用。在本文中，我们将详细解析GORM中的迁移机制，包括自动迁移和手动迁移，同时提供详尽的代码示例，帮助开发者全面掌握这一技术。

什么是数据库迁移？

在数据库系统中，迁移是指对数据库架构进行变更的过程。例如：

• 创建新的表或删除已有的表

• 增加或删除表中的字段

• 修改字段类型

• 为字段添加或删除约束条件

• 创建或移除索引

迁移的目的是为了让数据库模式（Schema）跟随应用程序的需求变化而演化。因此，一个好的ORM框架应当提供便捷的迁移机制，来减少数据库变更带来的风险和工作量。

自动迁移（Auto Migration）

GORM提供了自动迁移功能，可以根据模型（Model）结构自动生成或更新数据库表。

使用AutoMigrate

AutoMigrate是GORM提供的一个函数，用于自动迁移数据库模式。例如：

type User struct {
  ID    uint
  Name  string
  Email string
}

type Product struct {
  ID       uint
  Name     string
  Price    float64
}

type Order struct {
  ID        uint
  ProductID uint
  UserID    uint
}

db.AutoMigrate(&User{})
db.AutoMigrate(&User{}, &Product{}, &Order{})

上述代码会自动创建User、Product、Order表，如果这些表不存在的话，并且会根据结构体的定义创建相应的字段。

值得注意的是：

• AutoMigrate会创建表、缺失的外键、约束、字段和索引。

• 它会在字段大小、精度或可空性发生变化时，修改现有字段的类型。

• 它不会删除未使用的字段以保护数据。

表选项

AutoMigrate支持在创建表时添加选项，例如指定存储引擎：

db.Set("gorm:table_options", "ENGINE=InnoDB").AutoMigrate(&User{})

禁用自动创建外键约束

在某些情况下，可能需要禁用自动创建外键约束，可以在初始化时配置：

db, err := gorm.Open(sqlite.Open("gorm.db"), &gorm.Config{
  DisableForeignKeyConstraintWhenMigrating: true,
})

手动迁移（Manual Migration）

尽管自动迁移非常方便，但有些复杂需求需要更细粒度的控制。这时可以使用GORM提供的Migrator接口进行手动迁移。

Migrator接口详解

Migrator接口提供了统一的API用于数据库无关的迁移操作：

type Migrator interface {
  AutoMigrate(dst ...interface{}) error
  CurrentDatabase() string
  CreateTable(dst ...interface{}) error
  DropTable(dst ...interface{}) error
  HasTable(dst interface{}) bool
  RenameTable(oldName, newName interface{}) error
  AddColumn(dst interface{}, field string) error
  DropColumn(dst interface{}, field string) error
  AlterColumn(dst interface{}, field string) error
  MigrateColumn(dst interface{}, field *schema.Field, columnType ColumnType) error
  HasColumn(dst interface{}, field string) bool
  RenameColumn(dst interface{}, oldName, field string) error
  ColumnTypes(dst interface{}) ([]ColumnType, error)
  CreateView(name string, option ViewOption) error
  DropView(name string) error
  CreateConstraint(dst interface{}, name string) error
  DropConstraint(dst interface{}, name string) error
  HasConstraint(dst interface{}, name string) bool
  CreateIndex(dst interface{}, name string) error
  DropIndex(dst interface{}, name string) error
  HasIndex(dst interface{}, name string) bool
  RenameIndex(dst interface{}, oldName, newName string) error
}

数据库操作

可以使用Migrator接口进行数据库相关操作，例如获取当前数据库名称：

currentDatabase := db.Migrator().CurrentDatabase()
fmt.Println("Current Database:", currentDatabase)

创建表

db.Migrator().CreateTable(&User{})
db.Set("gorm:table_options", "ENGINE=InnoDB").Migrator().CreateTable(&User{})

检查表是否存在

exists := db.Migrator().HasTable(&User{})

删除表

db.Migrator().DropTable(&User{})

重命名表

db.Migrator().RenameTable(&User{}, &UserInfo{})

字段操作

可以使用AddColumn, DropColumn等方法来手动添加、删除或修改表字段。

添加字段

type User struct {
  Name string
}

db.Migrator().AddColumn(&User{}, "Name")

删除字段

db.Migrator().DropColumn(&User{}, "Name")

修改字段

db.Migrator().AlterColumn(&User{}, "Name")

检查字段是否存在

exists := db.Migrator().HasColumn(&User{}, "Name")

重命名字段

type User struct {
  Name    string
  NewName string
}

db.Migrator().RenameColumn(&User{}, "Name", "NewName")

索引操作

创建索引

type User struct {
  Name string `gorm:"size:255;index:idx_name,unique"`
}

db.Migrator().CreateIndex(&User{}, "Name")

删除索引

db.Migrator().DropIndex(&User{}, "Name")

重命名索引

type User struct {
  Name  string `gorm:"size:255;index:idx_name,unique"`
  Name2 string `gorm:"size:255;index:idx_name_2,unique"`
}

db.Migrator().RenameIndex(&User{}, "Name", "Name2")

约束操作

GORM支持设置检查约束条件和外键约束。

创建约束

type User struct {
  Name  string `gorm:"check:name_checker,name <> 'john'"`
}

db.Migrator().CreateConstraint(&User{}, "name_checker")

删除约束

db.Migrator().DropConstraint(&User{}, "name_checker")

外键操作

对关系字段进行外键约束操作，例如：

type User struct {
  gorm.Model
  CreditCards []CreditCard
}

type CreditCard struct {
  gorm.Model
  Number string
  UserID uint
}

db.Migrator().CreateConstraint(&User{}, "CreditCards")

视图操作

GORM支持通过ViewOption创建和管理视图。

创建视图

query := db.Model(&User{}).Where("age > ?", 20)
db.Migrator().CreateView("users_view", gorm.ViewOption{Query: query})

删除视图

db.Migrator().DropView("users_view")

版本化迁移工具

虽然GORM的AutoMigrate特性在大多数情况下都能很好地工作，但在某些情况下，可能需要切换到版本化迁移策略。这时候，可以使用第三方迁移工具如Atlas，与GORM配合实现复杂的数据库迁移管理。