开源项目 ent 使用教程

1. 项目的目录结构及介绍

ent 项目的目录结构如下：

ent/
├── cmd/
│   └── ent/
│       └── main.go
├── ent/
│   ├── client.go
│   ├── config.go
│   ├── ent.go
│   ├── generate.go
│   ├── schema/
│   │   ├── user.go
│   │   └── ...
│   └── ...
├── go.mod
├── go.sum
└── README.md

目录结构介绍

• cmd/: 包含项目的入口文件。
• ent/: 包含 ent 框架的核心代码和生成的代码。
  • client.go: 客户端配置文件。
  • config.go: 配置文件。
  • ent.go: 生成的 ent 代码。
  • generate.go: 代码生成配置文件。
  • schema/: 包含实体的定义文件。
• go.mod 和 go.sum: Go 模块文件。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

项目的启动文件位于 cmd/ent/main.go，主要负责初始化 ent 客户端并启动应用程序。

package main

import (
    "context"
    "log"

    "<your_project>/ent"
    "<your_project>/ent/migrate"

    _ "github.com/mattn/go-sqlite3"
)

func main() {
    client, err := ent.Open("sqlite3", "file:ent?mode=memory&cache=shared&_fk=1")
    if err != nil {
        log.Fatalf("failed opening connection to sqlite: %v", err)
    }
    defer client.Close()
    ctx := context.Background()
    // Run the auto migration tool.
    if err := client.Schema.Create(ctx, migrate.WithGlobalUniqueID(true)); err != nil {
        log.Fatalf("failed creating schema resources: %v", err)
    }
}

启动文件介绍

• ent.Open: 初始化 ent 客户端，连接到数据库。
• client.Schema.Create: 运行自动迁移工具，创建数据库模式。

3. 项目的配置文件介绍

项目的配置文件主要位于 ent/config.go，负责配置 ent 框架的各项参数。

package ent

import (
    "entgo.io/ent"
    "entgo.io/ent/dialect"
    "entgo.io/ent/dialect/sql"
)

// Config 配置 ent 客户端
type Config struct {
    Driver string
    Source string
}

// NewClient 创建一个新的 ent 客户端
func NewClient(cfg Config) (*Client, error) {
    driver, err := sql.Open(cfg.Driver, cfg.Source)
    if err != nil {
        return nil, err
    }
    return NewClient(ent.Driver(driver)), nil
}

配置文件介绍

• Config: 定义配置结构体，包含数据库驱动和数据源。
• NewClient: 根据配置创建 ent 客户端。

以上是 ent 项目的目录结构、启动文件和配置文件的介绍。希望这份教程能帮助你更好地理解和使用 ent 框架。