一、Promise
Promise 是异步编程的一种解决方案,比传统的解决方案(回调函数和事件)更合理和更强大。它由社区最早提出和实现,ES6 将其写进了语言标准,统一了用法,原生提供了Promise对象。
所谓Promise,简单说就是一个容器,里面保存着某个未来才会结束的事件(通常是一个异步操作)的结果。从语法上说,Promise 是一个对象,从它可以获取异步操作的消息。Promise 提供统一的 API,各种异步操作都可以用同样的方法进行处理。
- Promise对象的特点:
1)对象状态不受外界影响,只有异步操作的结果才能够决定当前是哪一种状态,任何其他操作都无法改变这种状态。
2)对象状态只会改变一次。状态一旦改变后,就不会再发生改变,任何时候都可以得到相同的结果。Promise对象的状态改变,只有两种可能:从pending变为fulfilled和从pending变为rejected。只要这两种情况发生,状态就凝固了,不会再变了,会一直保持这个结果,这时就称为 resolved(已定型)。如果改变已经发生了,你再对Promise对象添加回调函数,也会立即得到这个结果。
Tip:Promise状态:Pending(进行中)、fulfilled(已成功)、rejected(已失败)。
有了Promise对象,就可以将异步操作以同步操作的流程表达出来,避免了层层嵌套的回调函数。此外,Promise对象提供统一的接口,使得控制异步操作更加容易。
二、Promise的基本用法
ES6 规定,Promise对象是一个构造函数,用来生成Promise实例。
const promise = new Promise(function(resolve, reject) {
// ... some code
if (/* 异步操作成功 */){
resolve(value);
} else {
reject(error);
}
});
Promise构造函数接受一个函数作为参数,该函数的两个参数分别是resolve和reject。它们是两个函数,由 JavaScript 引擎提供,不用自己部署。
resolve:将Promise对象的状态从“未完成”变为“成功”(即从 pending 变为 resolved),在异步操作成功时调用,并将异步操作的结果,作为参数传递出去;
reject:将Promise对象的状态从“未完成”变为“失败”(即从 pending 变为 rejected),在异步操作失败时调用,并将异步操作报出的错误,作为参数传递出去。
Promise实例生成以后,可以用then方法分别指定resolved状态和rejected状态的回调函数。
promise.then(function(value) {
// success
}, function(error) {
// failure
});
另外一种写法:
promise.then(function(value) {
// success
}).catch(function(error) {
// failure
});
上面promise对象状态变为resolved时会执行then方法指定的回调函数。如果promise状态变为rejected,则执行catch方法指定的回调函数。
then方法指定的回调函数将在所有同步任务执行完成后才会执行,例如:
let promise = new Promise(function(resolve, reject) {
console.log('Promise');
resolve();
});
promise.then(function() {
console.log('resolved.');
});
console.log('Hi!');
// Promise
// Hi!
// resolved
上面新建Promise对象时会立即输出“Promise”,然后再输出“Hi”,直到所有同步任务执行完后再执行then方法的回调函数。因此最后输出“resolved”。
我们再看另外一个例子。
function loadImageAsync(url) {
// 把Image对象转换成Promise
return new Promise(function(resolve, reject) {
// 创建Image对象
const image = new Image();
// 给Image对象绑定onload事件,当图片加载完后,当前Promise对象状态变为resolved,
// 然后在返回Image对象
image.onload = function() {
resolve(image);
};
// 如果图片加载失败,当前Promise对象状态变为rejected,并然会Error。
image.onerror = function() {
reject(new Error('Could not load image at ' + url));
};
// 设置图片url
image.src = url;
});
}
const promise = loadImageAsync('img/Koala.jpg');
promise.then((img) => {
document.body.appendChild(img);
}).catch((e) => {
console.log(e);
});
上面代码中,使用Promise包装了一个图片加载的异步操作。如果加载成功,就调用resolve方法,否则就调用reject方法。
注意:调用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常用方法
3.1 Promise.prototype.then()
then方法是 Promise对象状态改变时的回调函数。该方法第一个参数是resolved状态的回调函数,第二个参数是rejected状态的回调函数。该方法返回一个新的Promise实例。因此可以在then方法后面继续使用then方法。
promise.then((value) => {
// code
}).then((value) => {
// code
});
上面的代码使用then方法,依次指定了两个回调函数。第一个回调函数完成以后,会将返回结果作为参数,传入第二个回调函数.
采用链式的then,可以指定一组按照次序调用的回调函数。这时,前一个回调函数,有可能返回的还是一个Promise对象(即有异步操作),这时后一个回调函数,就会等待该Promise对象的状态发生变化,才会被调用。
3.2 Promise.prototype.catch()
Promise.prototype.catch方法是.then(null, rejection)或.then(undefined, rejection)的别名,用于指定发生错误时的回调函数。
promise.then(...).catch((e) => {
// error
});
如果Promise对象状态变为rejected,或者then方法指定的回调函数中发生错误,也会被catch方法捕获。请看下面代码:
<script>
const promise = new Promise((resolve, reject) => {
console.log('promise...');
// reject(new Error('test'));
throw new Error('test');
});
promise.then((value) => {
console.log('then...');
}).catch((error) => {
console.log('catch...')
});
// promise
// catch
</script>
上面代码中,promise抛出一个错误,就被catch方法指定的回调函数捕获。但是,如果 Promise 状态已经变成resolved,再抛出错误是无效的。例如:
const promise = new Promise((resolve, reject) => {
resolve('ok');
throw new Error('test');
});
上面代码中,Promise 在resolve语句后面,再抛出错误,不会被捕获,等于没有抛出。因为 Promise 的状态一旦改变,就永久保持该状态,不会再变了。
另外,Promise 对象的错误具有“冒泡”性质,会一直向后传递,直到被捕获为止。也就是说,错误总是会被下一个catch语句捕获。
promise
.then(...)
.then(...)
.then(...)
.catch(...);
上面代码中,一共有三个then方法,每个then方法都返回一个Promise对象。只要其中一个then方法抛出错误,都会被最后一个catch捕获。
一般来说,不要在then方法里面定义 Reject 状态的回调函数(即then的第二个参数),总是使用catch方法,例如:
// 写法一
promise
.then(function(data) {
// success
}, function(err) {
// error
});
// 写法二
promise
.then(function(data) {
// success
})
.catch(function(err) {
// error
});
上面代码中,第二种写法要好于第一种写法,理由是第二种写法可以捕获前面then方法执行中的错误,也更接近同步的写法(try/catch)。
跟传统的try/catch代码块不同的是,如果没有使用catch方法指定错误处理的回调函数,Promise 对象抛出的错误不会传递到外层代码,即不会有任何反应。
<script>
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
</script>
上面代码中,someAsyncThing函数产生的 Promise 对象,内部有语法错误。浏览器运行到这一行,会打印出错误提示ReferenceError: x is not defined,但是不会退出进程、终止脚本执行,2 秒之后还是会输出123。这就是说,Promise 内部的错误不会影响到 Promise 外部的代码,通俗的说法就是“Promise 会吃掉错误”。
一般总是建议,Promise 对象后面要跟catch方法,这样可以处理 Promise 内部发生的错误。catch方法返回的还是一个 Promise 对象,因此后面还可以接着调用then方法。
<script>
const someAsyncThing = function() {
return new Promise(function(resolve, reject) {
// 下面一行会报错,因为x没有声明
resolve(x + 2);
});
};
someAsyncThing()
.catch(function(error) {
console.log('catch error');
})
.then(function() {
console.log('everything is great');
});
setTimeout(() => { console.log(123) }, 2000);
// catch error
// everything is great
// 123
</script>
上面代码运行完catch方法指定的回调函数,会接着运行后面那个then方法指定的回调函数。如果没有报错,则会跳过catch方法。
Promise.resolve()
.catch(function(error) {
console.log('oh no', error);
})
.then(function() {
console.log('carry on');
});
// carry on
上面的代码因为没有报错,跳过了catch方法,直接执行后面的then方法。此时,要是then方法里面报错,就与前面的catch无关了。
catch方法之中,还能再抛出错误,例如:
Promise.reject().catch(function(error) {
console.log('catch error1');
// 下面一行会报错,因为 y 没有声明
y + 2;
}).catch(function(error) {
console.log('catch error2');
});
// catch error1
// catch error2
上面代码中,第一个catch方法抛出一个错误,第二个catch方法用来捕获前一个catch方法抛出的错误。
3.3 Promise.prototype.finally()
finally方法用于指定不管 Promise 对象最后状态如何,都会执行的操作。该方法是 ES2018 引入标准的。
promise
.then(result => {···})
.catch(error => {···})
.finally(() => {···});
上面代码中,不管promise最后的状态,在执行完then或catch指定的回调函数以后,都会执行finally方法指定的回调函数。
finally方法的回调函数不接受任何参数,这意味着没有办法知道,前面的 Promise 状态到底是fulfilled还是rejected。这表明,finally方法里面的操作,应该是与状态无关的,不依赖于 Promise 的执行结果。可以这样理解,finally本质上是then方法的特例。
promise
.finally(() => {
// code
});
// 等同于
promise
.then(
result => {
// code
return result;
},
error => {
// code
throw error;
}
);
上面代码中,如果不使用finally方法,同样的语句需要为成功和失败两种情况各写一次。有了finally方法,则只需要写一次。
finally方法总是会返回原来的值,例如:
<script>
new Promise((resolve, reject) => {
console.log('promise');
resolve(2);
})
.finally(() => {
console.log('finally');
})
.then((value) => {
console.log('value = ', value);
});
// proimse
// finally
// value = 2
</script>
3.4 Promise.all()
Promise.all()方法用于将多个 Promise 实例,包装成一个新的 Promise 实例。
例如:
const p = Promise.all([p1, p2, p3]);
上面代码中,Promise.all()方法接受一个数组作为参数,p1、p2、p3都是 Promise 实例,如果不是,就会先调用下面讲到的Promise.resolve方法,将参数转为 Promise 实例,再进一步处理。
p的状态由p1、p2、p3决定,分成两种情况:
情况一:只有p1、p2、p3的状态都变成fulfilled,p的状态才会变成fulfilled,此时p1、p2、p3的返回值组成一个数组,传递给p的回调函数。
情况二:只要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) {
// post代表p1、p2、p3组成的数组
}).catch(function(reason){
// ...
});
上面代码中,promises是包含 6 个 Promise 实例的数组,只有这 6 个实例的状态都变成fulfilled,或者其中有一个变为rejected,才会调用Promise.all方法后面的回调函数。
注意,如果作为参数的 Promise 实例,自己定义了catch方法,那么它一旦被rejected,并不会触发Promise.all()的catch方法。
<script>
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 = ', result))
.catch(e => console.log('error = ', e));
</script>
上面p2有自己的catch,该方法返回的是一个新的 Promise 实例。p2指向的实际上是这个实例。该实例执行完catch方法后,也会变成resolved,导致Promise.all()方法参数里面的两个实例都会resolved,因此会调用then方法指定的回调函数,而不会调用catch方法指定的回调函数。如果p2没有自己的catch方法,就会调用Promise.all()的catch方法。
3.5 Promise.resolve()
该方法可以将一个现有对象转换为Promise对象,例如:
Promise.resolve('foo');
// 等价于
new Promise(resolve => resolve('foo'));
Promise.resolve方法的参数分成四种情况:
1)如果参数是 Promise 实例,那么Promise.resolve将不做任何修改、原封不动地返回这个实例;
2)如果参数是一个thanable对象,该方法就会将该对象转换成Promise对象,并立即执行thenable对象的then方法;
3)如果参数是一个原始值,或者是一个不具有then方法的对象,则Promise.resolve方法返回一个新的 Promise 对象,状态为resolved;
4)如果不带任何参数,该方法直接返回一个resolved状态的 Promise 对象;
Tip:thenable对象指的是具有then方法的对象。
值得注意的是,立即resolve()的 Promise 对象,是在本轮“事件循环”(event loop)的结束时执行,而不是在下一轮“事件循环”的开始时。
例如:
setTimeout(function () {
console.log('three'); // 在下一轮事件循环开始时执行
}, 0);
Promise.resolve().then(function () {
console.log('two'); // 在本轮事件循环结束时执行
});
console.log('one');
// one
// two
// three
上面代码中,setTimeout(fn, 0)在下一轮“事件循环”开始时执行,Promise.resolve()在本轮“事件循环”结束时执行,console.log(‘one’)则是立即执行,因此最先输出。
3.6 Promise.reject()
该方法返回一个新的 Promise 实例,该实例的状态为rejected。
const p = Promise.reject('出错了');
// 等价于
const p = new Promise((resolve, reject) => reject('出错了'))
注意,Promise.reject()方法的参数,会原封不动地作为reject的理由,变成后续方法的参数。这一点与Promise.resolve方法不一致。
const thenable = {
then(resolve, reject) {
reject('出错了');
}
};
Promise.reject(thenable)
.catch(e => {
console.log(e === thenable)
})
上面代码中,Promise.reject方法的参数是一个thenable对象,执行以后,后面catch方法的参数不是reject抛出的“出错了”这个字符串,而是thenable对象。