ECMAScript Promise对象

Promise的含义

Promise ,简单说就是一个容器,里面保存着某个未来才会结束的事件(通常是一个异步操作)的结果。从语法上说,Promise是一个对象,从它可以获取异步操作的消息。Promise提供统一的API,各种异步操作都可以用同样的方法进行处理。
Promise 对象有以下两个特点
(1)对象的状态不受外界影响。 Promise 对象代表一个异步操作,有三种状态: Pending (进行中)、 Resolved (已完成,又称Fulfilled)和 Rejected (已失败)。只有异步操作的结果,可以决定当前是哪一种状态,任何其他操作都无法改变这个状态。
(2)一旦状态改变,就不会再变,任何时候都可以得到这个结果。 Promise 对象的状态改变,只有两种可能:从 Pending 变为 Resolved 和从 Pending 变为 Rejected 。只要这两种情况发生,状态就凝固了,不会再变了,会一直保持这个结果。就算改变已经发生了,你再对 Promise 对象添加回调函数,也会立即得到这个结果。这与事件(Event)完全不同,事件的特点是,如果你错过了它,再去监听,是得不到结果的。
有了 Promise 对象,就可以将异步操作以同步操作的流程表达出来,避免了层层嵌套的回调函数。此外, Promise 对象提供统一的接口,使得控制异步操作更加容易。
Promise 也有一些缺点。首先,无法取消 Promise ,一旦新建它就会立即执行,无法中途取消。其次,如果不设置回调函数, Promise 内部抛出的错误,不会反应到外部。第三,当处于 Pending 状态时,无法得知目前进展到哪一个阶段(刚刚开始还是即将完成)。

基本用法

创造了一个Promise实例

var 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状态和Reject状态的回调函数。

promise.then(function(value) {
   // success
}, function(error) {
   // failure
});

then 方法可以接受两个回调函数作为参数。第一个回调函数是Promise对象的状态变为Resolved时调用,第二个回调函数是Promise对象的状态变为Reject时调用。其中,第二个函数是可选的,不一定要提供。这两个函数都接受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(function(resolve, reject) {
   console.log('Promise');
   resolve();
});
promise.then(function() {
   console.log('Resolved.');
});
console.log('Hi!');
// Promise
// Hi!
// Resolved

上面代码中,Promise新建后立即执行,所以首先输出的是“Promise”。然后, then 方法指定的回调函数,将在当前脚本所有同步任务执行完才会执行,所以“Resolved”最后输出。
异步加载图片

function loadImageAsync(url) {
   return new Promise(function(resolve, reject) {
      var image = new Image();
      image.onload = function() {
         resolve(image);
      };
      image.onerror = function() {
         reject(new Error('Could not load image at ' + url));
      };
      image.src = url;
   });
}

用Promise对象实现的Ajax操作

var getJSON = function(url) {
   var promise = new Promise(function(resolve, reject){
      var client = new XMLHttpRequest();
      client.open("GET", url);
      client.onreadystatechange = handler;
      client.responseType = "json";
      client.setRequestHeader("Accept", "application/json");
      client.send();
      function handler() {
         if (this.readyState !== 4) {
            return;
         }
         if (this.status === 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);
});

getJSON 是对XMLHttpRequest对象的封装,用于发出一个针对JSON数据的HTTP请求,并且返回一个Promise对象。需要注意的是,在 getJSON 内部, resolve 函数和 reject 函数调用时,都带有参数

如果调用 resolve 函数和 reject 函数时带有参数,那么它们的参数会被传递给回调函数。 reject 函数的参数通常是Error对象的实例,表示抛出的错误; resolve 函数的参数除了正常的值以外,还可能是另一个Promise实例,表示异步操作的结果有可能是一个值,也有可能是另一个异步操作,比如像下面这样。

var p1 = new Promise(function(resolve, reject){
   // ...
});
var 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 的回调函数将会立刻执行。

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))
p2.catch(error => console.log(error))
// Error: fail

p1 是一个Promise,3秒之后变为 rejected 。 p2 的状态由 p1 决定,1秒之后, p2 调用 resolve 方法,但是此时 p1 的状态还没有改变,因此 p2 的状态也不会变。又过了2秒, p1 变为 rejected , p2 也跟着变为 rejected 。

Promise.prototype.then()

