npm 包 urql 使用教程

AI 编程助手,豆包旗下的编程助手,提供智能补全、智能预测、智能问答等能力,节省开发时间,释放脑海中的创造力,支持 VSCode,点击体验 AI

简介

urql 是一个现代化的 React GraphQL 客户端库,它的目标是让使用 GraphQL 更加容易且高效。它提供了一系列强大的特性,例如缓存、预取和条件查询等,可在应用程序中提供更快、更高效的数据获取体验。

在本文中,我们将介绍 urql 的基本用法,以及如何在 React 应用程序中使用它来管理 GraphQL 数据。

安装

在使用 urql 之前,我们需要通过 npm 进行安装:

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

用法

创建客户端

首先,我们需要创建一个 urql 客户端来管理我们的 GraphQL 数据。我们可以通过 createClient 方法来完成:

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

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

在上面的例子中,我们创建了一个新的 urql 客户端,并将其连接到在 url 参数中指定的 GraphQL endpoint。

查询数据

接下来,我们可以使用 useQuery 钩子来查询 GraphQL 数据:

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

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

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

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

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

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

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

在上面的例子中,我们使用 useQuery 钩子来查询 posts 数据,并将其渲染为一个列表。在 result 变量中,我们能够获取到查询结果、错误信息和查询状态。如果数据正在获取中,我们就显示一个 “Loading…” 提示信息;如果发生错误,我们就显示一个 “Error” 提示信息。

缓存

urql 为我们提供了一个自动缓存的功能。当我们发出一个查询请求时,urql 将会自动缓存这个请求的结果,如果再次发出相同的请求,urql 将直接返回缓存的结果,而不会再次进行网络请求。

我们可以通过在 useQuery 钩子中传递一个 cache 参数,来控制缓存的行为。例如,我们可以使用 cache: "network-only" 来强制查询网络,并忽略缓存:

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

我们也可以使用 cache: "cache-only" 来只使用缓存,而不进行网络请求。这在我们需要避免触发网络请求时非常有用。例如,当我们手动地调用了 client.invalidateQueries() 方法时,我们可以使用 cache-only 来保证页面内的数据不会被刷新:

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

变异数据

使用 useMutation 钩子,我们可以对 GraphQL 数据进行变异。例如,我们可以创建一个新的 GraphQL 文章:

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

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

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

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

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

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

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

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

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

我们使用 useMutation 钩子来创建一个 createPost 变异,当我们提交表单时,我们会调用 executeMutation 方法,并将 titlebody 作为参数传递给它。在变异成功后,我们清除表单,并重新渲染组件。

局部刷新

urql 还提供了一些高级工具来管理 GraphQL 数据。例如,我们可以使用 useQuery 钩子的 requestPolicy 参数来控制查询的行为。默认情况下,urql 会使用 cache-and-network 策略:

  • 如果有缓存,会立即返回缓存的数据,并在后台获取新的数据。
  • 当新的数据回来时,会刷新缓存,并重新渲染 UI。

如果我们需要使用类似于 cache-firstnetwork-only 或者 network-first 的策略,我们可以在 requestPolicy 参数中进行设置。例如,如果我们想要使用 network-only 策略来立即查询网络而不获取缓存,我们可以这样做:

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

对于一些复杂的场景,我们还可以使用 useQuery 钩子的 pause 参数来控制是否需要暂停查询。例如,我们可以暂停查询,并在某个时候重新恢复:

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

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

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

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

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

在上面的例子中,我们使用 useState 钩子来管理 paused 变量。我们在查询中使用了 pause: paused,来设置查询是否被暂停。我们之后在个定时器上,重新触发查询,以便重新获取最新的数据。

结论

urql 是一个非常强大和易用的 GraphQL 客户端库,它提供了诸多特性,例如缓存、条件查询、局部查询等等。通过使用 urql,我们可以在 React 应用程序中轻松地管理 GraphQL 数据,从而提高了应用程序的响应速度和性能。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/5f2bc6933b0ab45f74a8bb60


