Axios中的取消请求源码解析

更新日期: 2020-01-31 阅读: 2.2k 标签: 源码

前言

在开发中,为了活动动态数据,因此我们需要与后台通过请求进行交互,获取动态数据来展现给用户看。有些一些网站对实时信息要求还更高,比如股票类、聊天类、直播类等。本章内容涉及思想层面东西比较多,如果出现知识盲点无所谓,主要就是体会Promise的运用思想!思想!思想!(小白也可以试试)


当下流行的http库

http库在当下作为请求交互来说,是比较主流的,今天就给大家介绍一个比较受欢迎的库:Axios

它在github上的star数截至到2020年3月已经达到70.2k,这算是比较多的了


今天讲什么

由于Axios是基于Promise的,有些操作如果更多的触碰到底层promise,代码上不免会让大家比较蒙,本文主要不是为了科普Axios的基本代码(因为官网上中文的、英文的多了去了)。

今天就给大家说一下,比较难懂的代码:cancelToken,他是怎么利用Promise跑起来的以及一些设计思路,不管你会不会这个库,都可以尝试理解一下源码的设计思路


取消请求

先说一下,有时我们上传一个文件到服务器的时候,文件很大,不可能一下传完,但是我们中途发现文件错了,因此我们点击取消,即为:取消请求。

在Axios中的代码如下:

// 创建取消令牌的生成器对象
const CancelToken = axios.CancelToken;
// 从中获取令牌对象
const source = CancelToken.source();
// 发请求
axios.get('/user/12345', {
  // 传递令牌
  cancelToken: source.token
});
// 2秒取消请求
setTimeout(function () { 
	source.cancel();
},2000);

虽然注释已经打上了,中文意思大家都懂,但是很少有人能知道这其中Promise做了啥,而相反我们更容易理解为cancel函数中断了异步请求,是中断了Promise吗? 不是!


源码实现

接下来我带大家简单实现一个,你可能就清楚了。

为了便于理解,我少封装了一层,针对上述 const source = CancelToken.source();

我写了如下代码,看起来差不多

var source = source();

接着模拟axios.get(url,options); 函数,我也简单的这么写

axios_get('url',{
    cancelToken:source.token
});

最后我们做定时器

setTimeout(function () {
			source.cancel(); // 5秒之后执行下一步操作
},5000)

好了,需要调用的代码都写好了,接下来就是就是实现这些函数,首先我应该有个source函数,他返回一个对象,可以调用cancel函数,有个token属性

function source () {
    return {
        token:'??'
        cancel:'??'
    }
}

ok,接下来我们还有axios_get函数,他的作用就是发请求,假设我们使用XMLHttpRequest对象,他里面则最终经过配置后需要发请求。

function axios_get(url,options) {
    // 先各种配置
    
    // 最终发请求 
    xhr.request();
}

以上代码这个思路没问题吧? 接着来!用户点击后,通过调用source.cancel() 实际需要访问到axios_get内部的XMLHttpRequest对象,调用其的abort函数才能真正意义的取消。因此,我们要想办法让source某一部分能访问到该对象。这里唯一的触及点就是传递的cancelToken:source.token。

function axios_get(url,options) {
    // 先各种配置
    if (options.cancelToken) {
        // ...  xhr.abort();
    }
    // 最终发请求   
     xhr.request();
}

这里你可以想到直接调用函数,或者回传xhr.abort等方式,但是由于axios是基于Promise的,因此,我们最好用Promise来处理,显得也会更优雅,我们假设这个cancelToken就是Promise,那么给他定义.then的话,中间就只差一个resolve(),该函数就能得到执行了

function axios_get(url,options) {
    // 先各种配置
    if (options.cancelToken) {
        options.cancelToken.then(function () {
           xhr.abort(); 
        });
    }
    // 最终发请求  
    xhr.request();
}

好了,继续往上追溯,这里的cancelToken也就是我们source.token,他要是个Promise的话,我们就得回到之前的创建source函数中

function source () {
    let p = new Promise(function (resolve,reject) {
		// 这里几乎啥也不做
    });
    return {
        token:p,
        cancel:'??'
    }
}

好像还有点不对,我们应该把链接Promise和then的一个放行开关传递出去,这样才能调用resolve执行后续的.then从而执行取消请求的代码

