Ent框架版本化迁移功能详解-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00022/article/details/148375924

Ent框架版本化迁移功能详解

ent ent: 是一个基于 Go 语言的轻量级 ORM 库，用于处理关系型数据库。适合开发者使用 ent 进行数据库访问和操作。项目地址: https://gitcode.com/gh_mirrors/en/ent

前言

在数据库开发中，迁移管理是一个至关重要的环节。Ent框架作为Go语言中优秀的ORM框架，近期推出了全新的版本化迁移功能，为开发者提供了更安全、更可控的数据库迁移方案。本文将深入解析这一功能的设计理念、实现原理以及具体使用方法。

迁移管理的发展历程

在数据库迁移领域，主要存在两种主流方案：

声明式迁移：开发者只需描述数据库的期望状态，迁移工具会自动计算出从当前状态到期望状态所需的变更步骤。这种方式的代表有Kubernetes和Terraform。
版本化迁移：开发者需要明确编写每个变更步骤的SQL语句，每个迁移文件都有唯一版本标识。常见工具如Flyway、Liquibase等。

Ent框架最初采用声明式迁移方案，虽然简洁高效，但在某些需要精确控制变更流程的场景下显得不够灵活。新推出的版本化迁移功能则结合了两者的优势。

版本化迁移的核心优势

可审查性：所有迁移文件都可以提交到代码仓库，方便团队审查
精确控制：每个变更步骤都明确可见，避免意外修改
可回滚：为每个升级操作提供对应的回滚方案
版本追踪：清晰记录数据库的变更历史

实战：使用Ent版本化迁移

环境准备

首先确保使用最新版的Ent框架：

go get -u entgo.io/ent@master

基础示例

我们从一个简单的用户模型开始：

// ent/schema/user.go
package schema

import (
	"entgo.io/ent"
	"entgo.io/ent/schema/field"
	"entgo.io/ent/schema/index"
)

type User struct {
	ent.Schema
}

func (User) Fields() []ent.Field {
	return []ent.Field{
		field.String("username"),
	}
}

func (User) Indexes() []ent.Index {
	return []ent.Index{
		index.Fields("username").Unique(),
	}
}

生成迁移文件

创建main.go文件来生成迁移：

package main

import (
	"context"
	"log"
	"os"

	"ariga.io/atlas/sql/migrate"
	"entgo.io/ent/dialect/sql"
	"entgo.io/ent/dialect/sql/schema"
	"entgo.io/ent/entc"
	"entgo.io/ent/entc/gen"
	_ "github.com/go-sql-driver/mysql"
)

func main() {
	if len(os.Args) < 2 {
		log.Fatalln("请提供迁移名称")
	}
	
	dir, err := migrate.NewLocalDir("migrations")
	if err != nil {
		log.Fatalln(err)
	}
	
	graph, err := entc.LoadGraph("./ent/schema", &gen.Config{})
	if err != nil {
		log.Fatalln(err)
	}
	
	tbls, err := graph.Tables()
	if err != nil {
		log.Fatalln(err)
	}
	
	drv, err := sql.Open("mysql", "root:pass@tcp(localhost:3306)/ent")
	if err != nil {
		log.Fatalln(err)
	}
	
	m, err := schema.NewMigrate(drv, schema.WithDir(dir))
	if err != nil {
		log.Fatalln(err)
	}
	
	if err := m.NamedDiff(context.Background(), os.Args[1], tbls...); err != nil {
		log.Fatalln(err)
	}
}

执行命令生成初始迁移：

mkdir migrations
go run -mod=mod main.go initial

这将生成两个文件：

时间戳_initial.up.sql：创建用户表的SQL
时间戳_initial.down.sql：删除用户表的SQL

应用迁移

使用迁移工具执行生成的SQL：

migrate -source 'file://migrations' -database 'mysql://root:pass@tcp(localhost:3306)/ent' up

进阶示例：添加关联模型

现在我们添加一个Group模型并与User建立多对多关系：

// ent/schema/group.go
package schema

import (
	"entgo.io/ent"
	"entgo.io/ent/schema/edge"
	"entgo.io/ent/schema/field"
	"entgo.io/ent/schema/index"
)

type Group struct {
	ent.Schema
}

func (Group) Fields() []ent.Field {
	return []ent.Field{
		field.String("name"),
	}
}

func (Group) Edges() []ent.Edge {
	return []ent.Edge{
		edge.To("users", User.Type),
	}
}

func (Group) Indexes() []ent.Index {
	return []ent.Index{
		index.Fields("name").Unique(),
	}
}

更新User模型添加关联：

func (User) Edges() []ent.Edge {
	return []ent.Edge{
		edge.From("groups", Group.Type).
			Ref("users"),
	}
}

生成新的迁移文件：

go run -mod=mod main.go add_group_schema

自定义迁移：数据初始化

除了模型变更，我们还可以添加数据初始化迁移：

migrate create -format unix -ext sql -dir migrations seed_admin

编辑生成的SQL文件添加初始化数据：

-- 时间戳_seed_admin.up.sql
INSERT INTO `groups` (`id`, `name`) VALUES (1, 'Admins');
INSERT INTO `users` (`id`, `username`) VALUES (1, 'admin');
INSERT INTO `group_users` (`group_id`, `user_id`) VALUES (1, 1);

-- 时间戳_seed_admin.down.sql
DELETE FROM `group_users` where `group_id` = 1 and `user_id` = 1;
DELETE FROM `groups` where id = 1;
DELETE FROM `users` where id = 1;