助你解析Axios原理之一:如何实现多种请求方式

自从Axios成功打入Vue全家桶之后,便开始火的一塌糊涂!截止到目前,其在github上的star即将突破80k!可以说Axios是当下前端界最流行的ajax请求库,可(jue)能(dui)没有之一!

即然Axios人气如此之高,那么阅读并研究它的源码也是非常有必要的,因为这样不仅可以让自己少走很多弯路,还会对作者多年的编程思想以及经验进行猎取,从中抽象出一些架构及模式性的高级内容,最终提高自己的实现能力和技巧,让自己变得更加强大!

(啰嗦句:阅读源码的换确确可以提升自身的编码水平,但需要你拥有一定相关经验基础以及相对领域的认知,否则看源码绝对是在浪费时间!为什么?因为你看不懂!)

本系列文章将会对Axios源码思想进行精简提炼,从而将大家所关心的一些内部原理问题进行解答。

一、封装一个简易版本的xhr + promise的异步ajax请求库

由于axios是一个基于xhr + promise的异步ajax请求库,所以咱们可以先单纯的封装一个:

function axios(config){
    // 将请求方式全部转为大写
    const method = (config.method || "get").toUpperCase();
    // 返回Promise
    return new Promise((resolve,reject)=>{
        // 声明xhr
        const xhr = new XMLHttpRequest();
        // 定义一个onreadystatechange监听事件
        xhr.onreadystatechange = function () {
            // 数据全部加载完成
            if(xhr.readyState === 4){
                // 判断状态码是否正确
                if(xhr.status >= 200 && xhr.status < 300){
                    // 得到响应体的内容
                    const data = JSON.parse(xhr.responseText);
                    // 得到响应头
                    const headers = xhr.getAllResponseHeaders();
                    // request 即是 xhr
                    const request = xhr;
                    // 状态码
                    const status = xhr.status;
                    // 状态码的说明
                    const statusText = xhr.statusText
                    resolve({
                        config,
                        data,
                        headers,
                        request,
                        status,
                        statusText
                    });
                }else{
                    reject("请求失败"+xhr.status+xhr.statusText);
                }
            }
        }
        // 判断是否拥有params,且类型为object
        if(typeof config.params === "object"){
            // 将object 转为 urlencoded 
            const arr = Object.keys(config.params);
            const arr2 = arr.map(v=>v+"="+config.params[v]);
            const url = arr2.join("&");
            config.url +=  "?" + url;
        }
        xhr.open(method,config.url);
        // post put patch
        if(method === "POST" || method === "PUT" || method === "PATCH"){
            if(typeof config.data === "object")
                xhr.setRequestHeader("content-type","application/json");
            else if(typeof config.data === "string")
                xhr.setRequestHeader("content-type","application/x-www-form-urlencoded");
            xhr.send(JSON.stringify(config.data));
        }else{
            xhr.send();
        }

    })
}

以上代码实现了axios(config)直接发起请求,例如:

axios({
    method:"delete",
    url:"data.json"
}).then(res=>console.log(res))

但是,如果我想通过axios.get(url[, config])axios.delete(url[, config])axios.post(url[, data[, config]])等请求方式就行不通了。

二、封装request

通过阅读源码得到一些启示:源码中有一个名为Axios的构造函数,而我们的xhr + promise封装在Axios.prototype.request函数中。另外我们所使用的axios.getaxios.post等也都是定义在Axios.prototype中。
根据这些启示将代码调整为:

