如何使用 GraphQL 实现分页和排序

GraphQL 是一种用于 API 的查询语言。它不仅可以使用一个请求获取所需的数据,还可以减少服务器返回的不必要数据。在实际开发中,我们通常需要对数据进行分页和排序。GraphQL 同样支持这些操作,本文介绍如何使用 GraphQL 实现分页和排序。

分页

分页是指将大批量数据拆分为小块,使得浏览器可以逐步加载数据,降低服务器压力和响应时间。GraphQL 支持两种分页方式:基于游标的分页和基于页数的分页。

基于游标的分页

基于游标的分页通过将查询结果分割成较小的“页面”来提高网页加载速度。游标是指在结果集中指向特定分页的标识符。

在 GraphQL 中,我们可以通过 edgesnodes 构建基于游标的分页。nodes 表示每个结果的基本对象,edges 表示连接每个节点的关系。每个 edges 对象必须包含一个 cursor 参数,指定其在结果集中的位置。以下是一个查询示例:

-
  ------------- ---------- ----- ----------- ------ --- -
    ---------------
    ----- -
      ------
      ---- -
        --- -- ---------- -
          ----
          ---------
        -
      -
    -
  -
-

上面的查询将搜索包含“GraphQL”的前 10 个仓库。响应将包含一个 search 对象,其中包含 repositoryCount 和一个 edges 对象数组。每个 edges 对象都将包含 cursornode 对象,后者是仓库的实际数据,其中包含其名称和分叉计数。

基于页数的分页

基于页数的分页是指按照一定规定的页数将查询结果拆分,并返回指定的页面。在 GraphQL 中,我们可以使用 limitoffset 命令来执行基于页数的分页。例如,以下查询将返回第 20 至第 30 个仓库:

-
  ------------- ---------- ----- ----------- ------ --- ------ --------------------------- -
    ---------------
    ----- -
      --- -- ---------- -
        ----
        ---------
      -
    -
  -
-

上面的查询以类似于基于游标的分页的方式工作,除了在这种情况下,我们使用 after 参数来表示页面的起始位置。

排序

排序是指按照指定的字段进行数据排序。GraphQL 支持两种类型的排序:单字段排序和多字段排序。

单字段排序

单字段排序是指按照一个字段进行排序。例如,以下查询将返回 fork 数最多的仓库:

-
  ------------- ---------- ----- ----------- ------ --- ------ ----- -------- ------- -------- ---------- ------ -
    ----- -
      --- -- ---------- -
        ----
        ---------
        --------------
      -
    -
  -
-

上面的查询将使用 orderBy 命令对结果进行排序。该命令接受一个包含 fielddirection 两个参数的对象,分别表示排序字段和排序方向。在上面的查询中,我们将 field 设置为“FORKS”,表示按照 fork 数进行排序,将 direction 设置为“DESC”,表示倒序排列。

多字段排序

多字段排序是指按照多个字段进行排序。例如,以下查询将返回 fork 数最多的仓库,并按照 star 数进行排序:

-
  ------------- ---------- ----- ----------- ------ --- ------ ----- -------- ------- -------- ---------- ------ ------------------ ------- ------------- ---------- ------ -
    ----- -
      --- -- ---------- -
        ----
        ---------
        --------------
      -
    -
  -
-

上面的查询与单字段排序相似,只是我们引入了 secondaryOrdering 命令,它允许我们根据另一个字段进行排序。

示例代码

以下是使用 GraphQL 执行分页和排序的示例代码:

----- ----- - -
  ----- -------------- -------- ------- ----- ------- ------- --------- ----------- ------------------- ----------- -
    ------------- ------------- ----- ----------- ------ ------- ------ ------- -------- --------- ------------------ ------------------- -
      ----- -
        ------
        ---- -
          --- -- ---------- -
            ----
            ---------
            --------------
          -
        -
      -
    -
  -
-

----- --------- - -
  ------------ ----------
  ------ ---
  ------ -----
  -------- - ------ -------- ---------- ------ --
  ------------------ - ------ ------------- ---------- ------ --
-

--------------------------------------- -
  ------- -------
  -------- -
    --------------- -------------------
    ---------------- ------- ----------
  --
  ----- ---------------- ------ --------- ---
---------------- -- ----------------
  ---------- -- -
    -----------------
  --
  ------------ -- -
    --------------------
  --

上述示例将查询名为“GraphQL”的前十个仓库,按 fork 数进行排序,然后按 star 数进行排序。如果需要,可以将变量传递到查询中以更改查询参数。

结论

在本文中,我们介绍了 GraphQL 中的分页和排序。我们学习了基于游标的分页、基于页数的分页、单字段排序和多字段排序,并提供了示例代码。使用这些技术,我们可以在 GraphQL 中轻松地执行分页和排序操作,优化我们的 API 开发。

来源:JavaScript中文网 ,转载请注明来源 本文地址:https://www.javascriptcn.com/post/6703927bd91dce0dc84bb5a7