首页 > 解决方案 > GraphQL:传递执行的根值规范是什么?

问题描述

我使用 express-graphql 初始化,rootValue并将其传递给 GraphQL 的执行函数。我想知道什么是rootValue规范。我看过一些简单的例子,但我对完整的规范感兴趣。

标签: graphql

解决方案


rootValue是特定于 javascript 实现的,据我所知,不是官方规范明确要求的。

这是文档resolve中提供的函数(或解析器)的类型定义:

type GraphQLFieldResolveFn = (
  source?: any,
  args?: {[argName: string]: any},
  context?: any,
  info?: GraphQLResolveInfo
) => any

传递给解析器的第一个参数是“源”、“根”或“父”值。一个字段总是与一些对象类型相关联。“源”值只是返回该对象类型的字段解析为的值。例如,给定如下查询:

{
  user(id: 1) {
    location {
      city
    }
  }
}

user字段返回一个对象类型。当它解析时,解析的值location作为“源”传递给解析器。类似地,当location解析时,解析的值将传递给解析器的所有请求字段,例如city.

在我们的示例中,useris 字段和其他字段一样,只是恰好在Query类型上,但该类型本身仍然是 Object 类型。因为它是一个字段,所以它是通过调用与其关联的解析器来解析的。但是因为它位于查询的根目录,所以没有“源”值。这是rootValue您传递给的唯一目的execute——它作为“源”值传递给每个根级解析器。

换句话说,您设置的任何内容rootValue都将作为第一个参数传递给Query,MutationSubscription类型的每个字段的解析器。

由于rootValue它仅适用于根级解析器,因此它的使用非常有限。应该将所有解析器可用的任何数据都包含在上下文中。

为了完整起见,我应该注意到那里有一些示例展示了如何使用 SDL 和buildSchema. 因为buildSchema不提供为任何字段提供解析器的方法,所以这些示例提供了一种方法来解析根级字段,方法是通过rootValue. 这是有效的,因为正如文档所指出的:

[如果] 未提供解析器函数,则使用默认解析器,它在与字段同名的源上查找方法。如果找到,则使用 (args, context, info) 调用该方法。

但是,同样,rootValue它仅适用于根类型(查询、变异和订阅)上的字段。如果您以这种方式创建模式,您将无法为任何其他类型的字段定义解析器。换句话说,不要这样做。有关更多详细信息,请参阅此答案


推荐阅读