带你快速入门ES6中的Promise对象

带你快速入门ES6中的Promise对象

什么是Promise?

Promise 是异步编程的一种解决方案，比传统的解决方案——回调函数和事件——更合理和更强大。它由社区最早提出和实现，ES6 将其写进了语言标准，统一了用法，原生提供了Promise对象。

所谓Promise，简单说就是一个容器，里面保存着某个未来才会结束的事件（通常是一个异步操作）的结果。从语法上说，Promise 是一个对象，从它可以获取异步操作的消息。Promise 提供统一的 API，各种异步操作都可以用同样的方法进行处理。

Promise对象的两个特点：

• 对象的状态不受外界影响。Promise对象代表一个异步操作，有三种状态：pending（进行中）、fulfilled（已成功）和rejected（已失败）

• 一旦状态改变，就不会再变，任何时候都可以得到这个结果。Promise对象的状态改变，只有两种可能：从pending变为fulfilled和从pending变为rejected。

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
});

then方法可以接受两个回调函数作为参数。第一个回调函数是Promise对象的状态变为resolved时调用，第二个回调函数是Promise对象的状态变为rejected时调用。这两个函数都是可选的，不一定要提供。它们都接受Promise对象传出的值作为参数。而且Promise 新建后就会立即执行。

下面我们来看两个例子

1. 通过resolve函数将Promise对象的状态从“未完成”变为“成功”

let p = new Promise(function(resolve,reject){
	console.log("立刻执行")
	resolve('Promise对象的状态变为resolved时调用');
});

console.log("==========")


p.then(function(resolved){
   console.log(resolved);
});

上面代码中，Promise 新建后立即执行，所以首先输出的是立刻执行。然后，then方法指定的回调函数，将在当前脚本所有同步任务执行完才会执行，所以resolved最后输出。

2. 通过reject函数将Promise对象的状态从“未完成”变为“失败”

let p = new Promise(function(resolve,reject){
	console.log("立刻执行")
	reject('Promise对象的状态变为rejected时调用');
});


p.then(function(resolved){
	console.log("成功");
},function(rejected){
	 console.log(rejected);
});

3. 在异步操作失败时，会调用reject函数并将异步操作报出的错误，作为参数传递出去

let p = new Promise(function(resolve,reject){
	console.log("立刻执行")
	throw new Error('异步操作失败');
});


p.then(function(resolved){
	console.log("成功");
},function(rejected){
	 console.log(rejected);
});

从上面可以看出如果在Promise中使用 throw 语句的话，最终promise对象也变为Rejected状态。

但实际开发中我们更加推荐，使用reject的方法，上面的代码改写成下面这种方式

let p = new Promise(function(resolve,reject){
	console.log("立刻执行")
	reject(new Error('异步操作失败'));
});


p.then(function(resolved){
	console.log("成功");
},function(rejected){
	 console.log(rejected);
});

关于为什么推荐使用reject而不是throw的话，可以参考下这篇文章：使用reject而不是throw

resolve函数的参数除了正常的值以外，还可能是另一个 Promise 实例，比如像下面这样

const p1 = new Promise(function (resolve, reject) {
  console.log("p1 立刻执行")
  setTimeout(() => {
	console.log("p1 setTimeout 执行")
	reject(new Error('fail'))
  }, 3000)
})

const p2 = new Promise(function (resolve, reject) {
  console.log("p2 立刻执行")
  setTimeout(() => {
  console.log("p2 setTimeout 执行")
	resolve(p1)
  }, 1000)
})

p1.then(result => console.log("p1 异步成功",result))
.catch(error => console.log("p1 异步失败"))

p2.then(result => console.log("p2 异步成功",result))
.catch(error => console.log("p2 异步失败",error))

const p1 = new Promise(function (resolve, reject) {
  console.log("p1 立刻执行")
  setTimeout(() => {
	console.log("p1 setTimeout 执行")
	resolve("p1 执行 resolve")
  }, 3000)
})

const p2 = new Promise(function (resolve, reject) {
  console.log("p2 立刻执行")
  setTimeout(() => {
  console.log("p2 setTimeout 执行")
	resolve(p1)
  }, 1000)
})

p1.then(result => console.log("p1 异步成功",result))
.catch(error => console.log("p1 异步失败"))

p2
  .then(result => console.log("p2 异步成功",result))
  .catch(error => console.log("p2 异步失败",error))

