axios源码中的10多个工具函数，值得一学~

发表于 2年以前 | 总阅读数：2190 次

1 .前言

歌德说过：读一本好书，就是在和高尚的人谈话。

同理，读优秀的开源项目的源码，就是在和牛逼的大佬交流。

之前总觉得阅读源码是一件了不起的事情，是只有大佬才会去做的事。其实源码也不是想象的那么难，至少有很多看得懂。 比如源码中的工具函数，就算是初级的前端开发也是能够看懂的。重要的是，要迈出这一步，阅读源码没什么的。

阅读本文，你将学到：

1、javascript、nodejs调试技巧及调试工具；
2、如何学习调试axios源码；
3、如何学习优秀开源项目的代码，应用到自己的项目；
4、axios源码中实用的工具函数；

2 .环境准备

2.1 读开源项目的贡献指南

打开 axios[1] , 你会惊奇的发现，这不是在浏览器中打开了一个vscode吗？你没有看错，确实是在浏览器中打开了vscode,而且还打开了axios的源码。如果你仔细看了浏览器地址栏里的url, 你会发现github后多了1s,顾名思义，就是1s打开github上的项目。一个小扩展：在每一个github项目中的url里直接加上1s,就能在网页版vscode中查看源码了（不过貌似现在只能查看，不能调试，调试的话还是要把源码clone到本地）。

开源项目一般能在根目录下的README.md文件或CONTRIBUTING.md中找到贡献指南。贡献指南中说明了参与贡献代码的一些注意事项，比如：代码风格、代码提交注释格式、开发、调试等。

打开CONTRIBUTING.md[2]，可以看到在54行的内容：

Running sandbox in browser

