TypeGraphQL 解析器(Resolvers)深度解析-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00646/article/details/148441439

TypeGraphQL 解析器(Resolvers)深度解析

type-graphql Create GraphQL schema and resolvers with TypeScript, using classes and decorators! 项目地址: https://gitcode.com/gh_mirrors/ty/type-graphql

TypeGraphQL 是一个强大的 TypeScript GraphQL 框架，它允许开发者使用装饰器和类来定义 GraphQL 模式。本文将深入探讨 TypeGraphQL 中的解析器(Resolvers)概念，包括查询(Queries)、变更(Mutations)和字段解析器(Field Resolvers)的实现方式。

解析器基础概念

在 GraphQL 中，解析器是负责获取和返回数据的函数。TypeGraphQL 通过类和方法装饰器的方式，让解析器的定义变得直观且类型安全。

解析器类

解析器类是 TypeGraphQL 中组织 GraphQL 操作的核心单元，使用 @Resolver() 装饰器标记：

@Resolver()
class RecipeResolver {
  private recipesCollection: Recipe[] = [];
  
  // 这里将定义查询、变更和字段解析器
}

这种设计模式类似于传统 REST 框架中的控制器(Controller)，使得代码组织更加清晰。

查询(Queries)与变更(Mutations)

基本查询实现

定义一个查询需要：

使用 @Query 装饰器标记方法
明确指定返回类型

@Resolver()
class RecipeResolver {
  @Query(returns => [Recipe])
  async recipes() {
    return await this.recipesCollection;
  }
}

处理参数

TypeGraphQL 提供了两种处理参数的方式：

1. 内联参数(`@Arg`)

适用于参数较少的情况：

@Query(returns => [Recipe])
async recipes(
  @Arg("servings", { defaultValue: 2 }) servings: number,
  @Arg("title", { nullable: true }) title?: string,
): Promise<Recipe[]> {
  // 实现逻辑
}

2. 参数类(`@ArgsType`)

当参数较多时，推荐使用参数类：

@ArgsType()
class GetRecipesArgs {
  @Field(type => Int, { defaultValue: 0 })
  skip: number = 0;

  @Field(type => Int)
  @Min(1)
  @Max(50)
  take: number = 25;

  @Field({ nullable: true })
  title?: string;
}

@Resolver()
class RecipeResolver {
  @Query(returns => [Recipe])
  async recipes(@Args() { skip, take, title }: GetRecipesArgs) {
    // 实现分页和过滤逻辑
  }
}

这种方式不仅使代码更整洁，还支持参数验证。

变更(Mutations)实现

变更通常使用输入类型(Input Types)来接收复杂数据：

@InputType()
class AddRecipeInput implements Partial<Recipe> {
  @Field()
  title: string;

  @Field({ nullable: true })
  description?: string;
}

@Resolver()
class RecipeResolver {
  @Mutation()
  addRecipe(
    @Arg("data") newRecipeData: AddRecipeInput,
    @Ctx() ctx: Context
  ): Recipe {
    // 实现添加逻辑
  }
}

字段解析器(Field Resolvers)

字段解析器用于解决对象类型中的特定字段，特别是那些需要额外计算或数据库查询的字段。

基本字段解析器

@Resolver(of => Recipe)
class RecipeResolver implements ResolverInterface<Recipe> {
  @FieldResolver()
  averageRating(@Root() recipe: Recipe) {
    const sum = recipe.ratings.reduce((a, b) => a + b, 0);
    return recipe.ratings.length ? sum / recipe.ratings.length : null;
  }
}

复杂字段解析器

对于需要依赖注入或数据库访问的字段：

@Resolver(of => Recipe)
class RecipeResolver {
  constructor(
    private readonly userRepository: Repository<User>,
  ) {}

  @FieldResolver()
  async author(@Root() recipe: Recipe) {
    return await this.userRepository.findById(recipe.userId);
  }
}

内联字段解析器

对于简单的计算字段，可以直接在对象类型类中定义：

@ObjectType()
class Recipe {
  @Field(type => Float, { nullable: true })
  get averageRating(): number | null {
    if (!this.ratings.length) return null;
    return this.ratings.reduce((a, b) => a + b, 0) / this.ratings.length;
  }
}