es6之Promise对象
1. 简介
1、 是一种 异步编程 的解决方案,主要是解决 异步回调 的问题
2、 所谓Promise
,简单说就是一个容器,里面保存着某个未来才会结束的事件(通常是一个异步操作)的结果。从语法上说,Promise 是一个对象,从它可以获取异步操作的消息。Promise 提供统一的 API,各种异步操作都可以用同样的方法进行处理
3、 Promise 让异步操作写起来,就像在写同步操作的流程,不必一层层地嵌套回调函数;可以用同步的方式来书写异步代码
4、 改善了可读性,对于多层嵌套的回调函数很方便
5、 可以充当异步操作与回调函数之间的中介,使得异步操作具备同步操作的接口
- 异步(async): 操作之间没有关系,同时执行多个操作, 代码复杂
- 同步(sync): 同时只能做一件事,代码简单
1.1 Promise对象的2个特点
1、 对象的状态不受外界影响。
Promise
对象代表一个异步操作,有三种状态:pending
(进行中)、fulfilled
(已成功)和rejected
(已失败)。只有异步操作的结果,可以决定当前是哪一种状态,任何其他操作都无法改变这个状态
2、 一旦状态改变,就不会再变,任何时候都可以得到这个结果。
Promise
对象的状态改变,只有两种可能:从pending
变为fulfilled
和从pending
变为rejected
。只要这两种情况发生,状态就凝固了,不会再变了,会一直保持这个结果,这时就称为 resolved(已定型)
如果改变已经发生了,你再对
Promise
对象添加回调函数,也会立即得到这个结果这与事件(Event)完全不同,事件的特点是,如果你错过了它,再去监听,是得不到结果的。
1.2 Promise的状态
Pending:初始状态,既不是成功状态,也不是失败状态
Fulfilled(或resolved):操作成功状态
Rejected:操作失败状态
Promise对象的状态转换:只能从pending状态变成fulfilled状态,或从pending状态变成
rejected状态,不会有其他状态之间的转变
1.3 Promise的一些缺点
1、 无法取消Promise
,一旦新建它就会立即执行,无法中途取消
2、 如果不设置回调函数,Promise
内部抛出的错误,不会反应到外部
3、 当处于pending
状态时,无法得知目前进展到哪一个阶段(刚刚开始还是即将完成)
2. Promise 定义和使用
2.1 定义
ES6 规定,Promise
对象是一个构造函数,用来生成Promise
实例,定义如下:
const promise = new Promise(function(resolve, reject) {
// ... some code
if (/* 异步操作成功 */){
resolve(value);
} else {
reject(error);
}
});
Promise
构造函数接受一个函数作为参数,该函数的两个参数分别是resolve
和reject
resolve
函数的作用是:将Promise
对象的状态从“未完成”变为“成功”(即从 pending 变为 resolved),在异步操作成功时调用,并将异步操作的结果,作为参数传递出去;
reject
函数的作用是:将Promise
对象的状态从“未完成”变为“失败”(即从 pending 变为 rejected),在异步操作失败时调用,并将异步操作报出的错误,作为参数传递出去。
一个例子:
const fs = require('fs');
// 1. 创建一个 Promise 构造函数
const promise = new Promise((resolve, reject) => {
// 异步读取文件
fs.readFile('./data/a.txt', 'utf8', function(err, data) {
if (err) {
// 把容器的Pending状态改为 Rejected
reject(err);
} else {
// 把容器的Pending状态改为 Resolved
resolve(data);
};
})
})
2.2 使用
Promise
实例生成以后,可以用then
方法分别指定resolved
状态和rejected
状态的回调函数
then方法可以接受两个回调函数作为参数:
第一个回调函数是Promise对象的状态变为 resolved 时调用,
第二个回调函数是Promise对象的状态变为 rejected 时调用。
这两个函数都是可选的,不一定要提供。它们都接受Promise对象传出的值作为参数
/* then 方法接收的 第一个 functon 就是 容器中的 resolve 函数 返回的数据
第二个 functon 就是 容器中的 reject 函数 返回的数据
*/
// 方式一:普通 函数写法
promise.then(function(value) {
// success
}, function(error) {
// failure
});
// 方式二:箭头 函数写法
promise.then(res => {
console.log(res);
// res 是 定义Promise的时候,resoleve传递出来的 数据
}, error => {
console.log(result);
})
// 方式二:(推荐写法,使用catch来捕获异常)
promise.then(res => {
console.log(res);
}).catch(err => {
console.log(err);
})
2.3 使用注意
2.3.1 Promise创建后就会立即执行
let promise = new Promise(function(resolve, reject) {
console.log('Promise 1');
resolve();
});
promise.then(function() {
console.log('resolved. 2');
});
console.log('Hi! 3');
// Promise 1
// Hi! 3
// resolved 2
Promise 新建后立即执行,所以首先输出的是Promise
。然后,then
方法指定的回调函数,将在当前脚本所有同步任务执行完才会执行,所以resolved
最后输出
2.3.2 Resolve函数的参数还可以是Promise对象
resolve
函数的参数除了正常的值以外,还可能是另一个 Promise 实例
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) {
// ...
});
const p2 = new Promise(function (resolve, reject) {
// ...
resolve(p1);
})
一个例子:
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
方法指定的回调函数
2.3.3 调用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);
})
3 一些例子
3.1 按照顺序执行多个异步函数例子
const fs = require('fs');
// 创建一个Promise容器 p1
const p1 = new Promise(function(resolve, reject) {
fs.readFile('./data/a.txt', 'utf8', function(err, data) {
if (err) {
reject(err);
} else {
resolve(data);
};
})
})
// 创建一个Promise容器 p2
const p2 = new Promise(function(resolve, reject) {
fs.readFile('./data/b.txt', 'utf8', function(err, data) {
if (err) {
reject(err);
} else {
resolve(data);
};
})
})
// 创建一个Promise容器 p3
const p3 = new Promise(function(resolve, reject) {
fs.readFile('./data/c.txt', 'utf8', function(err, data) {
if (err) {
reject(err);
} else {
resolve(data);
};
})
})
p1
.then(function(res) {
console.log(res);
return p2;
}, function(err) {
console.log(res)
})
.then(function(res) {
// 此处的执行是p2的结果
console.log(res);
return p3;
})
.then(function(res) {
// 此处的执行是p3的结果
console.log(res);
})
// 当 p1 读取成功的时候
// 当前函数中 return 的结果就可以在后面的 then 中 function 接收到
// 当 return 一个 Promise 对象的时候(例如 p2 p3),后续的 then 中的 方法的第一个参数会作为 p2 p3 的 resolve
封装一下上面的读取文件
const fs = require('fs');
// 封装一个读取文件的方法
function readFile_promise(filePath) {
return new Promise(function(resolve, reject) {
fs.readFile(filePath, 'utf8', function(err, data) {
if (err) {
reject(err);
} else {
resolve(data);
};
})
})
}
readFile_promise('./data/a.txt')
.then(function(res) {
console.log(res);
return readFile_promise('./data/b.txt');
}, function(err) {
console.log(res)
})
.then(function(res) {
console.log(res);
return readFile_promise('./data/c.txt');
})
.then(function(res) {
console.log(res)
})
3.2 异步加载图片的例子
// 使用Promise包装了一个图片加载的异步操作。如果加载成功,就调用resolve方法,否则就调用reject方法
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;
});
}
3.3 用Promise
对象实现的 Ajax 操作的例子
getJSON
是对 XMLHttpRequest
对象的封装,用于发出一个针对 JSON 数据的 HTTP 请求,并且返回一个Promise
对象。
需要注意的是,在getJSON
内部,resolve
函数和reject
函数调用时,都带有参数;如果调用resolve
函数和reject
函数时带有参数,那么它们的参数会被传递给回调函数
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);
});
4 Promise.prototype.then()
Promise 实例具有then
方法,也就是说,then
方法是定义在原型对象Promise.prototype
上的。它的作用是为 Promise 实例添加状态改变时的回调函数。
then方法的第一个参数是
resolved状态的回调函数,第二个参数是
rejected`状态的回调函数,它们都是可选的。
then
方法返回的是一个新的Promise
实例(注意,不是原来那个Promise
实例)。因此可以采用链式写法,即then
方法后面再调用另一个then
方法
// 代码使用then方法,依次指定了两个回调函数。第一个回调函数完成以后,会将返回结果作为参数,传入第二个回调函数
getJSON("/posts.json").then(function(json) {
return json.post;
}).then(function(post) {
// ...
});
5 Promise.prototype.catch()
比较好捕获错误的写法:
promise
.then(function(data) { //cb
// success
})
.catch(function(err) {
// error
});
Promise.prototype.catch()
方法是.then(null, rejection)
或.then(undefined, rejection)
的别名,用于指定发生错误时的回调函数
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));
Promise 对象的错误具有“冒泡”性质,会一直向后传递,直到被捕获为止。也就是说,错误总是会被下一个catch
语句捕获
getJSON('/post/1.json').then(function(post) {
return getJSON(post.commentURL);
}).then(function(comments) {
// some code
}).catch(function(error) {
// 处理前面三个Promise产生的错误
});
6 Promise.prototype.finally()
finally()
方法用于指定不管 Promise 对象最后状态如何,都会执行的操作(es2018标准引入)
// 不管promise最后的状态,在执行完then或catch指定的回调函数以后,都会执行finally方法指定的回调函数
promise
.then(result => {···})
.catch(error => {···})
.finally(() => {···});
finally
方法的回调函数不接受任何参数,这意味着没有办法知道,前面的 Promise 状态到底是fulfilled
还是rejected
。这表明,finally
方法里面的操作,应该是与状态无关的,不依赖于 Promise 的执行结果
一个例子:服务器使用 Promise 处理请求,然后使用finally
方法关掉服务器
server.listen(port)
.then(function () {
// ...
})
.finally(server.stop);
7 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
的回调函数
1)只有p1
、p2
、p3
的状态都变成fulfilled
,p
的状态才会变成fulfilled
,此时p1
、p2
、p3
的返回值组成一个数组,传递给p
的回调函数。
(2)只要p1
、p2
、p3
之中有一个被rejected
,p
的状态就变成rejected
,此时第一个被reject
的实例的返回值,会传递给p
的回调函数
8 Promise.race()
romise.race()
方法同样是将多个 Promise 实例,包装成一个新的 Promise 实例
const p = Promise.all([p1, p2, p3]);
只要p1
、p2
、p3
之中有一个实例率先改变状态,p
的状态就跟着改变。那个率先改变的 Promise 实例的返回值,就传递给p
的回调函数
9 Promise.resolve()
主要作用是:将现有对象转为 Promise 对象
// 将 jQuery 生成的deferred对象,转为一个新的 Promise 对象
const jsPromise = Promise.resolve($.ajax('/whatever.json'));
Promise.resolve()
方法的参数分成四种情况
1、 参数是一个 Promise 实例
如果参数是 Promise 实例,那么Promise.resolve
将不做任何修改、原封不动地返回这个实例
2、 参数是一个thenable
对象
thenable
对象指的是具有then
方法的对象
Promise.resolve()
方法会将这个对象转为 Promise 对象,然后就立即执行thenable
对象的then()
方法
// 定义一个具有 then方法的对象
let thenable = {
then: function(resolve, reject) {
resolve(42);
}
};
let p1 = Promise.resolve(thenable);
p1.then(function (value) {
console.log(value); // 42
});
3、 参数不是具有then()
方法的对象,或根本就不是对象
如果参数是一个原始值,或者是一个不具有then()
方法的对象,则Promise.resolve()
方法返回一个新的 Promise 对象,状态为resolved
const p = Promise.resolve('Hello');
p.then(function (s) {
console.log(s)
});
// Hello
4、 不带有任何参数
Promise.resolve()
方法允许调用时不带参数,直接返回一个resolved
状态的 Promise 对象
如果希望得到一个 Promise 对象,就可以直接调用Promise.resolve()
方法
const p = Promise.resolve();
p.then(function () {
// ...
});
需要注意的是,立即resolve()
的 Promise 对象,是在本轮“事件循环”(event loop)的结束时执行,而不是在下一轮“事件循环”的开始时
// setTimeout(fn, 0)在下一轮“事件循环”开始时执行
setTimeout(function () {
console.log('three');
}, 0);
// Promise.resolve()在本轮“事件循环”结束时执行
Promise.resolve().then(function () {
console.log('two');
});
// 立即执行
console.log('one');
// one
// two
// three
10 Promise.reject()
Promise.reject(reason)
方法也会返回一个新的 Promise
实例,该实例的状态为rejected
Promise.reject()
方法的参数,会原封不动地作为reject
的理由,变成后续方法的参数
Promise.reject('出错了')
.catch(e => {
console.log(e === '出错了')
})
// true