上面的代码就是把p1的状态就会传递给p2，也就是说，p1的状态决定了p2的状态。如果p1的状态是pending，那么p2的回调函数就会等待p1的状态改变；如果p1的状态已经是resolved或者rejected，那么p2的回调函数将会立刻执行。

还有一点需要注意到的是，调用resolve或reject并不会终结 Promise 的参数函数的执行

上面代码中，调用resolve(1)以后，后面的console.log(2)还是会执行，并且会首先打印出来。这是因为立即 resolved 的 Promise 是在本轮事件循环的末尾执行，总是晚于本轮循环的同步任务。

一般来说，调用resolve或reject以后，Promise 的使命就完成了，后继操作应该放到then方法里面，而不应该直接写在resolve或reject的后面。所以，最好在它们前面加上return语句，这样就不会有意外。

Promise.prototype.then()

Promise 实例具有then方法，也就是说，then方法是定义在原型对象Promise.prototype上的。它的作用是为 Promise 实例添加状态改变时的回调函数。

它的作用是为 Promise 实例添加状态改变时的回调函数。前面说过，then方法的第一个参数是resolved状态的回调函数，第二个参数是rejected状态的回调函数，它们都是可选的。

then方法返回的是一个新的Promise实例（注意，不是原来那个Promise实例）。关于每次调用then方法都会返回一个新创建的promise对象，可以参考这篇文章：专栏: 每次调用then都会返回一个新创建的promise对象

因此可以采用链式写法，即then方法后面再调用另一个then方法。

const p1 = new Promise(function(resolve,reject){
	resolve('success')
});

const p2 = p1.then(function(resolved){
	console.log(resolved)
});

console.log(p1);
console.log(p2);
console.log(p1 === p2)

const p1 = new Promise(function(resolve,reject){
	resolve('success')
});

const p2 = p1.then(function(resolved){
	return "test" + resolved
});

p2.then(function(resolved){
	console.log(resolved)
})

还有下面这个例子, 跟上面resolve函数的参数除了正常的值以外，还可能是另一个 Promise 实例是一样的情况。

const p1 = new Promise(function(resolve,reject){
	resolve('success')
});

const p2 = p1.then(function(resolved){
	return new Promise(function(resolve,reject){
		setTimeout(() => {
			console.log("p1 setTimeout 执行")
			resolve("p1 执行 resolve")
		 }, 3000)
	}).then(function(res){
		return 'test'
	});
});

const p3 = p2.then(function(resolved){
	console.log('2',resolved)
});

p1.then方法指定的回调函数，返回的是另一个Promise对象。这时，p2.then方法指定的回调函数，就会等待这个新的Promise对象状态发生变化,才会调用p2.then的回调

Promise.prototype.catch()

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));

在异步操作中抛出错误，状态就会变为rejected，就会调用catch()方法指定的回调函数，处理这个错误。另外，then()方法指定的回调函数，如果运行中抛出错误，也会被catch()方法捕获

let p = new Promise(function(resolve,reject){
	throw new Error('失败')
});

p.catch(error=>{
	console.log(error)
})

let p = new Promise(function(resolve,reject){
	try{
		throw new Error('失败');
	}catch(error){
		reject(error);
	}

});

p.catch(error=>{
	console.log(error)
})

下面这两种写法是等价的。

// 写法一
const promise = new Promise(function(resolve, reject) {
  try {
    throw new Error('test');
  } catch(e) {
    reject(e);
  }
});
promise.catch(function(error) {
  console.log(error);
});

// 写法二
const promise = new Promise(function(resolve, reject) {
  reject(new Error('test'));
});
promise.catch(function(error) {
  console.log(error);
});

比较上面两种写法，可以发现reject()方法的作用，等同于抛出错误…

如果在then()方法指定的回调函数运行中抛出错误，也会被catch()方法捕获

let p = new Promise(function(resolve,reject){
	resolve('sucess')
});

p.then((resolved)=>{
	console.log(resolved)
	throw new Error('失败');
}).catch(error=>{
	console.log('error:',error)
})

但如果你catch和then的顺序调换的话，就没法被catch()方法捕获.

let p = new Promise(function(resolve,reject){
	resolve('sucess')
});

p.catch(error=>{
	console.log('error:',error)
}).then((resolved)=>{
	console.log(resolved)
	throw new Error('失败');
})

