源码阅读:p-limit
源码阅读:p-limit
简介
p-limit
是一个用于限制并发操作的包,它可以控制同时执行的异步操作数量。它提供了一种简单的方式来管理并发操作,以避免系统资源过度占用和性能下降。
p-limit
的工作原理是使用一个计数器来跟踪当前正在执行的操作数量。当有新的操作需要执行时,它会检查当前的计数器值,如果小于设定的并发限制数,则立即执行操作并将计数器加一。如果计数器已达到并发限制数,则将操作加入等待队列,直到有空闲的位置。
p-limit
提供了以下功能和特点:
- 简单易用:使用
p-limit
非常简单,只需创建一个限制对象,并将需要执行的异步操作包装成一个函数进行调用即可。 - 并发限制:通过设置并发限制数,可以控制同时执行的操作数量,以避免过度占用系统资源。
- 异步操作支持:
p-limit
适用于异步操作,可以是Promise对象、回调函数或任何需要异步执行的操作。 - 队列管理:当并发限制数已满时,
p-limit
会自动将操作加入等待队列,并在有空闲位置时按照先进先出的顺序执行等待的操作。 - 可以清空队列:
p-limit
还提供了清空队列的方法,可以在需要时立即取消所有等待执行的操作。
使用p-limit
可以很方便地控制并发操作的数量,特别适用于需要限制资源消耗或避免性能问题的场景,例如网络请求、文件操作、数据库查询等。
使用p-limit
非常简单,以下是p-limit
的基本用法:
创建一个限制对象,指定并发限制数:
const limit = pLimit(2); // 限制同时执行的操作数量为3
将需要执行的异步操作包装成一个函数,并调用限制对象的函数来执行操作:
const asyncTask = (id) => {
return limit(() => {
return new Promise((resolve) => {
console.log(`Start task ${
id}`);
setTimeout(() => {
console.log(`End task ${
id}`);
resolve();
}, 1000);
});
});
};
asyncTask(1);
asyncTask(2);
asyncTask(3);
在上面的示例中,我们创建了一个 p-limit
实例,并将并发限制设置为 2
。然后,我们定义了一个异步任务 asyncTask
,通过 limit
方法包装这个任务,确保最多同时执行 2
个任务。最后,我们按顺序调用 asyncTask
,可以看到只有同时运行的任务数不超过 2
。
此外,p-limit
还提供了其他一些功能和方法,例如:
- 获取当前正在执行的操作数量:
limit.activeCount
可以获取当前正在执行的操作数量。 - 获取等待执行的操作数量:
limit.pendingCount
可以获取等待执行的操作数量。 - 清空等待队列:
limit.clearQueue()
可以清空等待队列,取消所有等待执行的操作。
这些功能可以帮助我们更好地管理并发操作的执行和控制。
源码解读
import Queue from 'yocto-queue';
export default function pLimit(concurrency) {
// 检查并发数concurrency是否为正整数或正无穷大,并且大于0
if (!((Number.isInteger(concurrency) || concurrency === Number.POSITIVE_INFINITY) && concurrency > 0)) {
throw new TypeError('Expected `concurrency` to be a number from 1 and up');
}
// 创建一个队列实例
const queue = new Queue();
// 当前正在执行的任务数量