猜你喜欢

  • npm 包 geostats 使用教程

    简介 geostats 是一个 JavaScript npm 包,提供了一系列用于地理数据分析和统计的工具。它可以帮助前端开发人员更方便地处理和呈现地理数据,例如在地图上展示不同区域的气候、人口密度等...

    4 年前
  • npm 包 gulp-json-srv 使用教程

    前言 在前端开发过程中,我们经常需要建立一些数据接口来完成前后端的交互。有时候手动模拟数据非常耗时费力,因此一些第三方工具应运而生,比如 json-server。它可以快速地搭建一个 mock 接口,...

    4 年前
  • npm 包 react-json-table 使用教程

    前言 在前端开发中,我们会经常使用到表格组件来展示数据。在 React 中,有许多优秀的表格组件可以使用,而其中 react-json-table 是一款轻量、易用、高度可定制的表格组件。

    4 年前
  • npm 包 react-typeahead 使用教程

    前端开发中,输入框自动补全是经常使用的功能之一,而依靠 React 来实现该功能,我们可以使用 react-typeahead 这个 npm 包。本文将介绍如何使用该包来实现输入框的自动补全功能。

    4 年前
  • npm 包 svg-style-inliner 使用教程

    SVG 是一种基于 XML 的标准矢量格式,用于描绘二维图像。SVG 在 Web 开发中使用广泛,然而在实际使用过程中,我们经常会遇到如下问题: SVG 图像样式无法与 HTML 和 CSS 进行联...

    4 年前
  • npm 包 jasmine-sinon 使用教程

    在前端开发中,测试是非常重要的一环。测试可以帮助我们确保代码的质量和稳定性。而在测试过程中,常常需要使用一些工具来辅助我们完成测试的任务。其中, jasmine 和 sinon 是两个非常好用的工具。

    4 年前
  • npm包 "@iamadamjowett/angular-click-outside" 使用教程

    在前端开发中,对于一些组件的实现需要用到鼠标点击事件之外的一些事件,此时就需要使用到点击外部的事件。本文将介绍一个npm包 "@iamadamjowett/angular-click-outside"...

    4 年前
  • npm 包 phantomjs-polyfill-array-from 使用教程

    在前端开发中,为了兼容各种浏览器的不同版本和特性,我们经常需要使用一些 polyfill 库使得代码在不同环境下运行一致。其中 phantomjs-polyfill-array-from 帮助我们处理...

    4 年前
  • npm 包 filter-pipe 使用教程

    filter-pipe 是一个方便数据过滤的 npm 包,可以通过链式调用实现多个过滤条件的组合。本文将介绍如何使用 filter-pipe 进行前端开发中常用的数据过滤操作。

    4 年前
  • npm 包 exact-version 使用教程

    前言 在开发过程中,我们经常需要使用已经发布的 npm 包,但是我们并不一定需要使用最新的版本。有时候,我们需要使用指定版本的 npm 包,这时候我们就需要使用 exact-version 这个 np...

    4 年前
  • npm包semver-range-types使用教程

    semver-range-types是一个npm包,用于解析和判断版本号范围的类型。在前端开发中,很多时候需要使用版本号,而semver-range-types提供了一种简单且有效的方式来管理和比较版...

    4 年前
  • npm 包 semver-operators 使用教程

    简介 semver-operators 是一个用于处理版本号的 npm 包,它支持语义化版本和一系列的符号操作,用于比较和验证版本号。如果你是前端开发者,并且经常在项目中使用依赖管理工具,那么这个包就...

    4 年前
  • npm 包 assert-semver-operator 使用教程

    简介 assert-semver-operator 是一个针对 semver 版本号进行比较的 npm 包,它可以帮助你方便地测试你的模块是否符合你所期望的版本号,减少错误的发生。

    4 年前
  • npm包angular-notify使用教程

    前言 在前端开发中,通知提示是经常用到的一种交互方式,而angular-notify是一个方便易用的通知提示库,具有轻量、易扩展、可自定义等优点,在项目中得到广泛应用。

    4 年前
  • npm 包 testable-js 使用教程

    testable-js 是一款基于 JavaScript 的测试框架,可以用于前端应用程序的自动化测试。本文将介绍 testable-js 的基本使用方法,包含安装、配置、测试环境搭建以及测试案例编写...

    4 年前
  • npm 包 yields-unserialize 使用教程

    在前端开发中,使用第三方库是一个常见的需求。其中,NPM 是一个广泛使用的包管理器,可以方便地安装、更新、卸载和管理其它人编写的 JavaScript 包。其中一个有趣的 NPM 包是 yields-...

    4 年前
  • npm 包 yields-store 使用教程

    在前端开发中,我们常常会使用一些第三方库和框架来加快开发进度、提升开发效率。而 npm 是前端开发中非常常用的第三方库管理工具,它可以帮助我们快速引入和管理第三方库。

    4 年前
  • npm 包 angular-vs-repeat 使用教程

    介绍 angular-vs-repeat 是一个 AngularJS 的虚拟滚动列表插件,可以帮助你处理大量数据的列表显示,加速网页加载和性能。虚拟滚动是指在滚动区域内,只显示需要显示的数据,而非全部...

    4 年前
  • npm 包 raw 使用教程

    npm 是 Node.js 的包管理工具,它可以方便地安装和管理各种 JavaScript 依赖包。而 raw 则是一款可以直接读取文本文件的 npm 包,它非常实用,特别是在前端项目中使用到文本文件...

    4 年前
  • npm 包 rebuild 使用教程

    在 Node.js 开发过程中,我们会使用很多第三方 npm 包。有时候,在我们的项目中,我们需要对这些已安装的 npm 包进行重新编译,以确保其能够正确在当前系统环境中运行。

    4 年前

相关推荐

    暂无文章