因为Promise 对象的错误具有“冒泡”性质，会一直向后传递，直到被捕获为止。也就是说，错误总是会被下一个catch语句捕获。

因为有“冒泡”性质，catch中能捕获到前面then方法或catch方法中抛出的错误，因此在实际开发中，我们更推荐使用catch(error),而不使用then中的第二个参数去捕获。.then(null, err)

// bad
new Promise(function(resolve,reject){
	resolve('sucess')
}).then(function(data) {
    throw new Error('失败');
  }, function(err) {
    console.log("error:",err)
  });

// good
new Promise(function(resolve,reject){
	resolve('sucess')
}).then(function(data) {
     throw new Error('失败2');
  })
  .catch(function(err) {
    console.log("error:",err)
  });

上面代码中，第二种写法要好于第一种写法，理由是第二种写法可以捕获前面then方法执行中的错误，也更接近同步的写法（try/catch）。因此，建议总是使用catch()方法，而不使用then()方法的第二个参数。

关于使用then还是使用catch？可以参考这篇文章： then or catch?

跟传统的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);

上面代码中，someAsyncThing()函数产生的 Promise 对象，内部有语法错误。浏览器运行到这一行，会打印出错误提示ReferenceError: x is not defined，但是不会退出进程、终止脚本执行，2 秒之后还是会输出123。这就是说，Promise 内部的错误不会影响到Promise 外部的代码，通俗的说法就是“Promise 会吃掉错误”。

所以在实际的开发中推荐Promise 对象后面要跟catch()方法，这样可以处理Promise 内部发生的错误。catch()方法返回的还是一个 Promise 对象，因此后面还可以接着调用then()方法。

还有一点需要注意的是，如果 Promise 状态已经变成resolved，再抛出错误是无效的。

const promise = new Promise(function(resolve, reject) {
  resolve('ok');
  throw new Error('test');
});
promise
  .then(function(value) { console.log(value) })
  .catch(function(error) { console.log(error) });

上面代码中，Promise 在resolve语句后面，再抛出错误，不会被捕获，等于没有抛出。因为 Promise 的状态一旦改变，就永久保持该状态，不会再变了。

Promise.prototype.finally()

finally()方法用于指定不管 Promise 对象最后状态如何，都会执行的操作。不管promise最后的状态，在执行完then或catch指定的回调函数以后，都会执行finally方法指定的回调函数。finally方法的回调函数不接受任何参数，这意味着没有办法知道，前面的 Promise 状态到底是fulfilled还是rejected。这表明，finally方法里面的操作，应该是与状态无关的，不依赖于 Promise 的执行结果。

finally本质上是then方法的特例。

promise
.finally(() => {
  // 语句
});

// 等同于
promise
.then(
  result => {
    // 语句
    return result;
  },
  error => {
    // 语句
    throw error;
  }
);

上面代码中，如果不使用finally方法，同样的语句需要为成功和失败两种情况各写一次。有了finally方法，则只需要写一次

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 实例。

const p1 = new Promise((resolve,reject)=>{
	resolve('p1')
})

const p2 = new Promise((resolve,reject)=>{
	resolve('p2')
})

const p3 = new Promise((resolve,reject)=>{
	resolve('p3')
})



const promises = [p1,p2,p3];

Promise.all(promises).then(datas => {
	console.log(datas)
}).catch(error => {
	console.log(error)
})

const p1 = new Promise((resolve,reject)=>{
	resolve('p1')
})

const p2 = new Promise((resolve,reject)=>{
	reject('p2 reject')
})

const p3 = new Promise((resolve,reject)=>{
	resolve('p3')
})



const promises = [p1,p2,p3];

Promise.all(promises).then(datas => {
	console.log(datas)
}).catch(error => {
	console.log(error)
})

上面的代码中promises的状态由p1、p2、p3决定，分成两种情况。

1. 只有p1、p2、p3的状态都变成fulfilled，promises的状态才会变成fulfilled，此时p1、p2、p3的返回值组成一个数组，传递给promises的回调函数。
2. 只要p1、p2、p3之中有一个被rejected，promises的状态就变成rejected，此时第一个被reject的实例的返回值，会传递给promises的回调函数。

注意，如果作为参数的 Promise 实例，自己定义了catch方法，那么它一旦被rejected，并不会触发Promise.all()的catch方法。

