不到50行代码实现一个能对请求并发数做限制的通用RequestDecorator

使用场景

在开发中,我们可能会遇到一些对异步请求数做并发量限制的场景,比如说微信小程序的request并发最多为5个,又或者我们需要做一些批量处理的工作,可是我们又不想同时对服务器发出太多请求(可能会对服务器造成比较大的压力)。这个时候我们就可以对请求并发数进行限制,并且使用排队机制让请求有序的发送出去。

介绍

那么,接下来我们就来讲一下如何实现一个通用的能对请求并发数进行限制的RequestDecorator。我们先来介绍一下它的功能:

  1. 既然涉及到并发数限制,它就肯定允许用户传入最大并发数限制参数:maxLimit

  2. 既然是一个通用的RequestDecorator,那么它应该允许使用者传入其喜欢的异步api(比如ajax, fetch, axios等)。

  3. 为了方便起见,也为了开发便利性,被RequestDecorator封装后的request请求结果都返回一个promise。

  4. 由于使用者传入的异步api不一定是promise类型的,也可能是callback类型的,因此我们提供用户一个needChange2Promise参数,使用者若传入的是callback类型的api,它可以通过将这个参数设置为true来将callback类型转化为promise类型。

分析完功能后,接下来我们就来实现这个东西:

实现

具体代码如下,每一步我基本都做了注释,相信大家能看懂。


const pify = require('pify');

class RequestDecorator {

  constructor ({

    maxLimit = 5,

    requestApi,

    needChange2Promise,

  }) {

    // 最大并发量

    this.maxLimit = maxLimit;

    // 请求队列,若当前请求并发量已经超过maxLimit,则将该请求加入到请求队列中

    this.requestQueue = [];

    // 当前并发量数目

    this.currentConcurrent = 0;

    // 使用者定义的请求api,若用户传入needChange2Promise为true,则将用户的callback类api使用pify这个库将其转化为promise类的。

    this.requestApi = needChange2Promise ? pify(requestApi) : requestApi;

  }

  // 发起请求api

  async request(...args) {

    // 若当前请求数并发量超过最大并发量限制,则将其阻断在这里。

    // startBlocking会返回一个promise,并将该promise的resolve函数放在this.requestQueue队列里。这样的话,除非这个promise被resolve,否则不会继续向下执行。

    // 当之前发出的请求结果回来/请求失败的时候,则将当前并发量-1,并且调用this.next函数执行队列中的请求

    // 当调用next函数的时候,会从this.requestQueue队列里取出队首的resolve函数并且执行。这样,对应的请求则可以继续向下执行。

    if (this.currentConcurrent >= this.maxLimit) {

      await this.startBlocking();

    }

    try {

      this.currentConcurrent++;

      const result = await this.requestApi(...args);

      return Promise.resolve(result);

    } catch (err) {

      return Promise.reject(err);

    } finally {

      console.log('当前并发数:', this.currentConcurrent);

      this.currentConcurrent--;

      this.next();

    }

  }

  // 新建一个promise,并且将该reolsve函数放入到requestQueue队列里。

  // 当调用next函数的时候,会从队列里取出一个resolve函数并执行。

  startBlocking() {

    let _resolve;

    let promise2 = new Promise((resolve, reject) => _resolve = resolve);

    this.requestQueue.push(_resolve);

    return promise2;

  }

  // 从请求队列里取出队首的resolve并执行。

  next() {

    if (this.requestQueue.length <= 0) return;

    const _resolve = this.requestQueue.shift();

    _resolve();

  }

}

module.exports = RequestDecorator;

样例代码如下:


const RequestDecorator = require('../src/index.js')

// 一个callback类型的请求api

function delay(num, time, cb) {

  setTimeout(() => {

    cb(null, num);

  }, time);

}

// 通过maxLimit设置并发量限制,needChange2Promise将callback类型的请求api转化为promise类型的。

const requestInstance = new RequestDecorator({

  maxLimit: 5,

  requestApi: delay,

  needChange2Promise: true,

});

let promises = [];

for (let i = 0; i < 30; i++) {

  // 接下来你就可以像原来使用你的api那样使用它,参数和原来的是一样的

  promises.push(requestInstance.request(i, Math.random() * 3000).then(result => console.log('result', result), error => console.log(error)));

}

async function test() {

  await Promise.all(promises);

}

test();

这样,一个能对请求并发数做限制的通用RequestDecorator就已经实现了。当然,这里还有很多可以继续增加的功能点,比如

  1. 允许使用者设置每个请求的retry次数。

  2. 允许使用者对每个请求设置缓存处理。

优点:

  1. 不修改用户原来的request api代码。对原有代码无副作用。

  2. 不修改request api的调用方式。用户可以无缝的使用被RequestDecorator封装过的request。

  3. 可扩展,后续可能不止支持并发量限制,还可能增加缓存、retry等额外的功能。

结语

以上,就是本篇的全部内容。github仓库地址点击这里。欢迎大家点赞或者star下。如果大家有兴趣的话,也可以一起来完善这个东西。这个项目还不成熟,可能还会有bug,欢迎大家在github上提issue帮助我完善它。如果觉得有帮助的话,麻烦点个赞哦,谢谢。

本文地址在->本人博客地址, 欢迎给个 start 或 follow

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 219,188评论 6 508
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,464评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 165,562评论 0 356
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,893评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,917评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,708评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,430评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,342评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,801评论 1 317
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,976评论 3 337
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,115评论 1 351
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,804评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,458评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,008评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,135评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,365评论 3 373
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,055评论 2 355

推荐阅读更多精彩内容

  • 五月底,经过的人资考试,迎来了论文写作的忙碌期。 一直在忙,渐渐地也有些沉不下心,昨天看世说新语,惊叹自己的古文阅...
    霁青阅读 410评论 0 0
  • 不知道你们有没有这种感觉,经常在某一个时间突然就不知道自己到底多大了,徘徊在上一岁这一岁和下一岁之间,常常觉得自己...
    莺莺夏木阅读 1,175评论 0 1