如何使用 GraphQL 和 RxJS 进行搜索

阅读时长 10 分钟读完

GraphQL 已经成为了一个流行的前端 API 查询语言。与传统的 RESTful API 不同,GraphQL 允许前端应用程序精确地获取所需的数据,从而提高了性能和效率。在搜索功能方面,GraphQL 能够在不影响性能的情况下执行复杂的查询,这为实现高级搜索功能提供了更大的灵活性。与此同时,RxJS 是一个强大的响应式编程库,可以使我们更高效地处理异步数据流。这篇文章将介绍如何将这两个技术结合使用,实现高级搜索功能。

GraphQL 内置搜索

GraphQL 内置了一些搜索功能,这些功能可以协助我们快速地过滤和排序数据。我们举个例子,假设我们有一个博客应用,其中包含许多文章,每篇文章都有一个标题和标签列表。下面是一个简单的 GraphQL 查询:

如果我们想要找到所有包含 "React" 标签的文章,我们只需要在查询中添加一个 filter 参数:

现在只返回具有 "React" 标签的文章的信息。还可以添加排序和分页功能:

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

上面的查询将返回最近创建的 10 篇具有 "React" 标签的文章。

然而,有时查询变得更加复杂。比如说,我们想要找到所有包含 "React" 或 "Vue" 标签的文章,并且它们的标题中包含 "JavaScript"。遵循自顶向下的原则,我们应该首先在 GraphQL schema 中定义 filter 参数:

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

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

在上面的 schema 中,我们定义了一个 ArticleFilter 输入类型,它支持 OR 和 AND 运算符,以及 title_contains 和 tags_contains 字段。现在我们可以发起一个复杂的查询:

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

尽管 GraphQL 还支持计算字段,联合类型等高级功能,但是在进行复杂搜索时,我们最需要的是一种方法来动态地构建查询。这就是 RxJS 的作用。

RxJS 中的搜索

RxJS 是一个强大的响应式编程库,它提供了许多工具和操作符,用于操作异步数据流。在搜索方面,我们可以使用 RxJS 中的变换操作符,例如 filter、map 和 mergeMap,它们可以大大简化查询过程,同时也可以保持代码的可读性。

接下来我们将介绍一个教程,演示如何使用 RxJS 和 GraphQL 进行搜索。在这个例子中,我们将创建一个在客户端上运行的 Github 用户搜索应用程序。该应用程序将使用 Github GraphQL API,从中加载用户数据,然后将用户数据显示出来。

准备工作

在开始之前,我们需要设置一个 Github 访问令牌,以便我们可以使用 Github GraphQL API。Github 访问令牌可以从 Github 设置页面中进行创建。创建后,我们将在应用程序中使用它来进行身份验证。在创建了一个 Github 访问令牌后,我们还需要创建一个新的 npm 包管理器项目。

在项目文件夹中打开终端,输入以下命令:

创建 GraphQL 客户端

现在,我们需要创建一个 GraphQL 客户端,该客户端将与 Github GraphQL API 进行通信。我们将使用 Apollo Client,它是一个流行的 GraphQL 客户端,具有各种可配置的选项和很好的文档。

在项目文件夹中创建一个文件,名为 client.js,并写下以下代码:

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

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

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

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

上面的代码将创建一个新的 Apollo Client 实例,该实例将指向 Github GraphQL API 的 URI,并使用我们的 Github 访问令牌进行身份验证和授权。

创建搜索器

现在我们需要创建一个搜索器组件,该组件将接收用户输入并执行 GraphQL 查询。我们将使用 RxJS 构建一个动态的查询,该查询将通过防抖操作优化性能,并将搜索结果流式传递给 UI 。

在项目文件夹中创建一个文件,名为 searcher.js,并写下以下代码:

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

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

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

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

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

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

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

上面的代码将创建一个名为 createSearcher 的函数,该函数将返回一个 search 对象。该 search 对象具有两个主要方法,search 和 subscribe。search 方法接收用户输入,并将查询字符串传递给 RxJS 查询流。subscribe 方法允许我们在查询结果上订阅所需的回调,例如渲染 UI。

创建 UI 组件

最后,我们需要创建一个用于显示搜索结果的 UI 组件。这可以是 React 组件,也可以是纯 HTML,这里我们演示一个使用 HTML 和 DOM API 实现的简单组件。

在项目文件夹中创建一个名为 index.html 的文件,并写下以下代码:

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

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

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

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

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

上面的代码将创建一个简单的查询 UI。当用户输入至少三个字符时,将使用 RxJS 查询流发起Github 用户数据的搜索,并将结果动态渲染到搜索结果列表中。

运行应用程序

运行以下命令启动应用程序:

该命令将在本地的 5000 端口上启动该应用程序。使用浏览器打开 http://localhost:5000/ 即可开始搜索 Github 用户。

结论

在本文中,我们介绍了如何使用 GraphQL 和 RxJS 进行搜索。在搜索方面,GraphQL 可以帮助我们灵活地执行复杂的查询。而 RxJS 的变换操作符可以使我们更高效地处理查询结果。最后,我们还创建了一个简单的 Github 用户搜索应用程序,演示了如何将这两个技术结合使用,以实现高级搜索功能。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6719c0b29b4aadf9e004c653

纠错
反馈