const p1 = new Promise((resolve,reject)=>{
	resolve('p1')
})

const p2 = new Promise((resolve,reject)=>{
    throw new Error('报错了');
}).catch(error => error)

const p3 = new Promise((resolve,reject)=>{
	resolve('p3')
})



const promises = [p1, p2, p3];

Promise.all(promises).then(datas => {
	console.log(datas)
}).catch(error => {
	console.log(error)
})

上面代码中，p1会resolved，p2首先会rejected，但是p2有自己的catch方法，该方法返回的是一个新的 Promise 实例，p2指向的实际上是这个实例。该实例执行完catch方法后，也会变成resolved，导致Promise.all()方法参数里面的两个实例都会resolved，因此会调用then方法指定的回调函数，而不会调用catch方法指定的回调函数。

Promise.race()

Promise.race()方法同样是将多个 Promise 实例，包装成一个新的 Promise 实例。Promise.race()方法的参数与Promise.all()方法一样，如果不是 Promise 实例，就会将参数转为 Promise 实例，再进一步处理。

const p1 = new Promise((resolve,reject)=>{
	setTimeout(() => resolve('p1'),3000)
})

const p2 = new Promise((resolve,reject)=>{
	setTimeout(() => resolve('p2'),1000)
})

const p3 = new Promise((resolve,reject)=>{
	setTimeout(() => resolve('p3'),1000)
})



const promises = [p1, p2, p3];

Promise.race(promises).then(data => {
	console.log(data)
}).catch(error => {
	console.log(error)
})

const p1 = new Promise((resolve,reject)=>{
	setTimeout(() => resolve('p1'),4000)
})

const p2 = new Promise((resolve,reject)=>{
	setTimeout(() => resolve('p2'),5000)
})

const p3 = new Promise((resolve,reject)=>{
	setTimeout(() => reject(new Error("timeout...")),3000)
})



const promises = [p1, p2, p3];

Promise.race(promises).then(data => {
	console.log(data)
}).catch(error => {
	console.log(error)
})

上面代码中，只要p1、p2、p3之中有一个实例最先改变状态，p的状态就跟着改变。那个最先改变的 Promise 实例的返回值，就传递给promises的回调函数。

Promise.allSettled()

Promise.allSettled()方法，用来确定一组异步操作是否都结束了（不管成功或失败）。所以，它的名字叫做Settled，包含了fulfilled和rejected两种情况。

Promise.allSettled()方法接受一个数组作为参数，数组的每个成员都是一个 Promise 对象，并返回一个新的 Promise 对象。只有等到参数数组的所有 Promise 对象都发生状态变更（不管是fulfilled还是rejected），返回的 Promise 对象才会发生状态变更。返回的新的 Promise 实例，一旦发生状态变更，状态总是fulfilled，不会变成rejected。状态变成fulfilled后，它的回调函数会接收到一个数组作为参数，该数组的每个成员对应前面数组的每个 Promise 对象

const p1 = new Promise((resolve,reject)=>{
	resolve('p1')
})

const p2 = new Promise((resolve,reject)=>{
	reject('p2 reject')
})

const allSettledPromise = Promise.allSettled([p1, p2]);


allSettledPromise.then(function (results) {
  console.log(results);
});

上面代码最后的results结果的每一个成员都是一个对象，格式是固定的，对应异步操作的结果。成员对象的status属性的值只可能是字符串fulfilled或字符串rejected，用来区分异步操作是成功还是失败。如果是成功（fulfilled），对象会有value属性，如果是失败（rejected），会有reason属性，对应两种状态时前面异步操作的返回值。

Promise.any()

Promise.any()方法接受一组 Promise 实例作为参数，包装成一个新的 Promise实例返回。只要参数实例有一个变成fulfilled状态，包装实例就会变成fulfilled状态；如果所有参数实例都变成rejected状态，包装实例就会变成rejected状态。

Promise.any()跟Promise.race()方法很像，只有一点不同，就是Promise.any()不会因为某个 Promise 变成rejected状态而结束，必须等到所有参数 Promise 变成rejected状态才会结束

const p1 = new Promise((resolve,reject)=>{
	setTimeout(() => resolve('p1'),1000)
})

const p2 = new Promise((resolve,reject)=>{
	setTimeout(() => reject('p2 reject'),10000)
})


const anyPromise = Promise.any([p1, p2]);


