TypeGraphQL 实战：枚举与联合类型在 GraphQL 查询中的应用-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00101/article/details/148441606

TypeGraphQL 实战：枚举与联合类型在 GraphQL 查询中的应用

type-graphql 项目地址: https://gitcode.com/gh_mirrors/typ/type-graphql

TypeGraphQL 是一个强大的库，它允许开发者使用 TypeScript 类和装饰器来构建 GraphQL API。本文将深入探讨 TypeGraphQL 中枚举类型和联合类型的实际应用场景，通过分析一个食谱查询系统的示例代码，帮助开发者理解如何在实际项目中运用这些高级特性。

基础查询与枚举过滤

在第一个示例中，我们看到了一个基本的 GraphQL 查询结构：

query AllRecipes {
  recipes {
    title
    description
    preparationDifficulty
    cook {
      name
    }
  }
}

这个查询获取了所有食谱的基本信息，包括标题、描述、准备难度和厨师姓名。值得注意的是preparationDifficulty字段，它很可能是一个枚举类型，表示食谱的准备难度级别。

TypeGraphQL 中定义这样的枚举类型非常简单：

enum PreparationDifficulty {
  Easy = "Easy",
  Medium = "Medium",
  Hard = "Hard"
}

通过使用装饰器@Field(() => PreparationDifficulty)，我们可以将这个枚举类型暴露给 GraphQL 模式。

带参数的枚举过滤查询

第二个查询展示了如何使用枚举值作为参数来过滤结果：

query EasyRecipes {
  recipes(difficulty: Easy) {
    title
    description
    ingredients
    cook {
      name
    }
  }
}

这里，difficulty: Easy参数限制了只返回准备难度为"Easy"的食谱。这种过滤方式在实际应用中非常有用，比如在电商系统中按商品类别筛选，或在内容管理系统中按内容状态查询。

在 TypeGraphQL 解析器中，我们可以这样实现这个过滤逻辑：

@Resolver()
class RecipeResolver {
  @Query(() => [Recipe])
  async recipes(@Arg("difficulty", () => PreparationDifficulty, { nullable: true }) 
    difficulty?: PreparationDifficulty
  ) {
    // 根据difficulty参数过滤食谱
  }
}

联合类型与接口查询

第三个查询展示了更高级的联合类型(Union)和接口(Interface)的使用：

query SearchByCookName {
  search(cookName: "Gordon") {
    __typename
    ... on Recipe {
      title
      preparationDifficulty
      cook {
        name
      }
    }
    ... on Cook {
      name
      yearsOfExperience
    }
  }
}

这个查询有几个值得注意的技术点：

search字段返回的是一个联合类型，可能是Recipe或Cook
使用__typename可以获取返回对象的实际类型
使用片段(... on TypeName)可以根据不同类型选择不同的字段

在 TypeGraphQL 中定义这样的联合类型需要：

@ObjectType()
class Cook {
  @Field()
  name: string;
  
  @Field()
  yearsOfExperience: number;
}

@Resolver()
class SearchResolver {
  @Query(() => [SearchResult])
  async search(@Arg("cookName") cookName: string) {
    // 返回可能是Recipe或Cook的数组
  }
}

const SearchResult = createUnionType({
  name: "SearchResult",
  types: () => [Recipe, Cook] as const,
});