随着前端异步编程的发展，Promise 已经成为了 JavaScript 中最为流行的异步编程方式之一。在进行异步编程的同时，我们有时需要对异步请求进行轮询，以实现某些特定的业务逻辑。在这时，npm 包 promise-poller 就成为了轮询的一个非常好的选择。它可以帮助我们轻松地编写轮询逻辑，让我们可以专注于业务本身的实现。
本篇文章将带着大家一起来学习如何使用 promise-poller 包实现轮询，包括包的安装、基本使用方法、高级用法以及一些常见问题及解决方法。
1. 安装 promise-poller 包
使用 npm 命令行安装 promise-poller 包，命令如下：
npm install promise-poller
2. 基本用法
promise-poller 最基本的用法是通过调用 until() 方法进行轮询操作，该方法需要传入两个参数：
- 轮询的操作函数，我们用
pollFn表示； - 轮询结束的判断函数，我们用
shouldContinueFn表示。
调用方法如下：
-- -------------------- ---- ------- ----- ------ - -------------------------- ------------- ------- ---------------- ------------- -- - ------------------------------- -------------- -- - ------------------------------------ --
其中，pollFn 函数的返回值可以是任意类型，当 shouldContinueFn 函数返回值为 false 时，轮询结束，until() 方法会返回 pollFn() 的最后一次返回值。当 shouldContinueFn 函数返回值为 true 时轮询继续进行。
下面我们通过一个简单的示例来演示如何使用 promise-poller 包。
-- -------------------- ---- ------- ----- ------ - -------------------------- --- ----- - -- ----- ------ - -- -- - ----------------------- ----------- ------ -------- - ----- ---------------- - -------- -- - ------------------------------- ---------- ------------ ------ ------ - -- - ------------- ------- ---------------- ------------- -- - ------------------------------- -------------- -- - ------------------------------------ --
运行后，我们可以看到控制台输出了以下内容：
-- -------------------- ---- ------- ---------- - ------------------ ---------- - ---------- - ------------------ ---------- - ---------- - ------------------ ---------- - ---------- - ------------------ ---------- - ---------- - ------------------ ---------- - -------
我们可以看到，promise-poller 成功按照我们的预期进行了轮询操作，轮询结束时，返回的结果为轮询操作函数最后一次返回值。
3. 高级用法
promise-poller 还提供了一些高级用法，可以更好地适应我们的实际需求。
3.1 添加轮询间隔时间
我们可以通过 interval 属性来为轮询操作添加时间间隔，让轮询操作按一定的时间间隔周期性地执行。
-- -------------------- ---- ------- ----- ------ - -------------------------- --- ----- - -- ----- ------ - -- -- - ----------------------- ----------- ------ -------- - ----- ---------------- - -------- -- - ------------------------------- ---------- ------------ ------ ------ - -- - ------------- ------- ----------------- - --------- ---- - ------------- -- - ------------------------------- -------------- -- - ------------------------------------ --
我们增加了 { interval: 1000 } 参数，表示每次执行轮询操作后，休眠 1000ms 后再进行下一次轮询操作。
3.2 超时退出
我们可以通过 timeout 属性来设定轮询的超时时间，在超时时间到达后退出轮询操作。
-- -------------------- ---- -------
----- ------ - --------------------------
--- ----- - --
----- ------ - -- -- -
----------------------- -----------
------ --------
-
----- ---------------- - -------- -- -
------------------------------- ---------- ------------
------ ------ - --
-
-------------
-------
-----------------
-
--------- -----
-------- ----
-
------------- -- -
-------------------------------
-------------- -- -
------------------------------------
--我们增加了 { timeout: 5000 } 参数，表示超时时间为 5000ms。
3.3 添加错误处理函数
在进行轮询操作时，可能会出现执行错误，我们可以通过 errorParser 函数对错误进行处理。该函数需要传入一个 error 参数，返回一个处理后的结果。
-- -------------------- ---- -------
----- ------ - --------------------------
--- ----- - --
----- ------ - -- -- -
----------------------- -----------
-- ------ - -- -
----- --- ------------ -- ----
-
------ --------
-
----- ---------------- - -------- -- -
------------------------------- ---------- ------------
------ ------ - --
-
-------------
-------
-----------------
-
--------- -----
-------- -----
------------ ------- -- -
-- -------------- --- ------ -- --- -
------ -----------
- ---- -
----- ------
-
-
-
------------- -- -
-------------------------------
-------------- -- -
------------------------------------
--我们增加了 errorParser 参数，对 pollFn 中可能出现的错误进行了处理。
4. 常见问题及解决方法
4.1 如何在异步操作中使用 promise-poller
我们在进行异步操作时，可能需要在异步回调完成后进行轮询操作。此时，我们需要将 promise-poller 的代码写入异步代码块中，如下所示：
-- -------------------- ---- -------
----- ------ - --------------------------
----- ------- - ----- -- -- -
----- -----------------
-------------------- -----------------
------------ -- -
-------------------------------
--
------------ -- -
------------------------------------
---
-4.2 循环引用问题
在使用 promise-poller 时，可能会出现循环引用的问题。我们可以通过将 poller.until() 移动到外层函数中解决该问题。如下所示：
-- -------------------- ---- -------
----- ------ - -- -- -
----- ------ - -- -- -----
----- ---------------- - -- -- -----
------ -------------------- -----------------
------------ -- -
-------------------------------
------ ---------
---
-
---------总结
本文介绍了 promise-poller 包的使用方式，包括轮询的基本用法以及各种高级用法。在实际项目中，我们可以根据具体需求进行灵活运用，从而更好地提高编程效率，实现业务逻辑。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/promise-poller