在GraphQL中,如何实现可选查询?

时间:2018-02-13 17:58:50

标签: graphql graphql-js

编辑:因为它似乎并不清楚,我特别询问我应该在解析函数内为后端查询提出数据库请求。

我正在实现GraphQL查询,而我无法准确理解在给定查询中应该调用多少次调用。例如,这是一个用户和俱乐部的数据结构,用户可以加入:

User {
  UserID
  Clubs
  OtherStuff
}

Club{
  ClubID
  ClubName
}

我可以对我的数据库进行以下调用:

  • 获取所有用户ID
  • 获取UserID
  • 的信息
  • 为用户获取所有ClubID
  • 获取ClubID
  • 的信息

我不明白的是,每次查询用户时我是否应该拨打所有这些电话。如果有人只查询UserID,那么检索其他所有内容似乎是一个巨大的浪费。如果用户俱乐部是一个完全独立的GraphQL查询,俱乐部是否应仅返回ClubID,或者是否有办法有效地允许俱乐部领域提供完整的俱乐部信息?

编辑2: 好的,这是我的代码。我评论过那些我不知道该怎么做的部分。

const QueryType = new GraphQLObjectType({
  name: 'Query',
  fields: {
    User: userQueryField,
    Club: clubQueryField
  }
});

const clubQueryField = {
  type: new GraphQLList(ClubType),
  args: {
    UserID: {
      description: 'Returns all clubs the user is a part of',
      type: GraphQLID
    }
  },
  resolve(root, {UserID}) {
    //.....
  }
};


const userQueryField = {
  type: new GraphQLList(UserType),
  args: {
    UserID: {
      description: 'If omitted, returns a list of all users. \
      Otherwise, returns the user with the provided ID',
      type: GraphQLID
    }
  },
  resolve(root, {UserID}) {
    if(UserID){
      return new Promise((resolve, reject) => {
        getUserInfo(UserID, function(response){

          //HERE: I have tried different things, like clubQueryField(UserID) and clubQueryField.resolve, but with no luck
          UserID.Clubs = clubQueryField
          resolve([response]);
        });
      });
    }
  }
};

编辑3:用户类型定义。

const UserType = new GraphQLObjectType({
  name: 'User',
  fields: () => ({
    UserID: {
      type: GraphQLID
    },
    Clubs: {
      type: new GraphQLList(ClubType)
    }
  })
});

2 个答案:

答案 0 :(得分:1)

GraphQL具有延迟加载功能,可以处理查询中的其他字段。如果用户编写以下查询:

users { resolve: body => get_user_id}

它获取用户ID,并且显然不会查找其他字段。这绝对取决于你的解析器。如果你像这样编写解析器:sudo apt-get install postgresql-contrib,它会从数据库中获取用户ID。 希望这有帮助!

答案 1 :(得分:1)

GraphQL API按类型和字段组织,我建议为用户类型和俱乐部类型创建单独的查询,如果有人仅查询userIds,他们将使用用户查询。

查询用户:

query {
  users {
   id
  }
}

查询俱乐部:

query {
  club {
   clubID
   clubName
   userId
  }
}

如果有人试图查询用户/俱乐部,您可以将俱乐部类型添加到用户类型,如下所示:

query {
  users {
   id
   club {
    clubID
    clubName
   }
  }
}

在你的用户类型中会有一个名为club的字段,它将成为类型俱乐部,在解析器中它将以obj.userId作为参数调用俱乐部查询,GraphQL的优点在于你让它客户决定要获取哪些字段。

您可以看到嵌套查询here

的示例

编辑:那么在您的情况下,您可以修改您的userType以包含用户所属的俱乐部,您在clubQueryField中不需要该条件,条件将在客户端进行的查询中,因此假设您的用户类型是:

的用户类型:

export default new GraphQLObjectType({
  name: 'UserType',
  fields: {
    userId: {
      description: 'user id',
      type: GraphQLString
    },
    email: {
      description: 'user email',
      type: GraphQLString
    },
    clubs: {
      description: 'User clubs',
      type: new GraphQLList(ClubType),
      resolve: (obj, args, _) => {
        return getUserClubs(obj.userId);
      }
    },
  }
});

然后,如果您的客户只需要用户,则会请求以下内容:

  query {
    User {
     userId
     email
     }
  }

如果客户需要用户和俱乐部,它会请求这样的内容:

query {
    User {
     userId
     email
     clubs {
        field1
        field2
       }
     }
  }