gqlgen快速入门指南

gqlgen是一款基于Go语言的GraphQL服务器库，它倡导“模式优先”的开发方式，通过代码生成简化API的构建过程，确保类型安全且高效。本指南旨在帮助您了解并快速上手gqlgen，涵盖其基本的目录结构、启动文件以及配置文件的使用。

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

当您使用gqlgen init命令初始化一个新项目时，它将自动生成一套推荐的目录布局，如下所示：

my-project/
├── go.mod           <- Go 模块配置文件
├── go.sum           <- 记录依赖版本的文件
├── gqlgen.yml       <- gqlgen的配置文件，用于控制代码生成
├── graph             <- 包含所有与图谱相关的内容
│   ├── generated     <- 自动生成的运行时代码
│   │   └── generated.go
│   ├── model         <- 图模型包，包括自动生成和其他手动创建的模型
│   │   └── models_gen.go
│   ├── resolver.go   <- 根图解析器类型定义，是处理查询和变异的主要入口点
│   ├── schema.graphqls <- 主GraphQL模式文件（模式可以分散在多个文件中）
│   └── schema.resolvers.go <- 实现GraphQL模式中定义的解析逻辑
└── server.go        <- 应用程序的主入口文件，负责启动HTTP服务

• go.mod: 记录了项目依赖和模块信息。
• gqlgen.yml: 配置gqlgen如何生成代码，如模型路径、自定义类型等。
• graph目录: 存储图模型定义、模式定义与解析逻辑。
• server.go: 启动服务器的核心文件，通常包含main函数。

2. 项目的启动文件介绍

server.go

这个文件是应用程序启动的关键，包含您的主函数（main()）。在这个文件中，您会导入生成的代码和自定义的解析逻辑，然后初始化HTTP服务器来监听GraphQL请求。一个基础的server.go示例可能会这样做：

package main

import (
    "github.com/99designs/gqlgen/handler"
    "net/http"
)

func main() {
    http.Handle("/", handler.GraphQL(graph.New()))
    http.ListenAndServe(":8080", nil)
}

这里假设graph.New()返回了一个配置好的GraphQL执行器实例，该实例根据您的模式和解析器进行初始化。

3. 项目的配置文件介绍

gqlgen.yml

此配置文件指导gqlgen生成代码的过程。以下是一些关键字段的简要说明：

• schema: 指定GraphQL模式文件的位置。
• models: 定义自定义模型和它们在GraphQL中的映射。
• exec: 控制生成的执行器代码的细节。
• resolver: 指明解析器的实现所在位置。
• generator: 允许对代码生成行为进行更细致的控制，比如命名策略或额外的代码片段。

例如：

schema:
  - schema.graphqls

models:
  User:
    model: github.com/yournamespace/models.User

exec:
  filename: graph/generated/generated.go

resolver:
  filename: graph/resolver.go
  package: resolver

通过以上内容，您可以快速理解gqlgen项目的骨架，并根据这些指导开始构建自己的GraphQL服务。记得调整路径和包名以匹配您的具体项目设置。