Ent框架快速入门指南：构建Go语言实体关系模型

Ent框架快速入门指南：构建Go语言实体关系模型

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

什么是Ent框架

Ent是一个简单而强大的Go语言实体框架，它让开发者能够轻松构建和维护具有大型数据模型的应用程序。Ent框架遵循以下核心设计原则：

1. 以图结构方式建模数据库模式
2. 使用Go代码定义数据模式
3. 基于代码生成的静态类型系统
4. 简化数据库查询和图遍历操作
5. 支持通过Go模板进行扩展和定制

环境准备

初始化Go模块

在项目根目录下执行以下命令初始化Go模块：

go mod init entdemo

创建第一个数据模型

生成用户模型

在项目根目录运行：

go run -mod=mod entgo.io/ent/cmd/ent new User

这将在entdemo/ent/schema/目录下生成User模型的初始代码。

定义模型字段

编辑生成的用户模型文件，添加age和name字段：

// Fields of the User.
func (User) Fields() []ent.Field {
    return []ent.Field{
        field.Int("age").
            Positive(),  // 年龄必须为正数
        field.String("name").
            Default("unknown"),  // 默认值为"unknown"
    }
}

生成模型代码

运行以下命令生成完整的模型代码：

go generate ./ent

数据库操作

连接数据库

Ent支持多种数据库，以下是SQLite连接示例：

client, err := ent.Open("sqlite3", "file:ent?mode=memory&cache=shared&_fk=1")
if err != nil {
    log.Fatalf("数据库连接失败: %v", err)
}
defer client.Close()

// 执行自动迁移
if err := client.Schema.Create(context.Background()); err != nil {
    log.Fatalf("模式迁移失败: %v", err)
}

创建用户记录

func CreateUser(ctx context.Context, client *ent.Client) (*ent.User, error) {
    u, err := client.User.
        Create().
        SetAge(30).
        SetName("张三").
        Save(ctx)
    if err != nil {
        return nil, fmt.Errorf("创建用户失败: %w", err)
    }
    log.Println("用户创建成功: ", u)
    return u, nil
}

查询用户记录

func QueryUser(ctx context.Context, client *ent.Client) (*ent.User, error) {
    u, err := client.User.
        Query().
        Where(user.Name("张三")).
        Only(ctx)
    if err != nil {
        return nil, fmt.Errorf("查询用户失败: %w", err)
    }
    log.Println("查询到的用户: ", u)
    return u, nil
}

定义实体关系

创建关联模型

生成Car和Group模型：

go run -mod=mod entgo.io/ent/cmd/ent new Car Group

定义一对多关系

在User模型中添加cars边：

// Edges of the User.
func (User) Edges() []ent.Edge {
    return []ent.Edge{
        edge.To("cars", Car.Type),
    }
}

定义反向关系

在Car模型中添加owner反向边：

// Edges of the Car.
func (Car) Edges() []ent.Edge {
    return []ent.Edge{
        edge.From("owner", User.Type).
            Ref("cars").
            Unique(),  // 确保一辆车只能有一个车主
    }
}

创建关联数据

func CreateCars(ctx context.Context, client *ent.Client) (*ent.User, error) {
    // 创建两辆车
    tesla, _ := client.Car.Create().SetModel("特斯拉").Save(ctx)
    ford, _ := client.Car.Create().SetModel("福特").Save(ctx)
    
    // 创建用户并关联车辆
    user, err := client.User.
        Create().
        SetAge(30).
        SetName("李四").
        AddCars(tesla, ford).
        Save(ctx)
    return user, err
}

高级查询

图遍历查询

// 查询GitHub组中所有用户的车辆
cars, err := client.Group.
    Query().
    Where(group.Name("GitHub")).
    QueryUsers().
    QueryCars().
    All(ctx)

多条件查询

// 查询年龄大于25岁且拥有特斯拉汽车的用户
users, err := client.User.
    Query().
    Where(
        user.AgeGT(25),
        user.HasCarsWith(car.Model("特斯拉")),
    ).
    All(ctx)

模式迁移

Ent提供两种迁移方式：

自动迁移

适用于开发和测试环境：

if err := client.Schema.Create(ctx); err != nil {
    log.Fatalf("模式迁移失败: %v", err)
}

版本化迁移

适用于生产环境，生成迁移文件：

atlas migrate diff <迁移名称> \
  --dir "file://migrations" \
  --to "ent://ent/schema" \
  --dev-url "sqlite://file?mode=memory&_fk=1"

然后应用迁移：

atlas migrate apply \
  --dir "file://migrations" \
  --url "<数据库连接字符串>"

总结

Ent框架为Go开发者提供了一种类型安全、直观的方式来处理数据库操作和复杂的关系模型。通过代码生成和强大的查询构建器，Ent简化了数据访问层的开发工作，同时保持了良好的性能和可扩展性。无论是简单的CRUD操作还是复杂的图遍历查询，Ent都能提供优雅的解决方案。

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