```bash
$ npm start
# Open 127.0.0.1:3000

这里就是告诉我们在如何在浏览器中运行项目的。

2.2 克隆项目并运行

这里使用axios的版本是v0.24.0;

git clone https://github.com/axios/axios.git

cd axios

npm start

打开 http://localhost:3000/

这时候可以看到这么一个页面：

image.png

打开浏览器的控制台，选中source选项，然后在axios目录中可以找到源码，如下图：

image.png

这个axios.js就是入口文件，这时候就可以随意打断点进行调试了。

其实，阅读所有源码的流程都类似，之所以说的这么详细，是为了能够让没有阅读过源码的同学也能够跟着一步一步的阅读起来。当你读完之后，肯定会有不少的收获，把这个过程和收获记录下来，慢慢的提升自己，早晚会成为大佬。

3 . 工具函数

今天的主角是utils.js[3]文件, 以下列出了文件中的工具函数：

3.1 `isArray` 判断数组

var toString = Object.prototype.toString;

// 可以通过 `toString()` 来获取每个对象的类型
// 一般返回值是 Boolean 类型的函数，命名都以 is 开头
function isArray(val) {
  return toString.call(val) === '[object Array]';
}

3.2 `isUndefined` 判断`Undefined`

// 直接用`typeof`判断
// 注意 typeof null === 'object'
function isUndefined(val) {
  return typeof val === 'undefined';
}

3.3 `isBuffer` 判断 `buffer`

// 先判断不是 `undefined`和`null`
// 再判断 `val`存在构造函数，因为`Buffer`本身是一个类
// 最后通过自身的`isBuffer`方法判断

function isBuffer(val) {
  return val !== null 
          && !isUndefined(val) 
          && val.constructor !== null 
          && !isUndefined(val.constructor)
          && typeof val.constructor.isBuffer === 'function' 
          && val.constructor.isBuffer(val);
}

什么是Buffer?

JavaScript 语言自身只有字符串数据类型，没有二进制数据类型。

但在处理像TCP流或文件流时，必须使用到二进制数据。因此在 Node.js中，定义了一个Buffer 类，该类用来创建一个专门存放二进制数据的缓存区。详细可以看官方文档[4] 或更通俗易懂的解释[5]。

因为axios可以运行在浏览器和node环境中，所以内部会用到nodejs相关的知识。

3.4 `isFormData` 判断`FormData`

// `instanceof` 运算符用于检测构造函数的 `prototype` 属性是否出现在某个实例对象的原型链上

function isFormData(val) {
  return (typeof FormData !== 'undefined') && (val instanceof FormData);
}


// instanceof 用法

function C() {}
function D() {}

const c = new C()

c instanceof C // output: true   因为 Object.getPrototypeOf(c) === C.prototype

c instanceof Object // output: true   因为 Object.prototype.isPrototypeOf(c)

c instanceof D // output: false   因为 D.prototype 不在 c 的原型链上

3.5 `isObject` 判断对象

// `instanceof` 运算符用于检测构造函数的 `prototype` 属性是否出现在某个实例对象的原型链上

function isFormData(val) {
  return (typeof FormData !== 'undefined') && (val instanceof FormData);
}


// instanceof 用法

function C() {}
function D() {}

const c = new C()

c instanceof C // output: true   因为 Object.getPrototypeOf(c) === C.prototype

c instanceof Object // output: true   因为 Object.prototype.isPrototypeOf(c)

c instanceof D // output: false   因为 D.prototype 不在 c 的原型链上

3.6 `isPlainObject` 判断纯对象

纯对象：用{}或new Object()创建的对象。

function isPlainObject(val) {
  if (Object.prototype.toString.call(val) !== '[object Object]') {
    return false;
  }

  var prototype = Object.getPrototypeOf(val);
  return prototype === null || prototype === Object.prototype;
}


// 例子1
const o = {name: 'jay}
isPlainObject(o) // true

// 例子2
const o = new Object()
o.name = 'jay'
isPlainObject(o)   // true

// 例子3
function C() {}
const c = new C()
isPlainObject(c);  // false

// 其实就是判断目标对象的原型是不是`null` 或 `Object.prototype`

3.7 `isDate` 判断`Date`

function isDate(val) {
  return Object.prototype.toString.call(val) === '[object Date]';
}

3.8 `isFile` 判断文件类型

function isFile(val) {
  return Object.prototype.toString.call(val) === '[object File]';
}

3.9 `isBlob` 判断`Blob`

function isBlob(val) {
  return Object.prototype.toString.call(val) === '[object Blob]';
}

Blob 对象表示一个不可变、原始数据的类文件对象。它的数据可以按文本或二进制的格式进行读取。

3.10 `isFunction` 判断函数

function isFunction(val) {
  return Object.prototype.toString.call(val) === '[object Function]';
}

3.11 `isStream` 判断是否是流

// 这里`isObject`、`isFunction`为上文提到的方法
function isStream(val) {
  return isObject(val) && isFunction(val.pipe);
}

3.12 `isURLSearchParams` 判断`URLSearchParams`

function isURLSearchParams(val) {
  return typeof URLSearchParams !== 'undefined' && val instanceof URLSearchParams;
}


// 例子
const paramsString = "q=URLUtils.searchParams&topic=api"
const searchParams = new URLSearchParams(paramsString);
isURLSearchParams(searchParams) // true

URLSearchParams 接口定义了一些实用的方法来处理 URL 的查询字符串，详情可看 MDN[6]：

var paramsString = "q=URLUtils.searchParams&topic=api"
var searchParams = new URLSearchParams(paramsString);

for (let p of searchParams) {
  console.log(p);
}

// 输出 
[ 'q', 'URLUtils.searchParams' ]
[ 'topic', 'api' ]

searchParams.has("topic") === true; // true
searchParams.get("topic") === "api"; // true
searchParams.getAll("topic"); // ["api"]
searchParams.get("foo") === null; // true
searchParams.append("topic", "webdev");
searchParams.toString(); // "q=URLUtils.searchParams&topic=api&topic=webdev"
searchParams.set("topic", "More webdev");
searchParams.toString(); // "q=URLUtils.searchParams&topic=More+webdev"
searchParams.delete("topic");
searchParams.toString(); // "q=URLUtils.searchParams"

3.13 `trim` 去除首尾空格

// `trim`方法不存在的话，用正则
function trim(str) {
  return str.trim ? str.trim() : str.replace(/^\s+|\s+$/g, '');
}

3.14 `isStandardBrowserEnv` 判断标准浏览器环境

function isStandardBrowserEnv() {
  if (typeof navigator !== 'undefined' && (navigator.product === 'ReactNative' ||
                                           navigator.product === 'NativeScript' ||
                                           navigator.product === 'NS')) {
    return false;
  }
  return (
    typeof window !== 'undefined' &&
    typeof document !== 'undefined'
  );
}

但是官方已经不推荐使用这个属性navigator.product。

image.png

3.15 `forEach` 遍历对象或数组

保留了英文注释，提升大家的英文阅读能力。

/**
 * Iterate over an Array or an Object invoking a function for each item.
 *  用一个函数去迭代数组或对象
 *
 * If `obj` is an Array callback will be called passing
 * the value, index, and complete array for each item.
 * 如果是数组，回调将会调用value, index, 和整个数组
 *
 * If 'obj' is an Object callback will be called passing
 * the value, key, and complete object for each property.
 * 如果是对象，回调将会调用value, key, 和整个对象
 *
 * @param {Object|Array} obj The object to iterate
 * @param {Function} fn The callback to invoke for each item
 */

function forEach(obj, fn) {
  // Don't bother if no value provided
  // 如果值不存在，无需处理
  if (obj === null || typeof obj === 'undefined') {
    return;
  }

  // Force an array if not already something iterable
  // 如果不是对象类型，强制转成数组类型
  if (typeof obj !== 'object') {
    obj = [obj];
  }

  if (isArray(obj)) {
    // Iterate over array values
    // 是数组，for循环执行回调fn
    for (var i = 0, l = obj.length; i < l; i++) {
      fn.call(null, obj[i], i, obj);
    }
  } else {
    // Iterate over object keys
    // 是对象，for循环执行回调fn
    for (var key in obj) {
       // 只遍历可枚举属性
      if (Object.prototype.hasOwnProperty.call(obj, key)) {
        fn.call(null, obj[key], key, obj);
      }
    }
  }
}

所以，源码为什么不用forEach和for...in...呢？？？？？？？

3.16 `stripBOM`删除`UTF-8`编码中`BOM`

/**
 * Remove byte order marker. This catches EF BB BF (the UTF-8 BOM)
 *
 * @param {string} content with BOM
 * @return {string} content value without BOM
 */

function stripBOM(content) {
  if (content.charCodeAt(0) === 0xFEFF) {
    content = content.slice(1);
  }
  return content;
}

所谓 BOM，全称是Byte Order Mark，它是一个Unicode字符，通常出现在文本的开头，用来标识字节序。UTF-8主要的优点是可以兼容ASCII，但如果使用BOM的话，这个好处就荡然无存了。