anyPromise.then(function (result) {
  console.log(result);
});

上面的代码中Promise.any()方法的参数数组包含两个 Promise 操作。其中只要有一个变成fulfilled，Promise.any()返回的 Promise 对象就变成fulfilled

const p1 = new Promise((resolve,reject)=>{
	setTimeout(() => reject('p1 reject'),1000)
})

const p2 = new Promise((resolve,reject)=>{
	setTimeout(() => reject('p2 reject'),10000)
})


const anyPromise = Promise.any([p1, p2]);


anyPromise.then(function (result) {
  console.log(result);
}).catch(error => console.log(error));

上面的代码中如果两个异步操作的结果都是rejected，那么最后就会抛出AggregateError 错误实例

总结：Promise.all()和Promise.race()和Promise.allSettled()和Promise.any()在特性上都有一些相似之处

1. 都是用于将多个 Promise 实例，包装成一个新的 Promise 实例。
2. 如果参数不是一个Promise 实例，则会转为Promise 实例，再进一步处理
3. 如果作为参数的 Promise实例，自己定义了catch方法，那么它一旦被rejected，并不会触发Promise.xxx()方法的catch方法。

Promise.resolve()

Promise.resolve()方法是将现有对象转换为Promise对象。

Promise.resolve()等价于下面的写法。

Promise.resolve('foo')
// 等价于
new Promise(resolve => resolve('foo'))

Promise.resolve()方法的参数分成四种情况

1. 参数是一个 Promise 实例
   如果参数是 Promise 实例，那么Promise.resolve将不做任何修改、原封不动地返回这个实例。

const p1 = new Promise((resolve,reject)=>{
	resolve('p1')
});


const p2 = Promise.resolve(p1);

console.log(p1 === p2)

2. 参数是一个thenable对象
   thenable对象指的是具有then方法的对象，比如下面这个对象。

let thenable = {
  then: function(resolve, reject) {
    resolve(42);
  }
};

Promise.resolve()方法会将这个对象转为 Promise 对象，然后就立即执行thenable对象的then()方法。

let thenable = {
  then: function(resolve, reject) {
    resolve(42);
  }
};

let p1 = Promise.resolve(thenable);
p1.then(function (value) {
  console.log(value);  // 42
});

关于Promise.resolve和thenable对象可以参考这篇文章：Promise.resolve

3. 参数不是具有then()方法的对象，或根本就不是对象

如果参数是一个原始值，或者是一个不具有then()方法的对象，则Promise.resolve()方法返回一个新的 Promise 对象，状态为resolved

const p = Promise.resolve('Hello');

p.then(function (s) {
  console.log(s)
});
// Hello

上面代码生成一个新的 Promise 对象的实例p。由于字符串Hello不属于异步操作（判断方法是字符串对象不具有 then 方法），返回 Promise 实例的状态从一生成就是resolved，所以回调函数会立即执行。Promise.resolve()方法的参数，会同时传给回调函数。

4. 不带有任何参数

Promise.resolve()方法允许调用时不带参数，直接返回一个resolved状态的 Promise 对象。

const p = Promise.resolve();

p.then(function () {
  // ...
});

需要注意的是，立即resolve()的 Promise 对象，是在本轮“事件循环”（event loop）的结束时执行，而不是在下一轮“事件循环”的开始时。

setTimeout(function () {
  console.log('three');
}, 0);

Promise.resolve().then(function () {
  console.log('two');
});

console.log('one');

//和上面等价
 
setTimeout(function () {
  console.log('three');
}, 0);

new Promise((resolve,reject) => resolve()).then(function () {
  console.log('two');
});

console.log('one');

上面代码中，setTimeout(fn, 0)在下一轮“事件循环”开始时执行，Promise.resolve()在本轮“事件循环”结束时执行，console.log('one')则是立即执行，因此最先输出。

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)
});
// 出错了

上面代码生成一个 Promise 对象的实例p，状态为rejected，回调函数会立即执行。

Promise.reject()方法的参数，会原封不动地作为reject的理由，变成后续方法的参数。

Promise.reject('出错了')
.catch(e => {
  console.log(e === '出错了')
})
// true

参考

Promise 对象

使用 Promise

使用Promise进行顺序（sequence）处理

使用reject而不是throw

构建Promise队列实现异步函数顺序执行

Promise学习笔记