GraphQL Code Generator 中如何处理嵌套关系解析的性能优化

在 GraphQL 开发中，GraphQL Code Generator 是一个强大的工具，它能自动生成 TypeScript 类型定义和解析器签名。然而，在使用过程中，开发者可能会遇到一个常见的性能问题：即使客户端没有请求某些嵌套关系字段，生成的解析器类型也会强制要求解析这些关系。

问题背景

假设我们有一个图书管理系统，其中每本书必须有一个作者。在 GraphQL Schema 中定义如下：

type Query {
  book(id: ID!): Book!
}

type Author {
  id: ID!
  name: String!
}

type Book {
  id: ID!
  name: String!
  authorId: ID!
  author: Author!
}

按照常规实现，我们可能希望只在查询请求中包含作者信息时才去解析作者数据。然而，GraphQL Code Generator 默认生成的解析器类型会强制要求我们在基础查询中就解析并返回所有嵌套关系，这显然会导致性能问题。

解决方案：使用 Mappers

GraphQL Code Generator 提供了 Mappers 功能来解决这个问题。Mappers 允许我们定义 GraphQL 类型与实际返回类型之间的映射关系，从而实现按需解析。

实现步骤

1. 定义映射类型： 首先创建一个表示基础图书数据的类型，不包含作者信息：

// src/mappers.ts
export type BookMapper = {
  id: string;
  name: string;
}

2. 配置 Codegen： 在 codegen 配置文件中指定映射关系：

// codegen.ts
import type { CodegenConfig } from '@graphql-codegen/cli';

const config: CodegenConfig = {
  schema: '**/schema.graphql',
  generates: {
    'src/types.generated.ts': {
      plugins: ['typescript', 'typescript-resolvers'],
      config: {
        mappers: {
          Book: './mappers#BookMapper'
        }
      }
    }
  }
}

export default config;

3. 实现解析器： 现在可以按需实现解析器了：

export const resolvers: Resolvers = {
  Query: {
    book: (_, { id }) => ({
      id,
      name: "Book",
    }),
  },
  Book: {
    author: async ({ authorId }) => await getAuthor(authorId),
  },
};

高级方案：使用 Server Preset

对于更复杂的项目，推荐使用 Server Preset 方案，它提供了更完整的类型安全和开发体验。

1. 配置 codegen：

// codegen.ts
import type { CodegenConfig } from '@graphql-codegen/cli';
import { defineConfig } from '@eddeee888/gcg-typescript-resolver-files';

const config: CodegenConfig = {
  schema: '**/schema.graphql',
  generates: {
    'src/schema': defineConfig(),
  }
}

export default config;

2. 定义 schema 和 mappers：

# src/schema/schema.graphql
type Query {
  book(id: ID!): Book!
}

// src/schema/schema.mappers.ts
export type BookMapper = {
  id: string;
  name: string;
}

性能考量

这种解决方案的主要优势在于：

1. 减少数据库查询：避免了不必要的 JOIN 操作
2. 按需加载：只有在客户端请求相关字段时才执行解析
3. 类型安全：保持了完整的 TypeScript 类型检查

最佳实践

1. 对于简单的项目，使用基础插件配合 mappers 即可
2. 对于中大型项目，推荐使用 Server Preset 以获得更好的开发体验
3. 在设计 GraphQL Schema 时，考虑将必填但可能昂贵的字段设计为可选的
4. 对于复杂的数据加载场景，可以考虑使用 DataLoader 来批处理和缓存请求

通过合理使用 GraphQL Code Generator 的映射功能，我们可以有效解决嵌套关系解析带来的性能问题，同时保持代码的类型安全和良好的开发体验。