// 构造函数
function Axios(){

}
Axios.prototype.request = function (config) {
    // 将请求方式全部转为大写
    const method = (config.method || "get").toUpperCase();
    // 返回Promise
    return new Promise((resolve,reject)=>{
        // 声明xhr
        const xhr = new XMLHttpRequest();
        // 定义一个onreadystatechange监听事件
        xhr.onreadystatechange = function () {
            // 数据全部加载完成
            if(xhr.readyState === 4){
                // 判断状态码是否正确
                if(xhr.status >= 200 && xhr.status < 300){
                    // 得到响应体的内容
                    const data = JSON.parse(xhr.responseText);
                    // 得到响应头
                    const headers = xhr.getAllResponseHeaders();
                    // request 即是 xhr
                    const request = xhr;
                    // 状态码
                    const status = xhr.status;
                    // 状态码的说明
                    const statusText = xhr.statusText
                    resolve({
                        config,
                        data,
                        headers,
                        request,
                        status,
                        statusText
                    });
                }else{
                    reject("请求失败"+xhr.status+xhr.statusText);
                }
            }
        }
        // http://127.0.0.1/two?a=1&b=2
        // 判断是否拥有params,且类型为object
        if(typeof config.params === "object"){
            // 将object 转为 urlencoded 
            const arr = Object.keys(config.params);
            const arr2 = arr.map(v=>v+"="+config.params[v]);
            const url = arr2.join("&");
            config.url +=  "?" + url;
        }
        xhr.open(method,config.url);
        // post put patch
        if(method === "POST" || method === "PUT" || method === "PATCH"){
            if(typeof config.data === "object")
                xhr.setRequestHeader("content-type","application/json");
            else if(typeof config.data === "string")
                xhr.setRequestHeader("content-type","application/x-www-form-urlencoded");
            xhr.send(JSON.stringify(config.data));
        }else{
            xhr.send();
        }

    })
}
Axios.prototype.get = function (url,config) {
    return this.request({
        method:"get",
        url,
        ...config
    });
}
Axios.prototype.post = function (url,data) {
    return this.request({
        url,
        method:"post",
        data
    })
}
// 其它请求delete,patch省略
export default new Axios();

这样我们终于可以通过axios.get(url[, config])axios.post(url[, data[, config]])请求数据了。

import axios from "./Axios.js";
axios.post("data.json",{
    a:1,
    b:2
}).then(res=>{
    console.log(res);
})
axios.get("data.json",{
    params:{
        a:1,
        b:2
    }
}).then(res=>{
    console.log(res);
})

但是axios(config)又不行了。

三、createInstance函数

继续攻读源码发现:axios 本质不是Axios构造函数的实例,而是一个函数名字为createInstance的函数对象,在该函数中实例化了Axios。也就是说:我们所使用的axios并不是Axios的实例,而是Axios.prototype.request函数bind()返回的函数。

function createInstance(defaultConfig){
    const context = new Axios(defaultConfig);
    Axios.prototype.request.bind(context);
    // instance 是一个函数。该函数是request,并且将this指向context.
    var instance = Axios.prototype.request.bind(context);// 等同于上面那行代码
    // 将Axios的原型方法放置到instance函数属性中
    Object.keys(Axios.prototype).forEach(method=>{
        instance[method] = Axios.prototype[method].bind(context)
    })
    Object.keys(context).forEach(attr=>{
        instance[attr] = context[attr];
    })
    return instance;
}
export default createInstance;
四、axios实现多种请求方式原理完整代码:
// 构造函数
function Axios(){

}
Axios.prototype.request = function (config) {
    // 将请求方式全部转为大写
    const method = (config.method || "get").toUpperCase();
    // 返回Promise
    return new Promise((resolve,reject)=>{
        // 声明xhr
        const xhr = new XMLHttpRequest();
        // 定义一个onreadystatechange监听事件
        xhr.onreadystatechange = function () {
            // 数据全部加载完成
            if(xhr.readyState === 4){
                // 判断状态码是否正确
                if(xhr.status >= 200 && xhr.status < 300){
                    // 得到响应体的内容
                    const data = JSON.parse(xhr.responseText);
                    // 得到响应头
                    const headers = xhr.getAllResponseHeaders();
                    // request 即是 xhr
                    const request = xhr;
                    // 状态码
                    const status = xhr.status;
                    // 状态码的说明
                    const statusText = xhr.statusText
                    resolve({
                        config,
                        data,
                        headers,
                        request,
                        status,
                        statusText
                    });
                }else{
                    reject("请求失败"+xhr.status+xhr.statusText);
                }
            }
        }
        // http://127.0.0.1/two?a=1&b=2
        // 判断是否拥有params,且类型为object
        if(typeof config.params === "object"){
            // 将object 转为 urlencoded
            const arr = Object.keys(config.params);
            const arr2 = arr.map(v=>v+"="+config.params[v]);
            const url = arr2.join("&");
            config.url +=  "?" + url;
        }
        xhr.open(method,config.url);
        // post put patch
        if(method === "POST" || method === "PUT" || method === "PATCH"){
            if(typeof config.data === "object")
                xhr.setRequestHeader("content-type","application/json");
            else if(typeof config.data === "string")
                xhr.setRequestHeader("content-type","application/x-www-form-urlencoded");
            xhr.send(JSON.stringify(config.data));
        }else{
            xhr.send();
        }

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