axios源码解析-默认配置

我们看过混合配置mergeConfig.js这个文件后,我们发现了配置的优先级是从default,实例配置,config依次增加的,那么,我们现在来看一看default.js这个文件中是如何配置axios的默认配置的
这个文件首先在头部定义了一个表示默认Content-Type的常量:

var DEFAULT_CONTENT_TYPE = {
    // 默认url编码格式,以表单的形式提交
    'Content-Type': 'application/x-www-form-urlencoded'
};

还有一个设置默认请求头的函数,在后面多次调用,说明在不同情况下,axios的默认请求头是不同的。

// 设置请求头
function setContentTypeIfUnset(headers, value) {
    // 存在请求头参数且没有设置'Content-Type'就会设置成对应值
    if (!utils.isUndefined(headers) && utils.isUndefined(headers['Content-Type'])) {
        headers['Content-Type'] = value;
    }
}

以及还有一个关于适配器的函数,用于判断不同的运行环境,来调用不同的网络请求封装,web环境下封装AJAX,node环境封装HTTP

function getDefaultAdapter() {
    var adapter;
    // 通过是否存在XMLHttpRequest 对象判断是否在浏览器环境
    if (typeof XMLHttpRequest !== 'undefined') {
        // For browsers use XHR adapter
        adapter = require('./adapters/xhr');
        // 通过node的process参数判断是否为node环境
    } else if (typeof process !== 'undefined' && Object.prototype.toString.call(process) === '[object process]') {
        // For node use HTTP adapter
        adapter = require('./adapters/http');
    }
    return adapter;
}

然后是default.js的核心部分,他定义了一个对象defalut,在这个对象内部进行处理,最后返回这个对象
在这个对象中,首先定义了一个对象来决定转化JSON的配置和对超时错误的配置

   transitional: {
        // 对转化JSON的配置
        silentJSONParsing: true,
        forcedJSONParsing: true,
        clarifyTimeoutError: false
    },

之后返回适配器,也就是执行网络请求的函数

  adapter: getDefaultAdapter(),

然后是对请求和响应数据处理的函数transfrom的默认配置,先看请求数据的transfrom:

 transformRequest: [function transformRequest(data, headers) {
  // 对请求头参数的写法进行标准化,防止不规范的写法导致请求不成功
        normalizeHeaderName(headers, 'Accept');
        normalizeHeaderName(headers, 'Content-Type');
        // 对一般的数据类型直接返回
        if (utils.isFormData(data) ||
            utils.isArrayBuffer(data) ||
            utils.isBuffer(data) ||
            utils.isStream(data) ||
            utils.isFile(data) ||
            utils.isBlob(data)
        ) {
            return data;
        }
        // 对于一些特殊格式的数据进行处理,确保他们被转化成服务器可以识别的格式
        // 下面两种仅node环境,用buffer和流的形式传输数据
        if (utils.isArrayBufferView(data)) {
            return data.buffer;
        }
        if (utils.isURLSearchParams(data)) {
            setContentTypeIfUnset(headers, 'application/x-www-form-urlencoded;charset=utf-8');
            return data.toString();
        }
        // 遇到json请求头先尝试着转化为JSON,可以尝试设置为application/json的数据转化为json格式并自动添加请求头
        if (utils.isObject(data) || (headers && headers['Content-Type'] === 'application/json')) {
            setContentTypeIfUnset(headers, 'application/json');
            return JSON.stringify(data);
        }
        return data;
    }],

然后是对于响应时tranfrom的默认设置,尝试根据之前的配置将服务器返回的数据转化为JSON对象

    // 响应拦截器默认尝试将数据转化为JSON对象
    transformResponse: [function transformResponse(data) {
        var transitional = this.transitional;
        var silentJSONParsing = transitional && transitional.silentJSONParsing;
        var forcedJSONParsing = transitional && transitional.forcedJSONParsing;
        var strictJSONParsing = !silentJSONParsing && this.responseType === 'json';
        // 如果发送出去的数字为字符串类型,尝试着转化为JSON类型,
        // 这里要根据上面设置的JSON转化的强度判定,默认强制转化
        if (strictJSONParsing || (forcedJSONParsing && utils.isString(data) && data.length)) {
            try {
                // 尝试将数据转化成JSON对象
                return JSON.parse(data);
            } catch (e) {
                // 当响应类型为JSON但无法转化为JSON对象时,会抛出错误
                if (strictJSONParsing) {
                    if (e.name === 'SyntaxError') {
                        throw enhanceError(e, this, 'E_JSON_PARSE');
                    }
                    throw e;
                }
            }
        }

        return data;
    }],

这里我们可以看出来,即使我们发送给浏览器,或者浏览器返回给我们的数据不是严格的JSON形式,只要他们是一个对象/字符串,axios就会尝试将他们转化为JSON对象或JSON字符串进行数据交换,对于我们写法不规范的请求头参数,axios也对其进行了处理,保证参数的规范
之后定义的是一些参数的默认值,这里要注意的是validateStatus也是可以自定义的,我们可以通过业务的需求去定义表示成功的状态码范围

 timeout: 0,

    // `xsrfCookieName` 是 xsrf token 的值,被用作 cookie 的名称
    xsrfCookieName: 'XSRF-TOKEN',
    // `xsrfHeaderName` 是带有 xsrf token 值的http 请求头名称
    xsrfHeaderName: 'X-XSRF-TOKEN',
    // 下面两个配置默认不限制
    // 定义了node.js中允许的HTTP响应内容的最大字节数
    maxContentLength: -1,
    // `maxBodyLength`(仅Node)定义允许的http请求内容的最大字节数
    maxBodyLength: -1,
    // 默认对返回的请求码的处理,默认在200-300间为成功
    validateStatus: function validateStatus(status) {
        return status >= 200 && status < 300;
    }
};
// 默认为JSON请求头,以文本形式返回
defaults.headers = {
    common: {
        'Accept': 'application/json, text/plain, */*'
    }
};

最后,使用工具函数批量给一些方法添加默认的Content-Type,并暴露出defaults

utils.forEach(['delete', 'get', 'head'], function forEachMethodNoData(method) {
    defaults.headers[method] = {};
});
// 默认返回的内容编码类型为url编码
utils.forEach(['post', 'put', 'patch'], function forEachMethodWithData(method) {
    defaults.headers[method] = utils.merge(DEFAULT_CONTENT_TYPE);
});

module.exports = defaults;
  • 2
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值