axios.CancelToken

axios.CancelToken官方文档:

使用方法如下:需要注意的是在get请求中CancelToken作为第二个参数传入,在post请求中CancelToken作为第三个参数传入

const CancelToken = axios.CancelToken;

const source = CancelToken.source();

axios.get('/user/12345', {

  cancelToken: source.token

}).catch(function (thrown) {

  if (axios.isCancel(thrown)) {

    console.log('Request canceled', thrown.message);

  } else {

    // handle error

  }

});

axios.post('/user/12345', {

  name: 'new name'

}, {

  cancelToken: source.token

})

// cancel the request (the message parameter is optional)

source.cancel('Operation canceled by the user.');

知道了使用方法后,最重要的我们是要搞清楚Cancel.Token的取消请求是怎么实现的,下面看一段源码 :

'use strict';

var Cancel = require('./Cancel');

function CancelToken(executor) {

    if (typeof executor !== 'function') {

        throw new TypeError('executor must be a function.');

    }

    var resolvePromise;

    this.promise = new Promise(function promiseExecutor(resolve) {

        resolvePromise = resolve;

    });

    var token = this;

    executor(function cancel(message) {

        if (token.reason) {

        // Cancellation has already been requested

            return;

        }

        token.reason = new Cancel(message);

        resolvePromise(token.reason);

    });

}

CancelToken.prototype.throwIfRequested = function throwIfRequested() {

    if (this.reason) {

        throw this.reason;

    }

};

CancelToken.source = function source() {

    var cancel;

    var token = new CancelToken(function executor(c) {

        cancel = c;

    });

    return {

        token: token,

    cancel: cancel

    };

};

module.exports = CancelToken;

从上面的代码可以看出在CancelToken这个类初始化的时候需要传递一个executor参数,在这个类的内部还创建了一个promise,然后定义了一个变量,把promise的resolve方法控制权放在了exexutor方法的执行体中。

这样做的目的是为了可以在外面控制promise的resolve。在promise的外部定义了一个resolvePromise 变量,在promise的内容将resolve赋值给了resolvePromise 这个变量,所以可以通过直接调用resolvePromise 来执行promise的resolve。

下面看下source这个方法同样的在这个方法中也定义了一个变量cancel,并且在这个方法内容new了一个CancelToken,并且传入一个参数c,并且将c赋值给了cancel,那么c又是代表的什么呢?

从上面代码可以看出,c就代表的是CancelToken类初始化的时候传入的executor,代码如下:

function cancel(message) {

    if (token.reason) {

        // Cancellation has already been requested

        return;

    }

    token.reason = new Cancel(message);

    resolvePromise(token.reason);

}

也就是说将上面的这个方法赋值给了cancel,可以通过这个方法控制CancelToken内部的promise对象。

在sourse方法中,还有一个token,这个token是CancelToken这个类的一个实例,可以访问到CancelToken内部的promise。

这样封装的目的是为了能够分离promise和resolve方法,让用户可以自主调用resolve,一旦resolve就会触发promise的then,那promise的then又做了什么呢?

if (config.cancelToken) {

    // Handle cancellation

    config.cancelToken.promise.then(function onCanceled(cancel) {

        if (!request) {

            return;

        }

        request.abort();

        reject(cancel);

        // Clean up request

        request = null;

    });

}

可以看到当调用cancel方法后,会理解执行abort方法取消请求,同时调用reject让外层的promise的reject执行。

转载他人,非原创,感谢关注

————————————————

版权声明:本文为CSDN博主「海绵杨宝宝」的原创文章,遵循CC 4.0 BY-SA版权协议,转载请附上原文出处链接及本声明。

原文链接:https://blog.csdn.net/qq_41820577/java/article/details/102868824

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