全面掌握 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 配合實現複雜的數據庫遷移管理。

總結

在本文中，我們深入探討了 GORM 中的各種遷移技術，包括自動遷移和手動遷移的詳細操作。通過豐富的示例代碼，開發者可以更好地掌握這些技術，爲日常開發過程中的數據庫操作提供極大的便利和靈活性。掌握這些遷移技術，對於保障數據庫一致性和數據安全具有重要意義。

本文由 Readfog 進行 AMP 轉碼，版權歸原作者所有。
來源：https://mp.weixin.qq.com/s/yHhLKVtybIDU9-HMmRqBqw