Promise实例具有 then 方法,也就是说, then 方法是定义在原型对象Promise.prototype上的。它的作用是为Promise实例添加状态改变时的回调函数。前面说过, then 方法的第一个参数是Resolved状态的回调函数,第二个参数(可选)是Rejected状态的回调函数。
then 方法返回的是一个新的Promise实例(注意,不是原来那个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.prototype.catch 方法是 .then(null, rejection) 的别名,用于指定发生错误时的回调函数

getJSON("/posts.json").then(function(posts) {
   // ...
}).catch(function(error) {
   // 处理 getJSON 和 前一个回调函数运行时发生的错误
   console.log('发生错误!', error);
});

上面代码中, getJSON 方法返回一个Promise对象,如果该对象状态变为 Resolved ,则会调用 then 方法指定的回调函数;如果异步操作抛出错误,状态就会变为 Rejected ,就会调用 catch 方法指定的回调函数,处理这个错误。另外, then 方法指定的回调函数,如果运行中抛出错误,也会被 catch 方法捕获。

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));
var promise = new Promise(function(resolve, reject) {
   throw new Error('test');
});
promise.catch(function(error) {
   console.log(error);
});
// Error: test

上面代码中, promise 抛出一个错误,就被 catch 方法指定的回调函数捕获。注意,上面的写法与下面两种写法是等价的。

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

比较上面两种写法,reject 方法的作用相当于抛出错误。
如果Promise状态已经变成 Resolved ,再抛出错误是无效的。

var 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) });
// ok

Promise在 resolve 语句后面,再抛出错误,不会被捕获,等于没有抛出。
Promise对象的错误具有“冒泡”性质,会一直向后传递,直到被捕获为止。也就是说,错误总是会被下一个 catch 语句捕获。

getJSON("/post/1.json").then(function(post) {
   return getJSON(post.commentURL);
}).then(function(comments) {
   // some code
}).catch(function(error) {
   // 处理前面三个Promise产生的错误
});

上面代码中,一共有三个Promise对象:一个由 getJSON 产生,两个由 then 产生。它们之中任何一个抛出的错误,都会被最后一个 catch 捕获。
一般来说,不要在 then 方法里面定义Reject状态的回调函数(即 then 的第二个参数),总是使用 catch 方法。

// bad
promise
   .then(function(data) {
      // success
   }, function(err) {
      // error
   });
// good
promise
   .then(function(data) { //cb
      // success
   })
   .catch(function(err) {
      // error
   });

上面代码中,第二种写法要好于第一种写法,理由是第二种写法可以捕获前面 then 方法执行中的错误,也更接近同步的写法( try/catch )。因此,建议总是使用 catch 方法,而不使用 then 方法的第二个参数。
跟传统的 try/catch 代码块不同的是,如果没有使用 catch 方法指定错误处理的回调函数,Promise对象抛出的错误不会传递到外层代码,即不会有任何反应。

var someAsyncThing = function() {
   return new Promise(function(resolve, reject) {
      // 下面一行会报错,因为x没有声明
      resolve(x + 2);
   });
};
someAsyncThing().then(function() {
   console.log('everything is great');
});

上面代码中, someAsyncThing 函数产生的Promise对象会报错,但是由于没有指定 catch 方法,这个错误不会被捕获,也不会传递到外层代码,导致运行后没有任何输出。注意,Chrome浏览器不遵守这条规定,它会抛出错误“ReferenceError: x is notdefined”。

var promise = new Promise(function(resolve, reject) {
   resolve("ok");
   setTimeout(function() { throw new Error('test') }, 0)
});
promise.then(function(value) { console.log(value) });
// ok
// Uncaught Error: test

上面代码中,Promise指定在下一轮“事件循环”再抛出错误,结果由于没有指定使用try...catch 语句,就冒泡到最外层,成了未捕获的错误。因为此时,Promise的函数体已经运行结束了,所以这个错误是在Promise函数体外抛出的。
catch 方法返回的还是一个Promise对象,因此后面还可以接着调用 then 方法。

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 方法指定的回调函数。如果没有报错,则会跳过 catch 方法。

Promise.resolve()
.catch(function(error) {
   console.log('oh no', error);
})
.then(function() {
   console.log('carry on');
});
// carry on

上面的代码因为没有报错,跳过了 catch 方法,直接执行后面的 then 方法。此时,要是 then 方法里面报错,就与前面的 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;
}).then(function() {
   console.log('carry on');
});
// oh no [ReferenceError: x is not defined]

上面代码中, catch 方法抛出一个错误,因为后面没有别的 catch 方法了,导致这个错误不会被捕获,也不会传递到外层。如果改写一下,结果就不一样了。

someAsyncThing().then(function() {
   return someOtherAsyncThing();
}).catch(function(error) {
   console.log('oh no', error);
   // 下面一行会报错,因为y没有声明
   y + 2;
}).catch(function(error) {
   console.log('carry on', error);
});
// oh no [ReferenceError: x is not defined]
// carry on [ReferenceError: y is not defined]

