Promise
的含义
Promise
是异步编程的一种解决方案,主要用于解决js回调地狱的问题。所谓 Promise
,就是一个容器,里面保存着某个未来才会结束的事件(通常是一个异步操作)的结果。从语法上说,Promise
是一个对象,从它可以获取异步操作的消息。
Promise
对象有以下两个特点:
-
对象的状态不受外界影响。
Promise
对象代表一个异步操作,有三种状态:pending
(进行中)fulfilled
(已成功)reject
(已失败)
只有异步操作的结果,可以决定当前是哪一种状态,任何其他操作都无法改变这个状态。这 也是
Promise
这个名字的由来。它的英语意思就是“承诺”,表示其他手段无法改变。 -
一旦状态改变,就不会再变。
Promise
对象的状态改变,只有两种可能:pending
->fulfilled
pending
->rejected
只要这两种情况发生,状态就凝固了,会一直保持这个结果,这时就称为
resolved
(已定型)。如果改变已经发生了,你再对Promise
对象添加回调函数,也会立即得到这个结果。注意,为了行文方便,本章后面的resolved
统一只指fulfilled
状态,不包含rejected
状态。
有了 Promise
对象,就可以将异步操作以同步操作的流程表达出来,避免了层层嵌套的回调函数。
Promise
对象有以下缺点:
- 无法取消
Promise
,一旦新建它就会立即执行,无法中途取消。 - 如果不设置回调函数,
Promise
内部抛出的错误,不会反应到外部。 - 当处于
pending
状态时,无法得知目前进展到哪一阶段。是刚刚开始还是即将完成?
基本用法
ES6规定, Promise
对象是一个构造函数,用来生成 Promise
实例。
const promise = new Promise(function (resolve, reject) {
// ... some code
if (/* 异步操作成功 */) {
resolve(value);
}
else {
reject(error);
}
});
Promise
构造函数接受一个函数作为参数,该函数的两个参数分别是 resolve
和 reject
。它们是两个函数,由js引擎提供,不用自己部署。
relove
函数
将 Promise
对象的状态从 pending
-> resolved
,在异步操作成功时调用,并将 异步操作的结果,作为参数传递出去。
reject
函数
将 Promise
对象的状态从 pending
-> rejected
,在异步操作失败时调用,并将 异步操作报出的错误,作为参数传递出去。
Promise
实例生成以后,可以用 then
方法分别指定 resolved
状态和 rejected
状态的回调函数。
promise.then(function (value) {
// success
}, function (error) {
// failure
});
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);
});
上面代码中, timeout
方法返回一个 Promise
实例,表示一段时间以后才会发生的结果。过了指定的时间( ms
参数)以后, Promise
实例的状态变为 resolved
,就会触发 then
方法绑定的回调函数。
Promise
新建后就会立即执行:
let promise = new Promise((resolve, reject) => {
console.log("in Promise");
resolve();
});
promise.then(() => {
console.log("resolved");
});
console.log("Hi");
// in Promise
// Hi
// resolved
上面代码中, Promise
新建后就会立即执行,所以首先输出的是 in Promise
。然后, then
方法指定的回调函数,将在当前脚本所有同步任务执行完才会执行,所以 resolved
最后输出。
下面是异步加载图片的例子:
function loadImageAsync(url) {
return new Promise((resolve, reject) => {
const image = new Image();
image.onload = () => {
resolve(image);
};
image.onerror = () => {
reject(new Error("Could not load image at " + url));
};
image.src = url;
});
}
上面代码中,使用 Promise
包装了一个图片加载的异步操作。如果加载成功,就调用 resolve
方法,否则调用 reject
方法。
下面是一个用 Promise
对象实现的 Ajax
操作的例子:
const getJSON = function (url) {
const promise = new Promise(function (resolve, reject) {
const handler = function () {
if (this.readyState !== 4) {
return;
}
if (this.status === 200) {
resolve(this.response);
} else {
reject(new Error(this.statusText));
}
};
const client = new XMLHttpRequest();
client.open("GET", url);
client.onreadystatechange = handler;
client.responseType = "json";
client.setRequestHeader("Accept", "application/json");
client.send();
});
return promise;
};
getJSON("/posts.json").then(function (json) {
console.log('Contents: ' + json);
}, function (error) {
console.error('出错了', error);
});
上面代码中, getJSON
是对 XMLHttpRequest 对象的封装,用于发出一个针对 JSON 数据的 HTTP 请求,并且返回一个 Promise
对象。需要注意的是,在 getJSON
内部, resolve
函数和 reject
函数调用时,都带有参数。
如果调用 resolve
函数和 reject
函数时带有参数,那么它们的参数会被传递给回调函数。 reject
函数的参数通常是 Error
对象的实例,表示抛出的错误; resolve
函数的参数除了正常的值以外,还可能是另一个 Promise
实例,比如像下面这样:
const p1 = new Promise(function (resolve, reject) {
// ...
});
const p2 = new Promise(function (resolve, reject) {
// ...
resolve(p1);
})
上面代码中, 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
上面代码中, p1
是一个 Promise,3 秒之后变为 rejected
。 p2
的状态在 1 秒之后改变, resolve
方法返回的是p1
。由于 p2
返回的是另一个 Promise,导致 p2
自己的状态无效了,由 p1
的状态决定 p2
的状态。所以,后面的 then
语句都变成针对后者( p1
)。又过了 2 秒, p1
变为 rejected
,导致触发 catch
方法指定的回调函数。
注意,调用 resolve
或 reject
并不会终结 Promise
的参数函数的执行:
new Promise((resolve, reject) => {
resolve(1);
console.log(2);
}).then(r => {
console.log(r);
});
// 2
// 1
上面代码中,调用 resolve(1)
以后,后面的 console.log(2)
还是会执行,并且会首先打印出来。这是因为立即 resolved 的 Promise 是在本轮事件循环的末尾执行,总是晚于本轮循环的同步任务。
一般来说,调用 resolve
或 reject
以后,Promise
的使命就完成了,后继操作应该放到then
方法里面,而不应该直接写在 resolve
或 reject
的后面。所以,最好在它们前面加上 return
语句,这样就不会有意外:
new Promise((resolve, reject) => {
return resolve(1);
// 后面的语句不会执行
console.log(2);
})
Promise.prototype.then()
Promise
实例具有 then
方法,它是定义在原型对象 Promise.prototype
上的。它的作用是为 Promise
实例添加状态改变时的回调函数。then
方法返回的是一个新的 Promise
实例。因此可采用链式写法,即 then
方法后面再调用一个 then
方法:
getJSON("/posts.json").then(function (json) {
return json.post;
}).then(function (post) {
// ...
});
上面的代码使用 then
方法,依次指定了两个回调函数。第一个回调函数完成以后,会将返回结果作为参数,传入第二个回调函数。
采用链式的 then
,可以指定一组按照次序调用的回调函数。这时,前一个回调函数,有可能返回的还是一个 Promise
对象(即有异步操作),这时后一个回调函数,就会等待该 Promise
对象的状态发生变化,才会被调用:
getJSON("/post/1.json").then(function (post) {
return getJSON(post.commentURL);
}).then(function funcA(comments) {
console.log("resolved: ", comments);
}, function funcB(err) {
console.log("rejected: ", err);
});
上面代码中,第一个 then
方法指定的回调函数,返回的是另一个 Promise
对象。这时,第二个 then
方法指定的回调函数,就会等待这个新的 Promise
对象状态发生变化。如果变为 resolved
,就调用 funcA
,如果状态变为 rejected
,就调用 funcB
。
如果采用箭头函数,上面的代码可以写得更简洁。
Promise.prototype.catch()
Promise.prototyoe.catch()
方法是 .then(null, rejection)
的别名。用于指定发生错误的回调函数。
getJSON("/gets.json").then(function(gets) {
// ...
}).catch(function(error) {
// 处理 getJSON 和 前一个回调函数运行时发生的错误
console.log("error occurs", error);
});
上面代码中, getJSON
方法返回一个 Promise
对象。如果该对象状态变为 resolved
,则会调用 then
方法指定的回调函数;如果异步操作发生错误,状态就会变为 rejected
,就会调用 catch
方法指定的回调函数,处理这个错误。另外, then
方法指定的回调函数,如果运行中抛出错误,也会被 catch
方法捕获。Promise
对象的错误具有”冒泡“性质,会一直向后传递,直至被捕获为止。也就是说,错误总是会被下一个 catch
语句捕获。
getJSON('/post/1.json').then(function (post) {
return getJSON(post.commentURL);
}).then(function (comments) {
// some code
}).catch(function (error) {
// 处理前面三个Promise产生的错误
});
Promise.all()
Promise.all
方法用于将多个 Promise
实例,包装秤一个新的 Promise
实例:
const p = Promise.all([p1, p2, p3]);
上面代码中,Promise.all
方法接受一个数组作为参数,p1
、 p2
、 p3
都是 Promise
实例。p
的状态有 p1
、 p2
、 p3
决定,分成两种情况:
- 只有
p1
、p2
、p3
的状态都变成fulfilled
,p
的状态才会变成fulfilled
,此时p1
、p2
、p3
的返回值组成一个数组,传递给p
的回调函数。 - 只要
p1
、p2
、p3
之中有一个被rejected
,p
的状态就会变成rejected
,此时第一个被reject
的实例的返回值,传递给p
的回调函数。
const promises = [2, 3, 4, 5, 11, 13].map(function(id) {
return getJSON("/post/" + id + ".json");
});
Promise.all(promises).then(function(posts) {
// ...
}).catch(function(reason) {
// ...
});
上面代码中,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]) => pickTopRecommentations(books, user));
上面代码中,booksPromise
和 userPromise
是两个异步操作,只有等到它们的结果都返回了,才会触发 pickTopRecommentations
这个回调函数。
注意,如果作为参数的 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: 报错了]
上面代码中,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: 报错了
Promise.race()
Promise.race
方法同样是将多个 Promise
实例,包装成一个新的 Promise
实例:
const p = Promise.race([p1, p2, p3]);
上面代码中,只要p1
、p2
、p3
之中有一个实例率先改变状态,p
的状态就跟着改变。那个率先改变的 Promise 实例的返回值,就传递给p
的回调函数。
Promise.race
方法的参数与 Promise.all
方法一样,如果不是 Promise
实例,就会先调用下面讲到的 Promise.resolve
方法,将参数转为 Promise
实例,再进一步处理。
下面是一个例子,如果指定时间内没有获得结果,就将 Promise 的状态变为 reject
,否则变为 resolve
。
const p = Promise.race([
fetch('/resource-that-may-take-a-while'),
new Promise(function (resolve, reject) {
setTimeout(() => reject(new Error('request timeout')), 5000)
})
]);
p.then(console.log)
.catch(console.error);
上面代码中,如果 5 秒之内 fetch
方法无法返回结果,变量 p
的状态就会变为rejected
,从而触发 catch
方法指定的回调函数。