AbortController使用场景探索

AbortController是一个DOM API。MDN上对它的介绍是 AbortController接口表示一个控制器对象,允许根据需要终止一个或多个Web请求。

但是它只能用来终止请求吗,那当然不是?

目前笔者只发现的2个AbortController的使用场景,分别是:fetchaddEventListener,下文分别介绍这两种情况。

fetch

fetch提供了一个可选参数signal,可以用来终止请求。
那signal是啥?是怎么终止的?表现形式是啥?真的取消请求了还是只是不接受返回的数据?

下面通过一个案例来实践一下:


按钮.png

页面上提供了2个按钮,分别用来fetch(请求)和abort(废弃请求)。然后通过给fetch添加signal来控制请求:

  const controller = new AbortController();   // 新建一个AbortController实例
  let signal = controller.signal;    // signal是AbortController实例的属性

  const downloadBtn = document.querySelector('.download');
  const abortBtn = document.querySelector('.abort');

  downloadBtn.addEventListener('click', fetchVideo);

  abortBtn.addEventListener('click', function () {
      controller.abort();  // 调用abort方法
      console.log('Download aborted');
  })

  function fetchVideo() {
    //...
    fetch(url, {signal}).then(function(response) {
      //...
    }).catch(function(e) {
      console.error('e', e);
    })
}

点击下载按钮,请求发起,此时请求状态是 待处理(pending)

下载中.png

请求还在进行中时,点击废弃按钮(实际上是调用了AbortController实例的abort方法),状态变成 已取消(canceled):

废弃.png

取消后,fetch请求的promise 将 reject 一个名为 AbortError 的 DOMException,也就是会被例子中的catch捕获到,可以在控制台看到如下错误:

abort error.png

需要注意的是已经abort的请求是不能重复调用的,看fetch源码的实现就可以知道为什么,AbortSignal 在 abort 之后,状态就变成了 aborted,那么下次调用 fetch 请求的时候,当读到 AbortSignal 的状态是 aborted 的时候,就直接 reject 。

   // fetch仓库地址: https://github.com/github/fetch/blob/master/fetch.js 
    
    if (request.signal && request.signal.aborted) {
      return reject(new DOMException('Aborted', 'AbortError'))
    }
fetch after abort .png

也就是说在业务上,如果有同一个请求发了多次只想保留最后一个的话,我们需要用多个controller来控制,每发送一个请求就把上次的请求abort。

addEventListener

AbortController还可以作为addEventListener第三个参数options上的可选属性:


image.png

按照mdn的说法,当调用abort()后,监听器会被移除。其实这就相当于给我们内置了一个移除监听器的方式,可以不用把callback单独提取出成一个函数。

测试

用一个测试按钮,添加监听器,然后在监听函数中使用setTimeout执行abort


addEventListener.png

在点击测试监听按钮前,可以在元素里找到监听器:

before Click.png

点击测试按钮,控制台输出'监听',同时自动移除元素的监听器(需要先关闭控制台重新开):


after abort.png

众所周知,如果需要 removeEventListenr(type, callback), 它的callback必须和addEventListener是同一个函数引用,而在某些业务场景下,我们并不想多写函数可以改成用signal来控制。
例如,当在按钮鼠标时设置一个监听器,在监听器中再监听鼠标移动,鼠标松开关闭监听器:

  document.addEventListener('mousedown', callback);
  document.addEventListener('mouseup', callback2);
  function callback (e) {
      document.addEventListener('mousemove',  callback3);
   }

  function callback2 (e) {
     document.removeEventListener('mousemove', callback3);
  }
  
  function callback3(event) {}

如果改写成用AbortController怎么写呢?

    const controller = new AbortController();
    function callback (e) {
      document.addEventListener('mousemove',  (e) => {
          
      },{
           signal: controller.signal  
      });
   }
    document.addEventListener('mousedown', callback);
    document.addEventListener('mouseup', controller.abort);

总结

AbortController可以用在fetch和addEventListener,分别用来废弃请求和废弃监听器。

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

推荐阅读更多精彩内容