Axios核心原理解析

使用者 - 导入axios

import axios from 'axios';

axios源码 - 创建axios实例/返回axios实例

// axios.js
var axios = createInstance(defaults);
module.exports.default = axios;

我们导入的是利用默认配置生成的一个axios实例

使用者 - 配置实例基本配置

const config = {
    baseURL: 'http://localhost:3344'
}

const request = axios.create(config)

axios源码 - 合并实例配置和默认配置/创建新的实例并返回

axios.create = function create(instanceConfig) {
    return createInstance(mergeConfig(axios.defaults, instanceConfig));
};

优先级顺序:请求配置>实例配置>默认配置

使用者 - 得到新实例,命名为request

const request = axios.create(config)

使用者 - 设置请求/响应拦截

// 添加请求拦截器
request.interceptors.request.use(function (config) {
    // 在发送请求之前做些什么
    console.log('请求拦截1', config);
    return config;
}, function (error) {
    // 对请求错误做些什么
    console.log("请求拦截出错1")
    return Promise.reject(error);
});

// 添加请求拦截器
request.interceptors.request.use(function (config) {
    // 在发送请求之前做些什么
    console.log('请求拦截2', config);
    return config;
}, function (error) {
    // 对请求错误做些什么
    console.log("请求拦截出错2")
    return Promise.reject(error);
});

// 添加响应拦截器
request.interceptors.response.use(function (response) {
    // 对响应数据做点什么
    console.log("拦截响应1");
    response = { message: "响应数据被我替换了,啊哈哈哈" }
    return response;
}, function (error) {
    // 对响应错误做点什么
    console.log(error);
    console.log("拦截出错1");
    return Promise.reject(error);
});

axios源码 - 存储请求/响应拦截到interceptors

// 拦截器构造函数
function InterceptorManager() {
    this.handlers = [];
}
InterceptorManager.prototype.use = function use(fulfilled, rejected) {
    this.handlers.push({
        fulfilled: fulfilled,
        rejected: rejected
    });
    return this.handlers.length - 1;
};

// 请求拦截和响应拦截均是拦截器的实例化
function Axios(instanceConfig) {
    this.defaults = instanceConfig;
    this.interceptors = {
        request: new InterceptorManager(),
        response: new InterceptorManager()
    };
}

// 用数组存储执行链
var chain = [dispatchRequest, undefined];
var promise = Promise.resolve(config);
// 将请求拦截成对推入执行链的头部
// 知道这个原理以后,我们就知道在设置多个请求拦截时,会按照设置时的顺序,倒序处理
this.interceptors.request.forEach(function unshiftRequestInterceptors(interceptor) {
    chain.unshift(interceptor.fulfilled, interceptor.rejected);
});
// 将响应拦截成对推入执行链的尾部,执行时按照设置时的顺序,正序处理
this.interceptors.response.forEach(function pushResponseInterceptors(interceptor) {
    chain.push(interceptor.fulfilled, interceptor.rejected);
});
// 依次成对执行,并用新的promise代替旧的promise,最后返回最新的promise
while (chain.length) {
    promise = promise.then(chain.shift(), chain.shift());
}
return promise;

重点分析:promise = promise.then(chain.shift(), chain.shift());

var promise = Promise.resolve(config);
while (chain.length) {
    promise = promise.then(chain.shift(), chain.shift());
}
return promise;

我们将以上代码,按照流程顺序将while语句根据实际情况拆解,更能理解以上代码的精髓

var promise = Promise.resolve(config);

promise = promise.then(
    function (config) {
        // 在发送请求之前做些什么
        console.log('请求拦截2', config);
        return config;
    },
    function (error) {
        // 对请求错误做些什么
        console.log("请求拦截出错2")
        return Promise.reject(error);
    }
)

promise = promise.then(
    function (config) {
        // 在发送请求之前做些什么
        console.log('请求拦截1', config);
        return config;
    },
    function (error) {
        // 对请求错误做些什么
        console.log("请求拦截出错1")
        return Promise.reject(error);
    }
)

promise = promise.then(
    dispatchRequest,
    undefined
)

promise = promise.then(
    function (response) {
        // 对响应数据做点什么
        console.log("拦截响应1");
        response = { message: "响应数据被我替换了,啊哈哈哈" }
        return response;
    },
    function (error) {
        // 对响应错误做点什么
        console.log(error);
        console.log("拦截出错1");
        return Promise.reject(error);
    }
)

return promise;

其实质就是一个promise的链式调用,如果执行过程中没有调用Promise.reject,将按照resolve路线走,一旦调用Promise.reject,将执行后面的所有reject函数

思考1:为什么需要使用者在reject函数中手动调用Promise.reject?

思考2:为什么需要使用者在请求拦截resolve函数中一直return config?

取消请求的实现

使用者 - 使用

// src/api.js
export function checkTask (parameter, others) {
  return request({
    url: projectApi.checkTask,
    method: 'post',
    data: parameter,
    ...others
  })
}

// view/components/view.jsx
import request from '@axios/myRequest'
import { checkTask } from '@src/api'
const source = request.CancelToken.source();// 实例化

// 发出请求
checkTask(formData, { cancelToken: source.token }).then(res=>{
    console.log(res)
})

// 关闭请求弹窗时,或其他操作,需要取消请求时
function cancelCheckTask(){
   source.cancel('cancel msg');
}

axios源码 - axios.CancelToken.source()做了啥

CancelToken.source = function source() {
    var cancel;
    var token = new CancelToken(function executor(c) {
        cancel = c;
    });
    return {
        token: token,
        cancel: cancel
    };
};

创建了一个 CancelToken 实例给 token,

CancelToken 的参数是一个函数executor,

将函数executor的参数c再赋值给 cancel

将 { token: token,cancel: cancel } 作为新对象返回

cancel是一个函数,执行时将取消带有当前token标记的请求

axios源码 - CancelToken又做了啥

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);
    });
}

创建了一个 Promise , 同时保存 Promise resolve 的具体实现

执行上一步传递的函数 executor ,

并将取消操作的具体实现函数 作为参数传递给 executor ,

executor将其赋值给 cancel 传递给用户

取消操作是执行了Promise.resolve

同时将用户设定的 message 封装后作为结果返回给 then 的实现

其实都是进行了promise上的操作流程:

=> source实例化时将取消函数cancel抛给用户,而cancel函数内有一个待定的resolve函数(resolvePromise)

=> 发送请求时再将onCanceled定义为cancel函数内的待定resolve函数

axios源码 - 发送请求时

// xhr.js

if (config.cancelToken) {
    // Handle cancellation
    config.cancelToken.promise.then(function onCanceled(cancel) {
        if (!request) {
            return;
        }

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

推荐阅读更多精彩内容

  • 实在来不及自己写了 把读过的文章先转过来 明天再进行编辑 axios项目目录结构 注:因为我们需要要看的代码都是...
    vivianXIa阅读 872评论 0 1
  • axios[https://github.com/axios/axios]是一个基于promise调用逻辑的htt...
    竹叶寨少主阅读 1,086评论 0 5
  • 简介 axios 是一个用于浏览器和Node.js上的基于 Promise 的http网络库。 大纲 使用方式安装...
    _双眸阅读 1,044评论 1 1
  • 基类 Axios 跟随入口 index.js 进入/lib/axios.js,第一个方法则是createInsta...
    丶梅边阅读 654评论 0 1
  • Vue.js 1.0 我们常使用 vue-resource (官方ajax库), Vue 2.0 发布后作者宣告不...
    九四年的风阅读 24,090评论 1 8