Egg.js中使用GraphQL实战指南

Egg.js中使用GraphQL实战指南

egg-graphql 项目地址: https://gitcode.com/gh_mirrors/eg/egg-graphql

一、项目目录结构及介绍

Egg.js的egg-graphql插件旨在简化在Egg框架中集成GraphQL的服务。下面是典型的项目结构示例，当你在Egg项目中安装并使用此插件后可能遇到的布局：

.
├── app
│   ├── graphql            # GraphQL相关的逻辑存放处
│   │   ├── common          # 共享的指令或辅助函数
│   │   │   └── directive.js # 自定义指令
│   │   ├── project         # 特定于项目的GraphQL逻辑，如模式(schema), 连接(connector), 解析器(resolver)
│   │   │   └── schema.graphql
│   │   ├── schemaDirectives # 自定义Schema Directive实现
│   │   │   └── schemaDirective.js
│   │   ├── user            # 示例模型相关的GraphQL逻辑
│   │   │   ├── connector.js
│   │   │   ├── resolver.js
│   │   │   └── schema.graphql
│   ├── model               # 数据模型
│   │   └── user.js
│   ├── middleware          # 中间件，包括graphql中间件
│   └── router.js           # 路由配置
├── config
│   ├── plugin.js           # 插件启用配置
│   └── config.default.js   # 默认环境配置，包括GraphQL路由等
└── package.json            # 项目依赖管理文件

二、项目的启动文件介绍

Egg.js项目的核心启动逻辑并不直接体现在单一的“启动文件”上，而是通过一系列的配置文件和启动脚本协作完成。然而，在config/plugin.js文件中启用egg-graphql是开始的关键步骤：

// {project_root}/config/plugin.js
exports.graphql = {
  enable: true,
  package: 'egg-graphql',
};

通过这段配置，Egg将加载egg-graphql插件。

三、项目的配置文件介绍

配置文件位于config目录下，特别是config.default.js或针对不同环境的配置文件。对于egg-graphql插件，主要配置在同目录内，一般扩展至特定环境配置中：

// {project_root}/config/config.default.js
module.exports = {
  graphql: {
    router: '/graphql',      // GraphQL API的访问路径
    app: true,              // 是否挂载到app上
    agent: false,           // 是否挂载到agent上
    graphiql: true,         // 是否开启图灵机界面，方便调试
    defaultEmptySchema: false, // 是否设置默认的Query和Mutation
    // 更多高级配置，如中间件、Apollo Server选项等
  },
};

这些配置允许你控制GraphQL服务的行为，比如是否在生产环境中启用图形界面(graphiql)进行调试，以及如何设置GraphQL路由。

至此，通过理解上述关键部分，你可以顺利地在Egg.js项目中集成和配置egg-graphql插件，进而利用GraphQL的强大功能进行API的设计与开发。

egg-graphql 项目地址: https://gitcode.com/gh_mirrors/eg/egg-graphql