上面代码中,第二个 catch 方法用来捕获,前一个 catch 方法抛出的错误。

Promise.all()

Promise.all 方法用于将多个Promise实例,包装成一个新的Promise实例。

var 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 的回调函数。

// 生成一个Promise对象的数组
var promises = [2, 3, 5, 7, 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 = databaseProimse
   .then(findAllBooks);
const userPromise = databasePromise
   .then(getCurrentUser);
Promise.all([
   booksPromise,
   userPromise
])
.then(([books, user]) => pickTopRecommentations(books, user));

上面代码中, booksPromise 和 userPromise 是两个异步操作,只有等到它们的结果都返回了,才会触发 pickTopRecommentations 这个回调函数

Promise.race()

Promise.race 方法同样是将多个Promise实例,包装成一个新的Promise实例。

var p = Promise.race([p1,p2,p3]);

上面代码中,只要 p1 、 p2 、 p3 之中有一个实例率先改变状态, p 的状态就跟着改变。那个率先改变的Promise实例的返回值,就传递给 p 的回调函数。
Promise.race 方法的参数与 Promise.all 方法一样,如果不是Promise实例,就会先调用下面讲到的 Promise.resolve 方法,将参数转为Promise实例,再进一步处理。
如果指定时间内没有获得结果,就将Promise的状态变为 reject ,否则变为 resolve 。

var p = Promise.race([
   fetch('/resource-that-may-take-a-while'),
   new Promise(function (resolve, reject) {
      setTimeout(() => reject(new Error('request timeout')), 5000)
   })
])
p.then(response => console.log(response))
p.catch(error => console.log(error))

如果5秒之内 fetch 方法无法返回结果,变量 p 的状态就会变为 rejected ,从而触发 catch 方法指定的回调函数

Promise.reslove()

有时需要将现有对象转为Promise对象, Promise.resolve 方法就起到这个作用。

var jsPromise = Promise.resolve($.ajax('/whatever.json'));

上面代码将jQuery生成的 deferred 对象,转为一个新的Promise对象
Promise.resolve 等价于下面的写法。

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

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

(1)参数是一个Promise实例

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

(1)参数是一个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
});

上面代码中, thenable 对象的 then 方法执行后,对象 p1 的状态就变为 resolved ,从而立即执行最后那个 then 方法指定的回调函数,输出42。

(3)参数不是属于then方法的对象,或不是对象

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

var 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对象。
如果希望得到一个Promise对象,比较方便的方法就是直接调用 Promise.resolve 方法。

var p = Promise.resolve();
p.then(function () {
   // ...
});
//变量 p 就是一个Promise对象

Promise.reject()

Promise.reject(reason) 方法也会返回一个新的Promise实例,该实例的状态为 rejected 。它的参数用法与 Promise.resolve 方法完全一致。

var p = Promise.reject('出错了');
// 等同于
var p = new Promise((resolve, reject) => reject('出错了'))
p.then(null, function (s){
   console.log(s)
});
// 出错了

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

附加方法

done()

Promise对象的回调链,不管以 then 方法或 catch 方法结尾,要是最后一个方法抛出错误,都有可能无法捕捉到(因为Promise内部的错误不会冒泡到全局)。因此,我们可以提供一个 done 方法,总是处于回调链的尾端,保证抛出任何可能出现的错误。

asyncFunc()
   .then(f1)
   .catch(r1)
   .then(f2)
   .done();

它的实现代码相当简单。

Promise.prototype.done = function (onFulfilled, onRejected) {
   this.then(onFulfilled, onRejected)
      .catch(function (reason) {
         // 抛出一个全局错误
         setTimeout(() => { throw reason }, 0);
   });
};

从上面代码可见, done 方法的使用,可以像 then 方法那样用,提供 Fulfilled 和 Rejected 状态的回调函数,也可以不提供任何参数。但不管怎样, done 都会捕捉到任何可能出现的错误,并向全局抛出。

finally()

finally 方法用于指定不管Promise对象最后状态如何,都会执行的操作。它与 done 方法的最大区别,它接受一个普通的回调函数作为参数,该函数不管怎样都必须执行。
下面是一个例子,服务器使用Promise处理请求,然后使用 finally 方法关掉服务器。

server.listen(0)
   .then(function () {
      // run test
   })
   .finally(server.stop);

它的实现也很简单。

Promise.prototype.finally = function (callback) {
   let P = this.constructor;
   return this.then(
      value => P.resolve(callback()).then(() => value),
      reason => P.resolve(callback()).then(() => { throw reason })
   );
};

上面代码中,不管前面的Promise是 fulfilled 还是 rejected ,都会执行回调函数 callback 。

你可能感兴趣的:(ECMAScript Promise对象)