Ent框架GraphQL集成实战：构建Todo应用后端-优快云博客

Ent框架GraphQL集成实战：构建Todo应用后端

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

前言

在现代Web开发中，GraphQL因其灵活性和高效性已成为API设计的首选方案之一。Ent作为Go语言中强大的实体框架，提供了与GraphQL的无缝集成能力。本文将详细介绍如何使用Ent框架构建一个支持GraphQL的Todo应用后端。

环境准备

安装必要依赖

首先需要安装Ent的GraphQL扩展包：

go get entgo.io/contrib/entgql@master

同时安装GraphQL实现库：

go get github.com/99designs/gqlgen

配置Ent生成GraphQL Schema

1. 添加GraphQL注解

在Todo实体的schema文件中添加GraphQL相关注解，启用查询和创建变更功能：

func (Todo) Annotations() []schema.Annotation {
    return []schema.Annotation{
        entgql.QueryField(),
        entgql.Mutations(entgql.MutationCreate()),
    }
}

2. 配置Ent代码生成

创建ent/entc.go文件配置Ent代码生成器，添加GraphQL扩展：

func main() {
    ex, err := entgql.NewExtension(
        entgql.WithSchemaGenerator(),
        entgql.WithSchemaPath("ent.graphql"),
        entgql.WithConfigPath("gqlgen.yml"),
    )
    // ...错误处理
    opts := []entc.Option{entc.Extensions(ex)}
    entc.Generate("./ent/schema", &gen.Config{}, opts...)
}

3. 生成GraphQL Schema

执行代码生成命令：

go generate .

这将生成ent.graphql文件，包含基于Ent schema的GraphQL类型定义。

配置gqlgen

1. 创建gqlgen配置文件

gqlgen.yml文件配置GraphQL实现：

schema:
  - ent.graphql
  - todo.graphql
resolver:
  layout: follow-schema
  dir: .
autobind:
  - todo/ent
  - todo/ent/todo
models:
  ID:
    model:
      - github.com/99designs/gqlgen/graphql.IntID
  Node:
    model:
      - todo/ent.Noder

2. 更新生成脚本

更新generate.go包含gqlgen生成命令：

//go:generate go run -mod=mod ./ent/entc.go
//go:generate go run -mod=mod github.com/99designs/gqlgen

再次运行生成命令将创建GraphQL解析器实现。

实现GraphQL服务器

1. 创建主解析器

resolver.go中注入Ent客户端：

type Resolver struct{ client *ent.Client }

func NewSchema(client *ent.Client) graphql.ExecutableSchema {
    return NewExecutableSchema(Config{
        Resolvers: &Resolver{client},
    })
}

2. 实现服务器主程序

创建cmd/todo/main.go启动GraphQL服务器：

func main() {
    client, err := ent.Open(dialect.SQLite, "file:ent?mode=memory&cache=shared&_fk=1")
    // ...错误处理
    
    srv := handler.NewDefaultServer(todo.NewSchema(client))
    http.Handle("/", playground.Handler("Todo", "/query"))
    http.Handle("/query", srv)
    log.Println("listening on :8081")
    http.ListenAndServe(":8081", nil)
}

实现基础功能

查询Todos

实现查询解析器：

func (r *queryResolver) Todos(ctx context.Context) ([]*ent.Todo, error) {
    return r.client.Todo.Query().All(ctx)
}

创建Todo

扩展GraphQL schema：

type Mutation {
    createTodo(input: CreateTodoInput!): Todo
}

实现变更解析器：

func (r *mutationResolver) CreateTodo(ctx context.Context, input ent.CreateTodoInput) (*ent.Todo, error) {
    return r.client.Todo.Create().SetInput(input).Save(ctx)
}

测试应用

启动服务器后，可以通过GraphQL Playground进行测试：

mutation {
  createTodo(input: {text: "学习Ent GraphQL集成", status: IN_PROGRESS, priority: 1}) {
    id
    text
  }
}

query {
  todos {
    id
    text
    status
  }
}