function source () {
    let cancel;
    let p = new Promise(function (resolve,reject) {
		cancel = resolve;
    });
    return {
        token:p,
        cancel:cancel
    }
}

好了,至此,我们在source里面创建Promise,将其本身和resolve(cancel) 向外导出,在请求的时候传递给axios_get函数,其内部配置promise的.then:取消请求。


如图就是这个思想,主要就是我们利用了Promise 和 其 resolve 来放行到下一步,进行延迟执行。

完整代码:

	// 创建Promise,返回放行开关cancel
		function source () {
			var cancel;
			var promise = new Promise(function (resolve) {
				cancel = resolve;
			});
			return {
				cancel:cancel,
				token:promise 
			}
		}
	// 发请求
		function axios_get(config) {
			if (config.cancelToken) {
				config.cancelToken.then(function () {
					xhr.abort();
				})
			}
		}

// 代码执行
		var source = source();

		axios_get({cancelToken:source.token});

		setTimeout(function () {
			source.cancel(); // 5秒之后执行下一步操作
		},5000)

本文内容仅供个人学习、研究或参考使用,不构成任何形式的决策建议、专业指导或法律依据。未经授权,禁止任何单位或个人以商业售卖、虚假宣传、侵权传播等非学习研究目的使用本文内容。如需分享或转载,请保留原文来源信息,不得篡改、删减内容或侵犯相关权益。感谢您的理解与支持!

链接: https://fly63.com/article/detial/8031

相关推荐

star-history源码阅读:Github的stargazers接口与分页机制

Github官方提供了一系列REST API(现在有向graphql上迁移的趋势),通过REST API,可以获得许多Github上的信息,以此为基础,我们可以构建各式各样的APP,star-history这个项目也是这样建立起来的,Github虽然没有提供直接查看项目star历史的功能

微信小程序代码源码案例大全

克隆项目代码到本地(git应该都要会哈,现在源码几乎都会放github上,会git才方便,不会的可以自学一下哦,不会的也没关系,gitHub上也提供直接下载的链接);打开微信开发者工具;

亲测源码,等大量源码免费下载-龙腾源码网

超多源码在龙腾源码网随处可见,高质量的源码给您带来不一样的感觉,无论是搭建还是询问

Vue 3 源码开放了

于2019年10月5日凌晨,尤雨溪在微博宣布 Vue 3.0 的源码开放了。目前依然是 pre-alpha 状态,但主要的架构改进、优化和新功能都已经完成,剩下的主要是完成一些 Vue 2 现有功能的移植

Node 集群源码初探

随着这些模块逐渐完善, Nodejs 在服务端的使用场景也越来越丰富,如果你仅仅是因为JS 这个后缀而注意到它的话, 那么我希望你能暂停脚步,好好了解一下这门年轻的语言,相信它会给你带来惊喜

vue源码解析:nextTick

nextTick的使用:vue中dom的更像并不是实时的,当数据改变后,vue会把渲染watcher添加到异步队列,异步执行,同步代码执行完成后再统一修改dom,我们看下面的代码。

Js中的 forEach 源码

在日常 Coding 中,码农们肯定少不了对数组的操作,其中很常用的一个操作就是对数组进行遍历,查看数组中的元素,然后一顿操作猛如虎。今天暂且简单地说说在 JavaScript 中 forEach。

React源码解析之ExpirationTime

在React中,为防止某个update因为优先级的原因一直被打断而未能执行。React会设置一个ExpirationTime,当时间到了ExpirationTime的时候,如果某个update还未执行的话,React将会强制执行该update,这就是ExpirationTime的作用。

React源码解析之ReactDOM.render()

React更新的方式有三种:(1)ReactDOM.render() || hydrate(ReactDOMServer渲染)(2)setState(3)forceUpdate;接下来,我们就来看下ReactDOM.render()源码

扒开V8引擎的源码,我找到了你们想要的前端算法

算法对于前端工程师来说总有一层神秘色彩,这篇文章通过解读V8源码,带你探索 Array.prototype.sort 函数下的算法实现。来,先把你用过的和听说过的排序算法都列出来:

点击更多...

内容以共享、参考、研究为目的,不存在任何商业目的。其版权属原作者所有,如有侵权或违规,请与小编联系!情况属实本人将予以删除!