GraphQL-Request 项目中的 Raw Client 优化思路与实践

GraphQL-Request 作为一款轻量级 GraphQL 客户端，其 Raw Client 功能一直备受开发者关注。近期社区针对该功能的改进提出了富有创见的方案，本文将深入剖析这些优化思路及其技术实现。

当前 Raw Client 的痛点分析

现有 Raw Client 存在几个明显问题：首先，字符串和 DocumentNode 两种 API 分离增加了学习成本；其次，用户需要自行选择字符串或文档节点形式，而框架本可智能决策；最重要的是，现有类型推断机制复杂且难以维护。

创新性解决方案

模板字面量统一 API

改进方案引入了一种基于模板字面量的链式调用方式：

const data = await graffle
  .gql`
    query pokemonByName($Name: String!) {
      pokemonByName(name: $Name) {
        name
        continent { name }
      }
    }
  `
  .run({ name: 'Pikachu' })

这种设计将变量和操作名称从文档参数中分离，既保持了代码简洁性，又为IDE工具支持提供了便利。

类型系统增强

通过泛型参数支持预定义类型：

type QueryPokemonByName = TypedQueryDocumentNode<
  { pokemonByName: { id: string; name: string } },
  { name: string }
>

const data = await graffle
  .gql<QueryPokemonByName>`...`
  .run({ name: 'Pikachu' })

这种类型推断方式显著改善了开发体验，使变量和返回类型都能得到严格检查。

文档节点复用机制

方案保留了传统 DocumentNode 的使用方式，确保向后兼容：

const document = gql`...`
const data = await graffle
  .gql(document)
  .run({ name: 'Pikachu' })

同时提供了获取构建文档的能力，满足高级场景需求。

语法糖优化

特别值得一提的是针对根类型的语法糖设计：

const data = await graffle.query.gql`
  pokemonByName(name: ${'Pikachu'}) {
    name
    continent { name }
  }
`

这种内联变量插值的方式极大简化了简单查询的编写，虽然会牺牲部分IDE支持，但在快速开发场景中价值显著。

技术价值分析

该方案最核心的突破在于：通过模板字面量的创新应用，统一了字符串和文档节点两种API形态；利用方法链式调用优化了类型推断；同时保持了对TypedDocumentNode等社区方案的良好兼容。这些改进使得Raw Client既保持了灵活性，又显著提升了开发体验。

对于性能敏感场景，框架可以智能决定是否解析字符串为文档节点，这种自动化优化进一步降低了使用门槛。整体来看，这是一次对GraphQL客户端API设计的创新探索，值得广大开发者关注和实践。