- 相关链接:
- 以下内容全部源于: http://es6.ruanyifeng.com/#docs/promise
一、Promise的介绍
1.1 Promise
- 从语法上说,
Promise是一个对象,从它可以获取异步操作的消息。- 简单说
Promise就是一个容器,里面保存着某个未来才会结束的事件(通常是一个异步操作)的结果。
1.2 Promise特点
Promise对象有以下两个特点。
- 1.对象的状态不受外界影响。
Promise对象代表一个异步操作,有三种状态:pending(进行中)、fulfilled(已成功)和rejected(已失败)。- 只有异步操作的结果,可以决定当前是哪一种状态,任何其他操作都无法改变这个状态。
- 这也是
Promise这个名字的由来,它的英语意思就是“承诺”,表示其他手段无法改变。- 2.一旦状态改变,就不会再变,任何时候都可以得到这个结果。
Promise对象的状态改变,只有两种可能:从pending变为fulfilled和 从pending变为rejected。- 只要这两种情况发生,状态就凝固了,不会再变了,会一直保持这个结果,这时就称为
resolved(已定型)。- 如果改变已经发生了,你再对
Promise对象添加回调函数,也会立即得到这个结果。- 这与事件(
Event)完全不同,事件的特点是,如果你错过了它,再去监听,是得不到结果的。
1.3 Promise 缺点
- 无法取消
Promise,一旦新建它就会立即执行,无法中途取消。- 如果不设置回调函数,
Promise内部抛出的错误,不会反应到外部。- 当处于
pending状态时,无法得知目前进展到哪一个阶段(刚刚开始还是即将完成)。
二、基本用法
1.1 用法介绍
Promise构造函数接受一个函数作为参数,该函数的两个参数分别是resolve和reject。它们是两个函数。
resolve函数的作用是,将Promise对象的状态从“未完成”变为“成功”(即从pending变为resolved),在异步操作成功时调用,并将异步操作的结果,作为参数传递出去。reject函数的作用是,将Promise对象的状态从“未完成”变为“失败”(即从pending变为rejected),在异步操作失败时调用,并将异步操作报出的错误,作为参数传递出去。
Promise实例生成以后,可以用then方法分别指定resolved状态和rejected状态的回调函数。then方法可以接受两个回调函数作为参数。【这两个函数都接受Promise对象传出的值作为参数。】
- 第一个回调函数是
Promise对象的状态变为resolved时调用。- 第二个回调函数是
Promise对象的状态变为rejected时调用。其中,第二个函数是可选的,不一定要提供。
2.2 例1
timeout方法返回一个Promise实例,表示一段时间以后才会发生的结果。过了指定的时间(ms参数)以后,Promise实例的状态变为resolved,就会触发then方法绑定的回调函数。- 点击打开demo
function timeout(ms) {
return new Promise((resolve, reject) => {
setTimeout(resolve, ms, 'done');
});
}
timeout(100).then((value) => {
console.log(value); // done
});
2.3 例2
Promise新建后立即执行,所以首先输出的是Promise。- 然后,
then方法指定的回调函数,将在当前脚本所有同步任务执行完才会执行,所以resolved最后输出。- 【点击打开demo】
let promise = new Promise((resolve, reject) => {
console.log('Promise')
resolve();
});
promise.then((resolved, rejected) => {
console.log('resolved');
});
console.log(1);
// Promise =》 1 =》 resolved
2.4 例3 异步加载图片
- 【点击打开demo】
- 如果加载成功,就调用
resolve方法,否则就调用reject方法。
const promise1 = loadImageAsync('http://a3.topitme.com/1/21/79/1128833621e7779211o.jpg');
// 加载成功
promise1.then((resolved) => {
document.getElementById('success').appendChild(resolved);
})
const promise2 = loadImageAsync('http://a3.topitme.com/1/21/79/112833621e7779211o.jpg');
// 加载失败
promise2.then((resolved) => {}, (rejected) => {
document.getElementById('failure').innerHTML = rejected;
})
function loadImageAsync (url) {
return new Promise((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.5 例4 用Promise对象实现的 Ajax 操作
function getJson (url) {
var promise = new Promise((resolve, reject) => {
var xhr = new XMLHttpRequest();
xhr.open('GET', url);
xhr.onreadystatechange = handler;
xhr.responseType = 'json';
xhr.setRequestHeader('Accept', 'application/json');
xhr.send(null);
function handler () {
if(xhr.readyState !== 4) {
return;
}
if(xhr.readyState === 200) {
resolve(this.response);
} else {
reject(new Error(this.statusText));
}
}
});
return promise;
}
getJSON("/posts.json").then(function(json) {
console.log('Contents: ' + json);
}, function(error) {
console.error('出错了', error);
});
- 如果调用
resolve函数和reject函数时带有参数,那么它们的参数会被传递给回调函数。
reject函数的参数通常是Error对象的实例,表示抛出的错误。resolve函数的参数除了正常的值以外,还可能是另一个Promise实例。
2.6 例5
- 【点击打开demo】
p1和p2都是Promise的实例,但是p2的resolve方法将p1作为参数,即一个异步操作的结果是返回另一个异步操作。- 这时
p1的状态就会传递给p2,即:p1的状态决定了p2的状态。
- 如果
p1的状态是pending,那么p2的回调函数就会等待p1的状态改变;- 如果
p1的状态已经是resolved或者rejected,那么p2的回调函数将会立刻执行。
- 分析:
p1是一个Promise,3秒之后变为rejected。p2的状态在1秒之后改变,resolve方法返回的是p1。- 由于
p2返回的是另一个Promise,导致p2自己的状态无效了,由p1的状态决定p2的状态。- 所以,后面的then语句都变成针对后者(
p1)。- 又过了
2秒,p1变为rejected,导致触发catch方法指定的回调函数。
var p1 = new Promise(function (resolve, reject) {
setTimeout(() => reject(new Error('fail')), 3000)
})
var p2 = new Promise(function (resolve, reject) {
setTimeout(() => resolve(p1), 1000)
})
p2
.then(result => console.log(result))
.catch(error => console.log(error))
// Error: fail
- 调用
resolve或reject并不会终结Promise的参数函数的执行。
2.7 例6
- 【点击打开demo】
- 调用
resolve(1)以后,后面的console.log(2)还是会执行,并且会首先打印出来。- 这是因为立即
resolved的Promise是在本轮事件循环的末尾执行,总是晚于本轮循环的同步任务。
new Promise((resolve, reject) => {
resolve(1);
console.log(2);
}).then(val => console.log(val));
// 2
// 1
- 一般来说,调用
resolve或reject以后,Promise的使命就完成了,后继操作应该放到then方法里面,而不应该直接写在resolve或reject的后面。所以,最好在它们前面加上return语句,这样就不会有意外。
new Promise((resolve, reject) => {
return resolve(1);
// 后面的语句不会执行
console.log(2);
})
三、 Promise.prototype.then()
Promise实例具有then方法,即:then方法是定义在原型对象Promise.prototype上的。
- 作用:为
Promise实例添加状态改变时的回调函数。- 参数:
then方法的第一个参数是resolved状态的回调函数,第二个参数(可选)是rejected状态的回调函数。- 返回值:
then方法返回的是一个新的Promise实例(注意,不是原来那个Promise实例)。- 因此可以采用链式写法,即
then方法后面再调用另一个then方法。
then链式写法:
- 采用链式的
then,可以指定一组按照次序调用的回调函数。- 这时,前一个回调函数,有可能返回的还是一个
Promise对象(即有异步操作),这时后一个回调函数,就会等待该Promise对象的状态发生变化,才会被调用。
- 例:
getJson('post/1.json').then(
post => getJson(post.commentUrl);
).then(
comments => console.log('resolved:', comments),
err => console.log('error:', err)
)
四、Promise.prototype.catch()
4.1 catch() 用法
Promise.prototype.catch方法是.then(null, rejection)的别名,用于指定发生错误时的回调函数。
4.2 例1
- 【点击打开demo】
- 比较下面两种写法,可以发现
reject方法的作用,等同于抛出错误。
// 写法1
const promise1 = new Promise((resolve, reject) => {
throw new Error('test1');
})
promise1.catch((err) => console.log(err));
// 写法2
const promise2 = new Promise((resolve, reject) => {
try {
throw new Error('test2');
} catch(e) {
reject(e);
}
});
promise2.catch((err) => console.log(err));
4.3 例2
- 如果
Promise状态已经变成resolved,再抛出错误是无效的。Promise在resolve语句后面,再抛出错误,不会被捕获,等于没有抛出。- 因为
Promise的状态一旦改变,就永久保持该状态,不会再变了。
- 【点击打开demo】
const promise1 = new Promise((resolve, reject) => {
resolve('ok!');
throw new Error('test');
})
promise1
.then(val => console.log(val))
.catch((err) => console.log(err));
// ok
4.4 例3
Promise对象的错误具有“冒泡”性质,会一直向后传递,直到被捕获为止。也就是说,错误总是会被下一个catch语句捕获。
- 一共有三个
Promise对象:一个由getJSON产生,两个由then产生。它们之中任何一个抛出的错误,都会被最后一个catch捕获。
- 【点击打开demo】
getJSON('/post/1.json').then(function(post) {
return getJSON(post.commentURL);
}).then(function(comments) {
// some code
}).catch(function(error) {
// 处理前面三个Promise产生的错误
});
4.5 例4
- 一般来说,不要在
then方法里面定义Reject状态的回调函数(即then的第二个参数),总是使用catch方法。
- 第二种写法要好于第一种写法,理由是第二种写法可以捕获前面
then方法执行中的错误,也更接近同步的写法(try/catch)。- 因此,建议总是使用
catch方法,而不使用then方法的第二个参数。
// bad
promise
.then(function(data) {
// success
}, function(err) {
// error
});
// good
promise
.then(function(data) { //cb
// success
})
.catch(function(err) {
// error
});
4.6 例5
- 跟传统的
try/catch代码块不同的是,如果没有使用catch方法指定错误处理的回调函数,Promise对象抛出的错误不会传递到外层代码,即不会有任何反应。
someAsyncThing函数产生的Promise对象,内部有语法错误。浏览器运行到这一行,会打印出错误提示ReferenceError: x is not defined,但是不会退出进程、终止脚本执行,2秒之后还是会输出123。- 这就是说,
Promise内部的错误不会影响到Promise外部的代码,通俗的说法就是“Promise 会吃掉错误”。- 这个脚本放在服务器执行,退出码就是
0(即表示执行成功)。不过,Node有一个unhandledRejection事件,专门监听未捕获的reject错误,上面的脚本会触发这个事件的监听函数,可以在监听函数里面抛出错误。Node有计划在未来废除unhandledRejection事件。如果Promise内部有未捕获的错误,会直接终止进程,并且进程的退出码不为0。
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
// node
process.on('unhandledRejection', function (err, promise) {
throw err;
});
4.7 例6
Promise指定在下一轮“事件循环”再抛出错误。- 到了那个时候,
Promise的运行已经结束了,所以这个错误是在Promise函数体外抛出的,会冒泡到最外层,成了未捕获的错误。
var promise = new Promise((resolve, reject) => {
resolve('ok');
setTimeout(() =>{
throw new Error('test');
}, 0);
});
promise.then(
(value) => {
console.log(value);
}
)
- 建议:
Promise对象后面要跟catch方法,这样可以处理Promise内部发生的错误。catch方法返回的还是一个Promise对象,因此后面还可以接着调用then方法。
4.8 例7
- 运行完
catch方法指定的回调函数,会接着运行后面那个then方法指定的回调函数。如果没有报错,则会跳过catch方法。
var 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
// 没有报错,跳过了catch方法,直接执行后面的then方法。此时,要是then方法里面报错,就与前面的catch无关了。
Promise.resolve()
.catch(function(error) {
console.log('oh no', error);
})
.then(function() {
console.log('carry on');
});
// carry on
4.9 例8
例8:
catch方法之中,还能再抛出错误。
catch方法抛出一个错误,因为后面没有别的catch方法了,导致这个错误不会被捕获,也不会传递到外层。如果改写一下,结果就不一样了。
var 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;
})
.catch((err) => { // 新添代码
console.log(err);
});
// oh no [ReferenceError: x is not defined]
// carry on [ReferenceError: y is not defined]