Promise 对象
# Promise 对象
# 1. Promise 的含义
Promise
是一种用于处理异步编程的解决方案,比传统的回调函数和事件驱动的方式更为合理和强大。它由社区最早提出并实现,随后被纳入 ES6 标准,成为 JavaScript 语言的一部分。
什么是 Promise?
Promise
是一个对象,它代表了一个未来可能完成(或失败)的事件,并提供了一种获取该事件结果的方法。它的主要目的是让异步操作的处理更为简洁和统一。
Promise 的特点
Promise
对象有以下两个显著特点:
对象的状态不受外界影响:
Promise
对象代表一个异步操作,有三种状态:pending
(进行中)fulfilled
(已成功)rejected
(已失败)
只有异步操作的结果能够决定当前状态,任何其他操作都无法改变这一状态。这意味着一旦
Promise
的状态发生改变,无论外界如何操作,它的状态都不会再变化。这也是Promise
名字的由来,表示一种承诺,不能被其他手段更改。一旦状态改变,就不会再变,任何时候都可以得到这个结果:
Promise
对象的状态一旦从pending
变为fulfilled
或rejected
,就会保持这个结果,称为已定型(resolved)。之后,任何时候对Promise
添加回调函数,都能得到同样的结果。这与事件(Event)机制不同,事件如果错过了,再去监听是得不到结果的。
Promise 的优点
有了 Promise
对象,就可以将异步操作以同步操作的流程表达出来,避免了层层嵌套的回调函数。此外,Promise
提供统一的接口,使得控制异步操作更加容易。
Promise 的缺点
尽管 Promise
强大而灵活,但它也有一些缺点:
无法取消
Promise
: 一旦创建了Promise
,它就会立即执行,无法中途取消。内部错误不反映到外部: 如果不设置回调函数,
Promise
内部抛出的错误不会传递到外部。无法得知进行中的状态: 当
Promise
处于pending
状态时,无法得知它目前的进展情况(刚开始还是即将完成)。
代码示例
下面是一个使用 Promise
的简单示例,演示了如何处理异步操作:
// 创建一个新的 Promise 实例
let promise = new Promise((resolve, reject) => {
// 模拟异步操作
setTimeout(() => {
let success = true; // 假设操作成功
if (success) {
resolve("操作成功!");
} else {
reject("操作失败!");
}
}, 1000);
});
// 使用 then 方法处理成功和失败的情况
promise.then(
result => {
console.log(result); // 输出 "操作成功!"
},
error => {
console.error(error); // 输出 "操作失败!"
}
);
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
# 2. 基本用法
ES6 规定,Promise
对象是一个构造函数,用来生成Promise
实例。
下面代码创建了一个Promise
实例。
const promise = new Promise(function(resolve, reject) {
// ... some code
if (/* 异步操作成功 */){
resolve(value);
} else {
reject(error);
}
});
2
3
4
5
6
7
8
9
Promise
构造函数接受一个函数作为参数,该函数的两个参数分别是resolve
和reject
。它们是两个函数,由 JavaScript 引擎提供,不用自己部署。
resolve
函数的作用是,将Promise
对象的状态从“未完成”变为“成功”(即从 pending 变为 resolved),在异步操作成功时调用,并将异步操作的结果,作为参数传递出去;reject
函数的作用是,将Promise
对象的状态从“未完成”变为“失败”(即从 pending 变为 rejected),在异步操作失败时调用,并将异步操作报出的错误,作为参数传递出去。
Promise
实例生成以后,可以用then
方法分别指定resolved
状态和rejected
状态的回调函数。
promise.then(function(value) {
// success
}, function(error) {
// failure
});
2
3
4
5
then
方法可以接受两个回调函数作为参数。第一个回调函数是Promise
对象的状态变为resolved
时调用,第二个回调函数是Promise
对象的状态变为rejected
时调用。其中,第二个函数是可选的,不一定要提供。这两个函数都接受Promise
对象传出的值作为参数。
下面是一个Promise
对象的简单例子。
function timeout(ms) {
return new Promise((resolve, reject) => {
setTimeout(resolve, ms, 'done');
});
}
timeout(100).then((value) => {
console.log(value);
});
2
3
4
5
6
7
8
9
上面代码中,timeout
方法返回一个Promise
实例,表示一段时间以后才会发生的结果。过了指定的时间(ms
参数)以后,Promise
实例的状态变为resolved
,就会触发then
方法绑定的回调函数。
Promise 新建后就会立即执行。
let promise = new Promise(function(resolve, reject) {
console.log('Promise');
resolve();
});
promise.then(function() {
console.log('resolved.');
});
console.log('Hi!');
// Promise
// Hi!
// resolved
2
3
4
5
6
7
8
9
10
11
12
13
14
上面代码中,Promise 新建后立即执行,所以首先输出的是Promise
。然后,then
方法指定的回调函数,将在当前脚本所有同步任务执行完才会执行,所以resolved
最后输出。
# 异步加载图片的例子
下面是异步加载图片的例子。
function loadImageAsync(url) {
return new Promise(function(resolve, reject) {
const image = new Image();
image.onload = function() {
resolve(image);
};
image.onerror = function() {
reject(new Error('Could not load image at ' + url));
};
image.src = url;
});
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
上面代码中,使用Promise
包装了一个图片加载的异步操作。如果加载成功,就调用resolve
方法,否则就调用reject
方法。
# Promise 实现的 Ajax 操作
下面是一个用Promise
对象实现的 Ajax 操作的例子。
// 定义一个函数 getJSON,用于从指定的 URL 获取 JSON 数据
const getJSON = function(url) {
// 返回一个新的 Promise 对象
const promise = new Promise(function(resolve, reject){
// 定义一个事件处理函数,当 readyState 变化时会被调用
const handler = function() {
// 如果 readyState 不是 4(请求完成),则直接返回
if (this.readyState !== 4) {
return;
}
// 如果请求状态码是 200(成功),则解析 Promise,返回响应数据
if (this.status === 200) {
resolve(this.response);
} else {
// 否则,拒绝 Promise,返回错误信息
reject(new Error(this.statusText));
}
};
// 创建一个新的 XMLHttpRequest 对象
const client = new XMLHttpRequest();
// 初始化一个 GET 请求
client.open("GET", url);
// 当 readyState 变化时调用 handler 函数
client.onreadystatechange = handler;
// 设置响应类型为 JSON
client.responseType = "json";
// 设置请求头,表示接受 JSON 数据
client.setRequestHeader("Accept", "application/json");
// 发送请求
client.send();
});
// 返回 Promise 对象
return promise;
};
// 调用 getJSON 函数,从 "/posts.json" 获取数据
getJSON("/posts.json").then(function(json) {
// 成功时,打印获取到的 JSON 数据
console.log('Contents: ' + json);
}, function(error) {
// 出错时,打印错误信息
console.error('出错了', error);
});
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
上面代码中,getJSON
是对 XMLHttpRequest
对象的封装,用于发出一个针对 JSON 数据的 HTTP 请求,并且返回一个Promise
对象。需要注意的是,在getJSON
内部,resolve
函数和reject
函数调用时,都带有参数。
# 传递 Promise 实例
如果调用resolve
函数和reject
函数时带有参数,那么它们的参数会被传递给回调函数。reject
函数的参数通常是Error
对象的实例,表示抛出的错误;resolve
函数的参数除了正常的值以外,还可能是另一个 Promise 实例,比如像下面这样。
const p1 = new Promise(function (resolve, reject) {
// ...
});
const p2 = new Promise(function (resolve, reject) {
// ...
resolve(p1);
});
2
3
4
5
6
7
8
上面代码中,p1
和p2
都是 Promise 的实例,但是p2
的resolve
方法将p1
作为参数,即一个异步操作的结果是返回另一个异步操作。
注意,这时p1
的状态就会传递给p2
,也就是说,p1
的状态决定了p2
的状态。如果p1
的状态是pending
,那么p2
的回调函数就会等待p1
的状态改变;如果p1
的状态已经是resolved
或者rejected
,那么p2
的回调函数将会立刻执行。
const p1 = new Promise(function (resolve, reject) {
setTimeout(() => reject(new Error('fail')), 3000);
});
const p2 = new Promise(function (resolve, reject) {
setTimeout(() => resolve(p1), 1000);
});
p2
.then(result => console.log(result))
.catch(error => console.log(error));
// Error: fail
2
3
4
5
6
7
8
9
10
11
12
上面代码中,p1
是一个 Promise,3 秒之后变为rejected
。p2
的状态在 1 秒之后改变,resolve
方法返回的是p1
。由于p2
返回的是另一个 Promise,导致p2
自己的状态无效了,由p1
的状态决定p2
的状态。所以,后面的then
语句都变成针对后者(p1
)。又过了 2 秒,p1
变为rejected
,导致触发catch
方法指定的回调函数。
# 调用 resolve 或 reject 后继续执行
注意,调用resolve
或reject
并不会终结 Promise 的参数函数的执行。
new Promise((resolve, reject) => {
resolve(1);
console.log(2);
}).then(r => {
console.log(r);
});
// 2
// 1
2
3
4
5
6
7
8
上面代码中,调用resolve(1)
以后,后面的console.log(2)
还是会执行,并且会首先打印出来。这是因为立即 resolved 的 Promise 是在本轮事件循环的末尾执行,总是晚于本轮循环的同步任务。
一般来说,调用resolve
或reject
以后,Promise 的使命就完成了,后继操作应该放到then
方法里面,而不应该直接写在resolve
或reject
的后面。所以,最好在它们前面加上return
语句,这样就不会有意外。
new Promise((resolve, reject) => {
return resolve(1);
// 后面的语句不会执行
console.log(2);
});
2
3
4
5
这样可以确保 Promise
在状态变更后不会继续执行后续代码,保持代码的简洁和易读。
# 3. Promise.prototype.then()
Promise
实例具有 then
方法,也就是说,then
方法是定义在原型对象 Promise.prototype
上的。它的作用是为 Promise
实例添加状态改变时的回调函数。前面提到,then
方法的第一个参数是 resolved
状态的回调函数,第二个参数(可选)是 rejected
状态的回调函数。
# 基本用法
then
方法返回的是一个新的 Promise
实例(注意,不是原来那个 Promise
实例)。因此可以采用链式写法,即 then
方法后面再调用另一个 then
方法。
getJSON("/posts.json").then(function(json) {
return json.post;
}).then(function(post) { // 这里的 post 是前面一个 then 返回的参数
// 处理 post
console.log(post);
});
2
3
4
5
6
上面的代码使用 then
方法,依次指定了两个回调函数。第一个回调函数完成以后,会将返回结果作为参数,传入第二个回调函数。
# 链式调用
采用链式的 then
,可以指定一组按照次序调用的回调函数。这时,前一个回调函数,有可能返回的还是一个 Promise
对象(即有异步操作),这时后一个回调函数,就会等待该 Promise
对象的状态发生变化,才会被调用。
getJSON("/post/1.json").then(function(post) {
return getJSON(post.commentURL);
}).then(function(comments) {
console.log("resolved: ", comments);
}, function(err) {
console.log("rejected: ", err);
});
2
3
4
5
6
7
上面代码中,第一个 then
方法指定的回调函数,返回的是另一个 Promise
对象。这时,第二个 then
方法指定的回调函数,就会等待这个新的 Promise
对象状态发生变化。如果变为 resolved
,就调用第一个回调函数,如果状态变为 rejected
,就调用第二个回调函数。
# 使用箭头函数
如果采用箭头函数,上面的代码可以写得更简洁。
getJSON("/post/1.json").then(
post => getJSON(post.commentURL)
).then(
comments => console.log("resolved: ", comments),
err => console.log("rejected: ", err)
);
2
3
4
5
6
# 链式调用的细节
链式调用 then
方法时,每个 then
方法都会返回一个新的 Promise
对象,这样可以实现多个异步操作的顺序执行。
let promise = new Promise(function(resolve, reject) {
resolve(42);
});
promise.then(function(value) {
console.log(value); // 输出 42
return value + 1;
}).then(function(value) {
console.log(value); // 输出 43
return value + 1;
}).then(function(value) {
console.log(value); // 输出 44
});
2
3
4
5
6
7
8
9
10
11
12
13
上面代码中,每个 then
方法的回调函数返回的值,会传递给下一个 then
方法的回调函数。
# 捕获错误
在链式调用中,可以在最后的 then
方法中捕获前面任何一个 then
方法中抛出的错误。
getJSON("/post/1.json").then(function(post) {
return getJSON(post.commentURL);
}).then(function(comments) {
console.log("resolved: ", comments);
}).catch(function(err) {
console.log("rejected: ", err);
});
2
3
4
5
6
7
上面代码中,catch
方法用于捕获前面所有 then
方法中的错误。它是 then(null, rejection)
或者 then(undefined, rejection)
的别名,用于指定发生错误时的回调函数。
# 注意事项
then
方法总是返回一个新的Promise
对象:let promise1 = new Promise((resolve) => resolve('Hello')); let promise2 = promise1.then((value) => value + ' World'); let promise3 = promise2.then((value) => value + '!'); console.log(promise1 !== promise2); // true console.log(promise2 !== promise3); // true
1
2
3
4
5上面代码中,
promise1
、promise2
和promise3
是不同的Promise
对象,尽管它们通过then
方法进行链式调用。then
方法中不返回值的情况: 如果then
方法中的回调函数没有返回值(即返回undefined
),后续then
方法中的回调函数将会接收到undefined
作为参数。let promise = new Promise((resolve) => resolve('Hello')); promise.then((value) => { console.log(value); // 输出 'Hello' // 没有返回值 }).then((value) => { console.log(value); // 输出 'undefined' });
1
2
3
4
5
6
7
8
# 4. Promise.prototype.catch()
Promise.prototype.catch
方法是 .then(null, rejection)
或 .then(undefined, rejection)
的别名,用于指定发生错误时的回调函数。
# 基本用法
getJSON('/posts.json')
.then(function(posts) {
// 处理成功的情况
})
.catch(function(error) {
// 处理 getJSON 和 前一个回调函数运行时发生的错误
console.log('发生错误!', error);
});
2
3
4
5
6
7
8
上面代码中,getJSON
方法返回一个 Promise 对象,如果该对象状态变为 resolved
,则会调用 then
方法指定的回调函数;如果异步操作抛出错误,状态就会变为 rejected
,就会调用 catch
方法指定的回调函数,处理这个错误。另外,then
方法指定的回调函数,如果运行中抛出错误,也会被 catch
方法捕获。
# 等价写法
p.then((val) => console.log('fulfilled:', val))
.catch((err) => console.log('rejected:', err));
// 等同于
p.then((val) => console.log('fulfilled:', val))
.then(null, (err) => console.log('rejected:', err));
2
3
4
5
6
# 简单示例
下面是一个简单的示例,展示了如何使用 catch
方法捕获错误:
const promise = new Promise(function(resolve, reject) {
throw new Error('test'); // 抛出一个错误
});
promise.catch(function(error) {
console.log(error); // 捕获并处理错误
});
// Error: test
2
3
4
5
6
7
8
上面代码中,promise
抛出一个错误,就被 catch
方法指定的回调函数捕获。注意,上面的写法与下面两种写法是等价的。
# 写法一
const promise = new Promise(function(resolve, reject) {
try {
throw new Error('test'); // 抛出一个错误
} catch(e) {
reject(e); // 捕获错误并调用 reject
}
});
promise.catch(function(error) {
console.log(error); // 捕获并处理错误
});
2
3
4
5
6
7
8
9
10
11
# 写法二
const promise = new Promise(function(resolve, reject) {
reject(new Error('test')); // 直接调用 reject
});
promise.catch(function(error) {
console.log(error); // 捕获并处理错误
});
2
3
4
5
6
7
# 错误冒泡
Promise 对象的错误具有“冒泡”性质,会一直向后传递,直到被捕获为止。也就是说,错误总是会被下一个 catch
语句捕获。
getJSON('/post/1.json').then(function(post) {
return getJSON(post.commentURL);
}).then(function(comments) {
// 处理成功的情况
}).catch(function(error) {
// 处理前面所有 Promise 产生的错误
console.log('发生错误!', error);
});
2
3
4
5
6
7
8
上面代码中,一共有三个 Promise 对象:一个由 getJSON
产生,两个由 then
产生。它们之中任何一个抛出的错误,都会被最后一个 catch
捕获。
# 推荐写法
一般来说,不要在 then
方法里面定义 Reject 状态的回调函数(即 then
的第二个参数),总是使用 catch
方法。
// 不推荐的写法
promise
.then(function(data) {
// 成功的处理
}, function(err) {
// 错误的处理
});
// 推荐的写法
promise
.then(function(data) {
// 成功的处理
})
.catch(function(err) {
// 错误的处理
});
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
上面代码中,第二种写法要好于第一种写法,理由是第二种写法可以捕获前面 then
方法执行中的错误,也更接近同步的写法(try/catch
)。因此,建议总是使用 catch
方法,而不使用 then
方法的第二个参数。
# 错误处理的特点
跟传统的 try/catch
代码块不同的是,如果没有使用 catch
方法指定错误处理的回调函数,Promise 对象抛出的错误不会传递到外层代码,即不会有任何反应。
const someAsyncThing = function() {
return new Promise(function(resolve, reject) {
// 下面一行会报错,因为 x 没有声明
resolve(x + 2);
});
};
someAsyncThing().then(function() {
console.log('everything is great');
});
setTimeout(() => { console.log(123) }, 2000);
// Uncaught (in promise) ReferenceError: x is not defined
// 123
2
3
4
5
6
7
8
9
10
11
12
13
14
上面代码中,someAsyncThing
函数产生的 Promise 对象,内部有语法错误。浏览器运行到这一行,会打印出错误提示 ReferenceError: x is not defined
,但是不会退出进程、终止脚本执行,2 秒之后还是会输出 123
。这就是说,Promise 内部的错误不会影响到 Promise 外部的代码。
这个脚本放在服务器执行,退出码就是 0
(即表示执行成功)。不过,Node 有一个 unhandledRejection
事件,专门监听未捕获的 reject
错误,上面的脚本会触发这个事件的监听函数,可以在监听函数里面抛出错误。
process.on('unhandledRejection', function (err, p) {
throw err;
});
2
3
上面代码中,unhandledRejection
事件的监听函数有两个参数,第一个是错误对象,第二个是报错的 Promise 实例,它可以用来了解发生错误的环境信息。
注意,Node 有计划在未来废除 unhandledRejection
事件。如果 Promise 内部有未捕获的错误,会直接终止进程,并且进程的退出码不为 0。
# 异步抛错示例
const promise = new Promise(function(resolve, reject) {
resolve('ok');
setTimeout(function () { throw new Error('test') }, 0)
});
promise.then(function(value) { console.log(value) });
// ok
// Uncaught Error: test
2
3
4
5
6
7
上面代码中,Promise 指定在下一轮“事件循环”再抛出错误。到了那个时候,Promise 的运行已经结束了,所以这个错误是在 Promise 函数体外抛出的,会冒泡到最外层,成了未捕获的错误。
# catch
方法返回新的 Promise 对象
一般总是建议,Promise 对象后面要跟 catch
方法,这样可以处理 Promise 内部发生的错误。catch
方法返回的还是一个 Promise 对象,因此后面还可以接着调用 then
方法。
const someAsyncThing = function() {
return new Promise(function(resolve, reject) {
// 下面一行会报错,因为 x 没有声明
resolve(x + 2);
});
};
someAsyncThing()
.catch(function(error) {
console.log('oh no', error);
})
.then(function() {
console.log('carry on');
});
// oh no [ReferenceError: x is not defined]
// carry on
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
上面代码运行完 catch
方法指定的回调函数,会接着运行后面那个 then
方法指定的回调函数。如果没有报错,则会跳过 catch
方法。
Promise.resolve()
.catch(function(error) {
console.log('oh no', error);
})
.then(function() {
console.log('carry on');
});
// carry on
2
3
4
5
6
7
8
上面的代码因为没有报错,跳过了 catch
方法,直接执行后面的 then
方法。此时,要是 then
方法里面报错,就与前面的 catch
无关了。
# catch
方法中的错误传递
catch
方法之中,还能再抛出错误。
const someAsyncThing = function() {
return new Promise(function(resolve, reject) {
// 下面一行会报错,因为 x 没有声明
resolve(x + 2);
});
};
someAsyncThing()
.then(function() {
return someOtherAsyncThing();
})
.catch(function(error) {
console.log('oh no', error);
// 下面一行会报错,因为 y 没有声明
y + 2;
})
.then(function() {
console.log('carry on');
});
// oh no [ReferenceError: x is not defined]
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
上面代码中,catch
方法抛出一个错误,因为后面没有别的 catch
方法了,导致这个错误不会被捕获,也不会传递到外层。如果改写一下,结果就不一样了。
someAsyncThing()
.then(function() {
return someOtherAsyncThing();
})
.catch(function(error) {
console.log('oh no', error);
// 下面一行会报错,因为 y 没有声明
y + 2;
})
.catch(function(error) {
console.log('carry on', error);
});
// oh no [ReferenceError: x is not defined]
// carry on [ReferenceError: y is not defined]
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
上面代码中,第二个 catch
方法用来捕获前一个 catch
方法抛出的错误。
# 5. Promise.prototype.finally()
finally
方法用于指定不管 Promise 对象最后状态如何,都会执行的操作。该方法是 ES2018 引入标准的。
promise
.then(result => { /* 处理成功结果 */ })
.catch(error => { /* 处理错误结果 */ })
.finally(() => { /* 不管成功还是失败都会执行的代码 */ });
2
3
4
上面代码中,不管promise
最后的状态如何,在执行完then
或catch
指定的回调函数以后,都会执行finally
方法指定的回调函数。
下面是一个例子,服务器使用 Promise 处理请求,然后使用finally
方法关掉服务器。
server.listen(port)
.then(function () {
console.log('Server is listening on port', port);
})
.finally(server.stop); // 不管前面是否成功都会执行 server.stop
2
3
4
5
finally
方法的回调函数不接受任何参数,这意味着没有办法知道,前面的 Promise 状态到底是fulfilled
还是rejected
。这表明,finally
方法里面的操作,应该是与状态无关的,不依赖于 Promise 的执行结果。
finally
本质上是then
方法的特例。
promise
.finally(() => {
// 语句
});
// 等同于
promise
.then(
result => {
// 语句
return result;
},
error => {
// 语句
throw error;
}
);
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
上面代码中,如果不使用finally
方法,同样的语句需要为成功和失败两种情况各写一次。有了finally
方法,则只需要写一次。
# finally方法的实现原理
finally
方法的实现也很简单。
Promise.prototype.finally = function (callback) {
let P = this.constructor;
return this.then(
value => P.resolve(callback()).then(() => value), // 保持成功状态并执行 callback
reason => P.resolve(callback()).then(() => { throw reason }) // 保持失败状态并执行 callback
);
};
2
3
4
5
6
7
上面代码中,不管前面的 Promise 是fulfilled
还是rejected
,都会执行回调函数callback
。
# finally方法会返回原来的值
从上面的实现还可以看到,finally
方法总是会返回原来的值。
// resolve 的值是 undefined
Promise.resolve(2).then(() => {}, () => {})
// resolve 的值是 2
Promise.resolve(2).finally(() => {})
// reject 的值是 undefined
Promise.reject(3).then(() => {}, () => {})
// reject 的值是 3
Promise.reject(3).finally(() => {})
2
3
4
5
6
7
8
9
10
11
上面代码展示了finally
方法的执行不会改变 Promise 的值,finally
方法的返回值总是与原来的 Promise 状态一致。
通过finally
方法,可以方便地处理一些无论异步操作成功还是失败都需要执行的逻辑,例如资源释放、清理操作等,使代码更加简洁和清晰。
# 6. Promise.all()
Promise.all()
方法用于将多个 Promise 实例,包装成一个新的 Promise 实例。
const p = Promise.all([p1, p2, p3]);
上面代码中,Promise.all()
方法接受一个数组作为参数,p1
、p2
、p3
都是 Promise 实例,如果不是,就会先调用下面讲到的Promise.resolve
方法,将参数转为 Promise 实例,再进一步处理。另外,Promise.all()
方法的参数可以不是数组,但必须具有 Iterator 接口,且返回的每个成员都是 Promise 实例。
p
的状态由p1
、p2
、p3
决定,分成两种情况。
(1)只有p1
、p2
、p3
的状态都变成fulfilled
,p
的状态才会变成fulfilled
,此时p1
、p2
、p3
的返回值组成一个数组,传递给p
的回调函数。
(2)只要p1
、p2
、p3
之中有一个被rejected
,p
的状态就变成rejected
,此时第一个被reject
的实例的返回值,会传递给p
的回调函数。
下面是一个具体的例子。
// 生成一个Promise对象的数组
const promises = [2, 3, 5, 7, 11, 13].map(function (id) {
return getJSON('/post/' + id + ".json");
});
Promise.all(promises).then(function (posts) {
// ...
}).catch(function(reason){
// ...
});
2
3
4
5
6
7
8
9
10
上面代码中,promises
是包含 6 个 Promise 实例的数组,只有这 6 个实例的状态都变成fulfilled
,或者其中有一个变为rejected
,才会调用Promise.all
方法后面的回调函数。
下面是另一个例子。
const databasePromise = connectDatabase();
const booksPromise = databasePromise
.then(findAllBooks);
const userPromise = databasePromise
.then(getCurrentUser);
Promise.all([
booksPromise,
userPromise
])
.then(([books, user]) => pickTopRecommendations(books, user));
2
3
4
5
6
7
8
9
10
11
12
13
上面代码中,booksPromise
和userPromise
是两个异步操作,只有等到它们的结果都返回了,才会触发pickTopRecommendations
这个回调函数。
注意,如果作为参数的 Promise 实例,自己定义了catch
方法,那么它一旦被rejected
,并不会触发Promise.all()
的catch
方法。
const p1 = new Promise((resolve, reject) => {
resolve('hello');
})
.then(result => result)
.catch(e => e);
const p2 = new Promise((resolve, reject) => {
throw new Error('报错了');
})
.then(result => result)
.catch(e => e);
Promise.all([p1, p2])
.then(result => console.log(result))
.catch(e => console.log(e));
// ["hello", Error: 报错了]
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
上面代码中,p1
会resolved
,p2
首先会rejected
,但是p2
有自己的catch
方法,该方法返回的是一个新的 Promise 实例,p2
指向的实际上是这个实例。该实例执行完catch
方法后,也会变成resolved
,导致Promise.all()
方法参数里面的两个实例都会resolved
,因此会调用then
方法指定的回调函数,而不会调用catch
方法指定的回调函数。
如果p2
没有自己的catch
方法,就会调用Promise.all()
的catch
方法。
const p1 = new Promise((resolve, reject) => {
resolve('hello');
})
.then(result => result);
const p2 = new Promise((resolve, reject) => {
throw new Error('报错了');
})
.then(result => result);
Promise.all([p1, p2])
.then(result => console.log(result))
.catch(e => console.log(e));
// Error: 报错了
2
3
4
5
6
7
8
9
10
11
12
13
14
# 7. Promise.race()
Promise.race()
方法用于将多个 Promise 实例,包装成一个新的 Promise 实例。
基本用法
const p = Promise.race([p1, p2, p3]);
上面代码中,Promise.race()
方法接受一个数组作为参数。只要p1
、p2
、p3
之中有一个实例率先改变状态,p
的状态就跟着改变。那个率先改变的 Promise 实例的返回值,就传递给p
的回调函数。
注意:如果参数中不是 Promise 实例,Promise.race()
方法会先调用 Promise.resolve()
方法,将参数转为 Promise 实例,再进一步处理。
示例
下面是一个例子,演示如果指定时间内没有获得结果,就将 Promise 的状态变为rejected
,否则变为resolved
。
const p = Promise.race([
fetch('/resource-that-may-take-a-while'), // 可能会耗时较长的请求
new Promise(function (resolve, reject) {
setTimeout(() => reject(new Error('request timeout')), 5000); // 5 秒超时
})
]);
p
.then(response => console.log('Response received:', response))
.catch(error => console.error('Error:', error));
2
3
4
5
6
7
8
9
10
上面代码中,如果 5 秒之内fetch
方法没有返回结果,变量p
的状态就会变为rejected
,从而触发catch
方法指定的回调函数。
# 8. Promise.allSettled()
Promise.allSettled()
方法接受一组 Promise 实例作为参数,包装成一个新的 Promise 实例。只有等到所有这些参数实例都返回结果,不管是fulfilled
还是rejected
,包装实例才会结束。该方法由 ES2020 (opens new window) 引入。
基本用法
const promises = [
fetch('/api-1'), // 请求1
fetch('/api-2'), // 请求2
fetch('/api-3'), // 请求3
];
await Promise.allSettled(promises);
removeLoadingIndicator(); // 等所有请求结束后,移除加载指示器
2
3
4
5
6
7
8
上面代码对服务器发出三个请求,等到三个请求都结束,不管请求成功还是失败,加载的滚动图标就会消失。
注意:Promise.allSettled()
方法返回的新的 Promise 实例,一旦结束,状态总是fulfilled
,不会变成rejected
。状态变成fulfilled
后,Promise 的监听函数接收到的参数是一个数组,每个成员对应一个传入Promise.allSettled()
的 Promise 实例。
示例
const resolved = Promise.resolve(42); // 返回值为 42 的 resolved Promise
const rejected = Promise.reject(-1); // 返回值为 -1 的 rejected Promise
const allSettledPromise = Promise.allSettled([resolved, rejected]);
allSettledPromise.then(function (results) {
console.log(results);
});
// 输出:
// [
// { status: 'fulfilled', value: 42 },
// { status: 'rejected', reason: -1 }
// ]
2
3
4
5
6
7
8
9
10
11
12
13
上面代码中,Promise.allSettled()
的返回值allSettledPromise
,状态只可能变成fulfilled
。它的监听函数接收到的参数是数组results
。该数组的每个成员都是一个对象,对应传入Promise.allSettled()
的两个 Promise 实例。每个对象都有status
属性,该属性的值只可能是字符串fulfilled
或字符串rejected
。fulfilled
时,对象有value
属性,rejected
时有reason
属性,对应两种状态的返回值。
# 返回值用法示例
下面是如何使用返回值的例子。
const promises = [ fetch('index.html'), fetch('https://does-not-exist/') ];
const results = await Promise.allSettled(promises);
// 过滤出成功的请求
const successfulPromises = results.filter(p => p.status === 'fulfilled');
// 过滤出失败的请求,并输出原因
const errors = results
.filter(p => p.status === 'rejected')
.map(p => p.reason);
2
3
4
5
6
7
8
9
10
# 实用性示例
有时候,我们不关心异步操作的结果,只关心这些操作有没有结束。这时,Promise.allSettled()
方法就很有用。如果没有这个方法,想要确保所有操作都结束,会比较麻烦,而Promise.all()
方法无法做到这一点。
const urls = [ /* ... */ ];
const requests = urls.map(x => fetch(x));
try {
await Promise.all(requests);
console.log('所有请求都成功。');
} catch {
console.log('至少一个请求失败,其他请求可能还没结束。');
}
2
3
4
5
6
7
8
9
上面代码中,Promise.all()
无法确定所有请求都结束。想要达到这个目的,写起来很麻烦,而使用Promise.allSettled()
就可以很容易地确保所有请求都结束。
const urls = [ /* ... */ ];
const requests = urls.map(x => fetch(x));
await Promise.allSettled(requests);
console.log('所有请求都已结束。');
2
3
4
5
上面代码中,Promise.all()
无法确定所有请求都结束。想要达到这个目的,写起来很麻烦,有了Promise.allSettled()
,这就很容易了。
# 9. Promise.any()
**Promise.any()
方法接受一组 Promise 实例作为参数,包装成一个新的 Promise 实例。只要参数实例有一个变成fulfilled
状态,包装实例就会变成fulfilled
状态;如果所有参数实例都变成rejected
状态,包装实例就会变成rejected
状态。**该方法目前是一个第三阶段的提案 (opens new window)。
Promise.any()
和Promise.race()
方法类似,但不同之处在于,Promise.any()
不会因为某个 Promise 变成rejected
状态而结束。
下面是一个基本的例子,展示如何使用Promise.any()
方法。
const promises = [
fetch('/endpoint-a').then(() => 'a'), // 请求A,返回 fulfilled 的 Promise,值为 'a'
fetch('/endpoint-b').then(() => 'b'), // 请求B,返回 fulfilled 的 Promise,值为 'b'
fetch('/endpoint-c').then(() => 'c'), // 请求C,返回 fulfilled 的 Promise,值为 'c'
];
try {
const first = await Promise.any(promises); // 等待第一个 fulfilled 的 Promise
console.log(first); // 输出最先 fulfilled 的结果,例如 'a','b' 或 'c'
} catch (error) {
console.log(error); // 如果所有 Promise 都被 rejected,输出错误
}
2
3
4
5
6
7
8
9
10
11
12
上面代码中,Promise.any()
方法的参数是包含三个 Promise 实例的数组。只要其中一个 Promise 实例变为fulfilled
,Promise.any()
返回的 Promise 对象就会变成fulfilled
。如果所有的 Promise 实例都变为rejected
,那么await
命令会抛出错误。
# AggregateError 示例
Promise.any()
抛出的错误不是普通的错误,而是一个 AggregateError 实例。它相当于一个数组,每个成员对应一个被rejected
的操作所抛出的错误。下面是 AggregateError 的实现示例。
class AggregateError extends Error {
constructor(errors) {
super();
this.name = "AggregateError";
this.errors = errors;
}
}
const err = new AggregateError([
new Error("first error"), // 第一个错误
new Error("second error"), // 第二个错误
]);
throw err; // 抛出 AggregateError 错误
2
3
4
5
6
7
8
9
10
11
12
13
# 捕捉错误的方式
如果不使用try...catch
结构和await
命令,可以像下面这样写:
Promise.any(promises).then(
(first) => {
console.log("Fulfilled with value:", first); // 任意一个 Promise fulfilled 的值
},
(error) => {
console.error("All promises were rejected:", error); // 所有 Promise 都被 rejected
}
);
2
3
4
5
6
7
8
下面是一个详细的例子,展示了Promise.any()
方法的实际应用。
var resolved = Promise.resolve(42); // 一个 resolved 的 Promise,值为 42
var rejected = Promise.reject(-1); // 一个 rejected 的 Promise,值为 -1
var alsoRejected = Promise.reject(Infinity); // 另一个 rejected 的 Promise,值为 Infinity
Promise.any([resolved, rejected, alsoRejected]).then(function (result) {
console.log(result); // 输出第一个 fulfilled 的值,42
}).catch(function (error) {
console.error(error); // 如果没有 fulfilled 的 Promise,将不会执行此分支
});
Promise.any([rejected, alsoRejected]).catch(function (results) {
console.error(results); // 捕获到 AggregateError: [-1, Infinity]
});
2
3
4
5
6
7
8
9
10
11
12
13
上面的代码展示了如何使用Promise.any()
方法来处理多个 Promise 实例,只要有一个变成fulfilled
状态,整体就会变成fulfilled
状态。如果所有实例都变成rejected
状态,则会返回 AggregateError,包含所有 rejected 实例的错误信息。
# 10. Promise.resolve()
有时需要将现有对象转为 Promise 对象,Promise.resolve()
方法就起到这个作用。
const jsPromise = Promise.resolve($.ajax('/whatever.json')); // 将 jQuery 的 deferred 对象转换为 Promise 对象
上面代码将 jQuery 生成的deferred
对象,转为一个新的 Promise 对象。
Promise.resolve()
等价于下面的写法。
Promise.resolve('foo')
// 等价于
new Promise(resolve => resolve('foo')) // 立即 resolve 一个值为 'foo' 的 Promise 对象
2
3
# 参数情况
Promise.resolve
方法的参数分成四种情况。
(1)参数是一个 Promise 实例
如果参数是 Promise 实例,那么Promise.resolve
将不做任何修改、原封不动地返回这个实例。
(2)参数是一个thenable
对象
thenable
对象指的是具有then
方法的对象,比如下面这个对象。
let thenable = {
then: function(resolve, reject) {
resolve(42); // 将对象的状态改为 resolved,并返回值 42
}
};
2
3
4
5
Promise.resolve
方法会将这个对象转为 Promise 对象,然后就立即执行thenable
对象的then
方法。
let thenable = {
then: function(resolve, reject) {
resolve(42); // 将对象的状态改为 resolved,并返回值 42
}
};
let p1 = Promise.resolve(thenable); // 将 thenable 对象转换为 Promise 对象
p1.then(function(value) {
console.log(value); // 42
});
2
3
4
5
6
7
8
9
10
上面代码中,thenable
对象的then
方法执行后,对象p1
的状态就变为resolved
,从而立即执行最后那个then
方法指定的回调函数,输出 42。
(3)参数不是具有then
方法的对象,或根本就不是对象
如果参数是一个原始值,或者是一个不具有then
方法的对象,则Promise.resolve
方法返回一个新的 Promise 对象,状态为resolved
。
const p = Promise.resolve('Hello'); // 将字符串 'Hello' 转换为 Promise 对象
p.then(function (s){
console.log(s); // Hello
});
2
3
4
5
上面代码生成一个新的 Promise 对象的实例p
。由于字符串Hello
不属于异步操作(判断方法是字符串对象不具有 then 方法),返回 Promise 实例的状态从一生成就是resolved
,所以回调函数会立即执行。Promise.resolve
方法的参数,会同时传给回调函数。
(4)不带有任何参数
Promise.resolve()
方法允许调用时不带参数,直接返回一个resolved
状态的 Promise 对象。
所以,如果希望得到一个 Promise 对象,比较方便的方法就是直接调用Promise.resolve()
方法。
const p = Promise.resolve(); // 返回一个 resolved 状态的 Promise 对象
p.then(function () {
console.log('Resolved with no value');
});
2
3
4
5
上面代码的变量p
就是一个 Promise 对象,且状态为resolved
。
需要注意的是,立即resolve()
的 Promise 对象,是在本轮“事件循环”(event loop)的结束时执行,而不是在下一轮“事件循环”的开始时。
setTimeout(function () {
console.log('three'); // 在下一轮事件循环开始时执行
}, 0);
Promise.resolve().then(function () {
console.log('two'); // 在本轮事件循环结束时执行
});
console.log('one'); // 立即执行
// 输出顺序:
// one
// two
// three
2
3
4
5
6
7
8
9
10
11
12
13
14
上面代码中,setTimeout(fn, 0)
在下一轮“事件循环”开始时执行,Promise.resolve()
在本轮“事件循环”结束时执行,console.log('one')
则是立即执行,因此最先输出。
# 11. Promise.reject()
Promise.reject(reason)
方法也会返回一个新的 Promise 实例,该实例的状态为rejected
。
const p = Promise.reject('出错了');
// 等同于
const p = new Promise((resolve, reject) => reject('出错了'))
p.then(null, function (s) {
console.log(s) // 出错了
});
2
3
4
5
6
7
上面代码生成一个 Promise 对象的实例p
,状态为rejected
,回调函数会立即执行,并输出错误信息。
注意,Promise.reject()
方法的参数,会原封不动地作为reject
的理由,变成后续方法的参数。这一点与Promise.resolve
方法不一致。
const thenable = {
then(resolve, reject) {
reject('出错了');
}
};
Promise.reject(thenable)
.catch(e => {
console.log(e === thenable) // true
});
2
3
4
5
6
7
8
9
10
上面代码中,Promise.reject
方法的参数是一个thenable
对象,执行以后,后面catch
方法的参数不是reject
抛出的“出错了”这个字符串,而是thenable
对象。
# 12. 应用
# 加载图片
我们可以将图片的加载写成一个Promise
,一旦加载完成,Promise
的状态就发生变化。
const preloadImage = function (path) {
return new Promise(function (resolve, reject) {
const image = new Image(); // 创建一个新的 Image 对象
image.onload = resolve; // 图片加载成功时调用 resolve
image.onerror = reject; // 图片加载失败时调用 reject
image.src = path; // 设置图片的 src 属性,开始加载图片
});
};
2
3
4
5
6
7
8
# Generator 函数与 Promise 的结合
使用 Generator 函数管理流程,遇到异步操作的时候,通常返回一个Promise
对象。
// 一个返回 Promise 对象的函数
function getFoo () {
return new Promise(function (resolve, reject){
resolve('foo'); // 直接 resolve 一个字符串 'foo'
});
}
// 一个 Generator 函数,用于异步操作
const g = function* () {
try {
const foo = yield getFoo(); // 暂停函数执行,等待 Promise resolve
console.log(foo); // 打印出 'foo'
} catch (e) {
console.log(e); // 捕获并打印错误
}
};
// 一个运行 Generator 函数的辅助函数
function run (generator) {
const it = generator(); // 调用 Generator 函数,获取迭代器对象
// 一个递归函数,用于处理每一步的结果
function go(result) {
if (result.done) return result.value; // 如果 Generator 函数执行完毕,返回结果
// 如果没有执行完毕,继续处理 Promise 对象
return result.value.then(function (value) {
return go(it.next(value)); // 将 resolve 的值传回 Generator 函数,继续执行
}, function (error) {
return go(it.throw(error)); // 将错误传回 Generator 函数,继续执行
});
}
go(it.next()); // 启动递归函数
}
run(g); // 运行 Generator 函数
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
上面代码的 Generator 函数g
之中,有一个异步操作getFoo
,它返回的就是一个Promise
对象。函数run
用来处理这个Promise
对象,并调用下一个next
方法。