枚举 GraphQL 查询中的所有字段



给定 Apollo Server 的 GraphQL 模式和解析器,以及 GraphQL 查询,有没有办法在解析器函数中创建所有请求字段(在对象或地图中)的集合?

对于简单查询,很容易从解析程序的info参数重新创建此集合。

给定一个模式:

type User {
id: Int!
username: String!
roles: [Role!]!
}
type Role {
id: Int!
name: String!
description: String
}
schema {
query: Query
}
type Query {
getUser(id: Int!): User!
}

和解析器:

Query: {
getUser: (root, args, context, info) => {
console.log(infoParser(info))
return db.Users.findOne({ id: args.id })
}
}

使用一个简单的递归infoParser函数,如下所示:

function infoParser (info) {
const fields = {}
info.fieldNodes.forEach(node => {
parseSelectionSet(node.selectionSet.selections, fields)
})
return fields
}
function parseSelectionSet (selections, fields) {
selections.forEach(selection => {
const name = selection.name.value
fields[name] = selection.selectionSet
? parseSelectionSet(selection.selectionSet.selections, {})
: true
})
return fields
}

此日志中出现以下查询结果:

{
getUser(id: 1) {
id
username
roles {
name
}
}
}
=> { id: true, username: true, roles: { name: true } }

事情很快就会变得非常丑陋,例如,当您在查询中使用片段时:

fragment UserInfo on User {
id
username
roles {
name
}
}
{
getUser(id: 1) {
...UserInfo
username
roles {
description
}
}
}

GraphQL 引擎在执行时正确忽略重复、(深度)合并等查询字段,但它没有反映在info参数中。当您添加联合和内联片段时,它只会变得更毛。

有没有办法构建查询中请求的所有字段的集合,同时考虑到 GraphQL 的高级查询功能?

有关info参数的信息可以在 Apollo 文档站点和 graphql-js Github 存储库中找到。

我知道已经有一段时间了,但万一有人最终来到这里,有一个由 Jake Pusareti 编写的名为 graphql-list-fields 的 npm 包可以做到这一点。它处理片段并跳过和包含指令。 您也可以在此处查看代码。

最新更新