本文主要讲述如何根据 Promises/A+ 规范，一步步手写一个 Promise 的 polyfill，代码中会配上对应的规范解释。
1. 定义需要的常量和工具方法
// 1. 定义表示promsie状态的常量
const PENDING_STATE = "pending";
const FULFILLED_STATE = "fulfilled";
const REJECTED_STATE = "rejected";
// 2. 定义可复用的工具方法
const isFunction = function(fun) {
return typeof fun === "function";
};
const isObject = function(value) {
return value && typeof value === "object";
};
2. Promsie 构造函数
Promsie 构造函数内部，主要做 5 件事儿：
function Promise(fun) {
// 1. 基本的判断: 判断 Promsie 构造函数是否是通过 new 调用，以及调用时传入的参数 fn 是否是一个函数；
// 2. 定义 promise 实例的基本属性；
// 3. 定义 resolve 方法；
// 4. 定义 reject 方法；
// 5. 执行 fun 函数；
}
2.1 基本的判断
function Promise(fun) {
// 1. 基本的判断
// 1.1 判断是否是通过new调用
if (!this || this.constructor !== Promise) {
throw new TypeError("Promise must be called with new");
}
// 1.2 判断参数fun是否是一个函数
if (!isFunction(fun)) {
throw new TypeError("Promise constructor's argument must be a function");
}
// ...
}
2.2 定义 promise 实例的基本属性
function Promise(fun) {
// ...
// 2. 定义基本属性
this.state = PENDING_STATE; // promise实例的状态
this.value = void 0; // promise的决议值
// Promises/A+：2.2.6 一个promise实例，可能会调用多次then函数，所以需要一个数组保存then中注册的回调并记录其调用顺序
this.onFulfilledCallbacks = []; // 保存完成回调
this.onRejectedCallbacks = []; // 保存拒绝回调
// ...
}
2.3 定义 resolve 方法
function Promise(fun) {
// ...
// 3. 定义resolve方法
const resolve = (value) => {
resolutionProcedure(this, value);
};
// 主要执行Promise的决议逻辑
const resolutionProcedure = function(promise, x) {
// ...
};
// ...
}
2.3.1 Promise 的决议逻辑
Promise 的决议逻辑是 Promise 的一大重点，也是一大难点，把这个逻辑搞清楚了，手写 Promise 就成功一半了。Promise 的决议函数 resolutionProcedure 接收 2 个参数，第一个参数是需要决议的promise实例，第二个参数是决议值，即调用resolve(x)的时候传进去的参数x。Promise 的决议程序主要做了 4 件事：
- 判断 x 和 promise 是否指向同一个对象；
- 判断 x 是否是一个 promise 实例；
- 判断是否是 thenable；
- x 为其他 js 基础值，且未决议，则直接决议；
function Promise(fun) {
// ...
const resolutionProcedure = function(promise, x) {
// 3.1 判断 x 和 promise 是否指向同一个对象
// Promises/A+：2.3.1 如果promise和x引用相同的对象，则抛出一个TypeError为原因拒绝promise。
if (x === promise) {
return reject(new TypeError("Promise can not resolved with it seft"));
}
// 3.2 判断x是否是promise
// Promises/A+：2.3.2 如果x是一个promise，则直接采用它的决议值进行决议
if (x instanceof Promise) {
return x.then(resolve, reject);
}
// 3.3 判断是否是thenable
// Promises/A+：2.3.3 如果x是一个对象或函数：
if (isObject(x) || isFunction(x)) {
let called = false;
try {
/**
* Promises/A+：
* 2.3.3.1 Let then be x.then；
* 2.3.3.2 如果检索属性x.then导致抛出异常error，则以error为原因拒绝promise；
*/
// 这里要注意：在规范中有规定检索属性x.then导致抛出异常error的情况处理，以及
// 在插件promises-aplus-tests的用例中，也有检索属性x.then的时候直接抛出异常的情况，
// 所以，这里的检索then属性，必须写在try的内部，才能捕获异常。
let then = x.then;
if (isFunction(then)) {
/**
* Promises/A+：
* 2.3.3.3 如果then是一个函数，则用x调用它；第一个参数是 resolvePromise，第二个参数是 rejectPromise；
* 2.3.3.3.3 如果同时调用 resolvePromise 和 rejectPromise，或者多次调用同一个参数，则第一个调用具有优先权，后续的调用将被忽略。（所以需要使用 called 进行控制）
*/
then.call(
x,
(y) => {
if (called) {
return;
}
called = true;
// Promises/A+：2.3.3.3.1 如果使用一个值y调用了resolvePromise，则执行[[Resolve]](promise, y)，即我们写的 resolutionProcedure(promise, y);
resolutionProcedure(promise, y);
},
(error) => {
if (called) {
return;
}
called = true;
// Promises/A+：2.3.3.3.2 如果使用一个reason调用了rejectPromise，则以这个reason直接拒绝promise;
reject(error);
}
);
return;
}
} catch (error) {
/**
* Promises/A+：
* 2.3.3.3.4 如果调用then函数抛出一个异常：
* 2.3.3.3.4.1 如果 resolvePromise 或 rejectPromise 被调用，则忽略它。
* 2.3.3.3.4.2 否则，以error为理由拒绝promise。
*/
if (called) {
return;
}
called = true;
reject(error);
}
}
// 3.4 x为其他js基础值，且未决议，则直接决议
/**
* Promises/A+：
* 2.3.3.4 如果then不是一个函数，则用x完成promise；
* 2.3.4 如果x不是对象或函数，则用x完成promise；
* 2.1 Promise的决议状态是不能变的，一旦决议了，就不能再进行决议，所以这里要先判断promise是否已经决议
*/
if (promise.state === PENDING_STATE) {
promise.state = FULFILLED_STATE;
promise.value = x;
/**
* Promises/A+：
* 2.2.2.3 onFulfilled函数不允许执行超过一次，即最多只能执行一次
* (决议之后，立即执行保存的回调。因为promise只能决议一次，所以，保存的回调也正好只能执行一次)
* 2.2.6.1 所有的onFulfilled回调，必须按照注册的顺序执行
*/
promise.onFulfilledCallbacks.forEach((callback) => callback());
}
};
// ...
}
2.4 定义 reject 方法
function Promise(fun) {
// ...
// 4. 定义reject方法（reject方法不会解析接收到的值，接收到啥值就直接拿该值作为拒绝的理由）
const reject = (reason) => {
if (this.state === PENDING_STATE) {
this.state = REJECTED_STATE;
this.value = reason;
/**
* Promises/A+：
* 2.2.3.3 onRejected不允许执行超过一次，即最多只能执行一次。
* (决议之后，立即执行保存的回调。因为promise只能决议一次，所以，保存的回调也正好只能执行一次)
* 2.2.6.2 所有的onRejected回调，必须按照注册的顺序执行
*/
this.onRejectedCallbacks.forEach((callback) => callback());
}
};
// ...
}
2.5 执行 fun 函数
function Promise(fun) {
// ...
// 5. 执行fun函数
try {
fun(resolve, reject);
} catch (error) {
// 这里需要捕获fun函数执行过程中可能出现的错误；如果fun函数执行出错，则直接拒绝promise。
reject(error);
}
// ...
}
至此，Promise 构造函数就算完成了，接下来我们来看 Promise 的另一个重头戏：then。
3. Promise.prototype.then
为什么把 then 单独从原型方法中拎出来，主要还是因为他是除了 Promise 决议逻辑之外的另一个重难点，所以想单独讲解。
从大的方面来说，then方法中主要做了 2 件事：
-
处理 onFulfilled 或者 onRejected 不是函数的情况；
-
创建并返回一个新的 promise 实例;
-
2.1 包装 onFulfilled 和 onRejected 为异步函数
-
2.2 判断当前的 promise 状态，决定如何处理传入的回到函数：
-
2.2.1 若为 fulfilled，则执行 onFulfilled；
-
2.2.2 若为 rejected，则执行 onRejected；
-
2.2.3 如果 promise 未决议，则将回调保存在 onFulfilledCallbacks 和 onRejectedCallbacks 中，待 promise 决议之后再执行对应回调；
-
3.1 处理 onFulfilled 或者 onRejected 不是函数的情况
Promise.prototype.then = function(onFulfilled, onRejected) {
// 1. 处理onFulfilled或者onRejected不是函数的情况
// Promises/A+：2.2.1 onFulfilled 和 onRejected都是可选的，如果他们不是函数，就会被忽略。
// Promises/A+：2.2.7.3 如果onFulfilled不是函数，而promise1已经是fulfilled，
// 则promise2必须用promise1的决议值进行决议，所以这里需要添加 (value) => value 直接返回promise1的决议值
onFulfilled = isFunction(onFulfilled) ? onFulfilled : (value) => value;
// Promises/A+：2.2.7.4 如果onRejected不是函数，而promise1已经是rejected，
// 则promise2必须用promise1拒绝的reason进行拒绝，所以这里需要添加 throw error;
onRejected = isFunction(onRejected)
? onRejected
: (error) => {
throw error;
};
// ...
};
3.2 创建并返回一个新的 promise 实例
Promise.prototype.then = function(onFulfilled, onRejected) {
// ...
// 2. 创建并返回一个新的 promise 实例;
// Promises/A+：2.2.7 then函数必须返回一个promise实例;
return new Promise((resolve, reject) => {
// 2.1 包装onFulfilled和onRejected为异步函数
let wrapOnFulfilled = () => {
setTimeout(() => {
try {
// Promises/A+：2.2.5 onFulfilled和onRejected都必须作为函数调用（采用默认调用方式，而非call、apply或者属性的方式）
let x = onFulfilled(this.value);
// Promises/A+：2.2.7.1 如果onFulfilled或onRejected返回一个合法值x，就执行Promise决议过程，而非拒绝
resolve(x);
} catch (error) {
//Promises/A+：2.2.7.2 如果onFulfilled或onRejected抛出一个error，就利用error作为reson执行拒绝操作
reject(error);
}
}, 0);
};
let wrapOnRejected = () => {
setTimeout(() => {
try {
// Promises/A+：2.2.5 onFulfilled和onRejected都必须作为函数调用（采用默认调用方式，而非call、apply或者属性的方式）
let x = onRejected(this.value);
// Promises/A+：2.2.7.1 如果onFulfilled或onRejected返回一个合法值x，就执行Promise决议过程，而非拒绝
resolve(x);
} catch (error) {
// Promises/A+：2.2.7.2 如果onFulfilled或onRejected抛出一个error，就利用error作为reson执行拒绝操作
reject(error);
}
}, 0);
};
// 2.2 判断状态
// Promises/A+：2.2.2 和 2.2.3 onFulfilled 和 onRejected 都只能在promise被决议之后执行
// 2.2.1 若为fulfilled，则执行onFulfilled
if (this.state === FULFILLED_STATE) {
wrapOnFulfilled();
} else if (this.state === REJECTED_STATE) {
// 2.2.2 若为rejected，则执行onRejected
wrapOnRejected();
} else {
// 2.2.3 如果promise未决议，则将回调保存在onFulfilledCallbacks和onRejectedCallbacks中，待promise决议之后再执行对应回调；
this.onFulfilledCallbacks.push(wrapOnFulfilled);
this.onRejectedCallbacks.push(wrapOnRejected);
}
});
};
4. 其他原型方法
4.1 Promise.prototype.catch
Promise.prototype.catch = function(callback) {
return this.then(null, callback);
};
4.2 Promise.prototype.finally
// 无论promise成功或失败，finally方法都会执行接收到的回调函数，并返回一个promise实例：
// 1. 如果回调函数执行出错，将以抛出的错误，拒绝新的promise；
// 2. 否则，新返回的promise会沿用旧promise的决议值进行决议。
Promise.prototype.finally = function(callback) {
return this.then(
(data) => {
callback();
return data;
},
(error) => {
callback();
throw error;
}
);
};
5. 静态方法
5.1 Promise.resolve
// 如果Promise.resolve接收到的是一个promise，则会直接返回这个promise；否则，则会进一步执行决议操作。
Promise.resolve = function(value) {
return value instanceof Promise
? value
: new Promise((resolve) => resolve(value));
};
5.2 Promise.reject
// Promise.reject无论接收到什么，都会直接以接收到的值作为拒绝理由，而不会像resolve一样进行拆解。
Promise.reject = function(reason) {
return new Promise((resolve, reject) => reject(reason));
};
5.3 Promise.race
// 需要注意的是，如果Promise.race接收到的是一个空数组([])，则会一直挂起，而不是立即决议。
Promise.race = function(promises) {
return new Promise((resolve, reject) => {
promises.forEach((promise) => {
Promise.resolve(promise).then(resolve, reject);
});
});
};
5.4 Promise.all
Promise.all = function(promises) {
return new Promise((resolve, reject) => {
// 如果Promise.all接收到的是一个空数组([])，它会立即决议。
if (!promises.length) {
resolve([]);
}
let result = [];
let resolvedPro = 0;
for (let index = 0, length = promises.length; index < length; index++) {
Promise.resolve(promises[index]).then(
(data) => {
// 注意，这里要用index赋值，而不是push。因为要保持返回值和接收到的promise的位置一致性。
result[index] = data;
if (++resolvedPro === length) {
resolve(result);
}
},
(error) => {
reject(error);
}
);
}
});
};
5.5 Promise.allSettled
// Promise.allSettled 返回一个在所有给定的promise都已经fulfilled或rejected后的promise，
// 并带有一个对象数组，每个对象表示对应的promise结果。
Promise.allSettled = function(promises) {
return new Promise((resolve, reject) => {
if (!promises.length) {
resolve([]);
}
let result = [];
let resolvedPro = 0;
for (let index = 0, length = promises.length; index < length; index++) {
Promise.resolve(promises[index])
.then((data) => {
// 注意，这里要用index赋值，而不是push。因为要保持返回值和接收到的promise的位置一致性。
result[index] = {
status: FULFILLED_STATE,
value: data,
};
if (++resolvedPro === length) {
resolve(result);
}
})
.catch((error) => {
result[index] = {
status: REJECTED_STATE,
reason: error,
};
if (++resolvedPro === length) {
resolve(result);
}
});
}
});
};
至此，手写一个 Promise 就算完成了，此 Promise 完全按照 Promise/A+ 的要求写的，也全部通过了promises-aplus-tests的 872 个测试用例。如果您还发现有什么欠缺的地方，欢迎指正；如果觉得对您有用，也请点个赞哦。
代码 github 地址: [github.com/ydiguo/Prom…]
Promises/A+ 规范（译本）: [juejin.cn/post/691047…]
常见问题FAQ
- 免费下载或者VIP会员专享资源能否直接商用？
- 本站所有资源版权均属于原作者所有，这里所提供资源均只能用于参考学习用，请勿直接商用。若由于商用引起版权纠纷，一切责任均由使用者承担。更多说明请参考 VIP介绍。
- 提示下载完但解压或打开不了？
- 找不到素材资源介绍文章里的示例图片？
- 模板不会安装或需要功能定制以及二次开发？
发表评论
还没有评论，快来抢沙发吧！