Ent 数据库框架使用

Ent 是 Facebook 开源的一个简单易用的 Database 实体框架。

它使构建和维护具有大型数据模型的应用程序变得容易，并坚持以下原则:

  • 轻松地将数据库模式建模为图形结构。
  • 将模式定义为可编程的Go代码。
  • 基于代码生成的静态类型。
  • 数据库查询和图遍历很容易编写。
  • 简单地扩展和使用Go模板自定义。

安装工具

  1. go install entgo.io/ent/cmd/ent

创建实体 Schema

  1. ent init User

将会在 project/ent/schema/ 目录下为用户生成模式:

  1. // <project>/ent/schema/user.go
  3. package schema
  5. import "entgo.io/ent"
  7. // User holds the schema definition for the User entity.
  8. type User struct {
  9.     ent.Schema
  10. }
  12. // Fields of the User.
  13. func (User) Fields() []ent.Field {
  14.     return nil
  15. }
  17. // Edges of the User.
  18. func (User) Edges() []ent.Edge {
  19.     return nil
  20. }

为 User 添加 name、age 两个数据库字段:

  1. package schema
  3. import (
  4.     "entgo.io/ent"
  5.     "entgo.io/ent/schema/field"
  6. )
  8. // Fields of the User.
  9. func (User) Fields() []ent.Field {
  10.     return []ent.Field{
  11.         field.Int("age").
  12.             Positive(),
  13.         field.String("name").
  14.             Default("unknown"),
  15.     }
  16. }

从项目的ent目录运行go generate，如下所示:

  1. go generate ./ent

创建数据库连接客户端

首先，创建一个新的ent.Client。对于本例，我们将使用SQLite3。

  1. package main
  3. import (
  4.     "context"
  5.     "log"
  7.     "<project>/ent"
  9.     _ "github.com/mattn/go-sqlite3"
  10. )
  12. func main() {
  13.     client, err := ent.Open("sqlite3", "file:ent?mode=memory&cache=shared&_fk=1")
  14.     if err != nil {
  15.         log.Fatalf("failed opening connection to sqlite: %v", err)
  16.     }
  17.     defer client.Close()
  18.     // Run the auto migration tool.
  19.     if err := client.Schema.Create(context.Background()); err != nil {
  20.         log.Fatalf("failed creating schema resources: %v", err)
  21.     }
  22. }

然后进行创建一个 User 将会写入到数据库中：

  1. func CreateUser(ctx context.Context, client *ent.Client) (*ent.User, error) {
  2.     u, err := client.User.
  3.         Create().
  4.         SetAge(30).
  5.         SetName("a8m").
  6.         Save(ctx)
  7.     if err != nil {
  8.         return nil, fmt.Errorf("failed creating user: %v", err)
  9.     }
  10.     log.Println("user was created: ", u)
  11.     return u, nil
  12. }

References