枚举GraphQL查询中的所有字段

时间:2018-03-09 00:10:52

标签: graphql apollo graphql-js apollo-server graphql-tools

给定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参数中。当您添加unionsinline fragments时,它会变得更加毛茸茸。

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

可以在on the Apollo docs sitegraphql-js Github repo中找到有关info参数的信息。

1 个答案:

答案 0 :(得分:1)

我知道已经有一段时间了,但是万一有人落到这里,graphql-list-fields有一个名为Jake Pusareti的npm软件包可以做到这一点。它处理片段,并跳过和包含指令。 您还可以检查代码here