diff --git a/docs/promise.md b/docs/promise.md index dd573bb..4f70c05 100644 --- a/docs/promise.md +++ b/docs/promise.md @@ -1,24 +1,48 @@ # Promise对象 -## 基本用法 +## Promise的含义 Promise在JavaScript语言早有实现，ES6将其写进了语言标准，统一了用法，原生提供了Promise对象。 所谓Promise，就是一个对象，用来传递异步操作的消息。它代表了某个未来才会知道结果的事件（通常是一个异步操作），并且这个事件提供统一的API，可供进一步处理。 -有了Promise对象，就可以将异步操作以同步操作的流程表达出来，避免了层层嵌套的回调函数。此外，Promise对象提供的接口，使得控制异步操作更加容易。 +Promise对象有以下两个特点。 + +（1）对象的状态不受外界影响。Promise对象代表一个异步操作，有三种状态：Pending（进行中）、Resolved（已完成，又称Fulfilled）和Rejected（已失败）。只有异步操作的结果，可以决定当前是哪一种状态，任何其他操作都无法改变这个状态。这也是Promise这个名字的由来，它的英语意思就是“承诺”，表示其他手段无法改变。 + +（2）一旦状态改变，就不会再变，任何时候都可以得到这个结果。Promise对象的状态改变，只有两种可能：从Pending变为Resolved和从Pending变为Rejected。只要这两种情况发生，状态就凝固了，不会再变了，会一直保持这个结果。就算改变已经发生了，你再对Promise对象添加回调函数，也会立即得到这个结果。这与事件（Event）完全不同，事件的特点是，如果你错过了它，再去监听，是得不到结果的。 + +有了Promise对象，就可以将异步操作以同步操作的流程表达出来，避免了层层嵌套的回调函数。此外，Promise对象提供统一的接口，使得控制异步操作更加容易。 + +Promise也有一些缺点。首先，无法取消Promise，一旦新建它就会立即执行，无法中途取消。其次，如果不设置回调函数，Promise内部抛出的错误，不会反应到外部。第三，当处于Pending状态时，无法得知目前进展到哪一个阶段（刚刚开始还是即将完成）。 + +如果某些事件不断地反复发生，一般来说，使用stream模式是比部署Promise更好的选择。 + +## 基本用法 ES6规定，Promise对象是一个构造函数，用来生成Promise实例。 +下面代码创造了一个Promise实例。 + ```javascript 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状态的回调函数。 + +```javascript promise.then(function(value) { // success }, function(value) { @@ -26,32 +50,27 @@ promise.then(function(value) { }); ``` -上面代码中，Promise构造函数接受一个函数作为参数，该函数的两个参数分别是resolve方法和reject方法。如果异步操作成功，则用resolve方法将Promise对象的状态，从“未完成”变为“成功”（即从pending变为resolved）；如果异步操作失败，则用reject方法将Promise对象的状态，从“未完成”变为“失败”（即从pending变为rejected）。 +then方法可以接受两个回调函数作为参数。第一个回调函数是Promise对象的状态变为Resolved时调用，第二个回调函数是Promise对象的状态变为Reject时调用。其中，第二个函数是可选的，不一定要提供。这两个函数都接受Promise对象传出的值作为参数。 -Promise实例生成以后，可以用then方法分别指定resolve方法和reject方法的回调函数。 - -下面是一个使用Promise对象的简单例子。 +下面是一个Promise对象的简单例子。 ```javascript - function timeout(ms) { return new Promise((resolve) => { - setTimeout(resolve, ms); + setTimeout(resolve, ms, 'done'); }); } -timeout(100).then(() => { - console.log('done'); +timeout(100).then((value) => { + console.log(value); }); - ``` -上面代码中，timeout方法返回一个Promise实例，表示一段时间以后才会发生的结果。一旦Promise对象的状态变为resolved，就会触发then方法绑定的回调函数。 +上面代码中，timeout方法返回一个Promise实例，表示一段时间以后才会发生的结果。过了指定的时间（ms参数）以后，Promise实例的状态变为Resolved，就会触发then方法绑定的回调函数。 下面是一个用Promise对象实现的Ajax操作的例子。 ```javascript - var getJSON = function(url) { var promise = new Promise(function(resolve, reject){ var client = new XMLHttpRequest(); @@ -78,12 +97,11 @@ getJSON("/posts.json").then(function(json) { }, function(error) { console.error('出错了', error); }); - ``` -上面代码中，getJSON是对XMLHttpRequest对象的封装，用于发出一个针对JSON数据的HTTP请求，并且返回一个Promise对象。需要注意的是，在getJSON内部，resolve方法和reject方法调用时，都带有参数。 +上面代码中，getJSON是对XMLHttpRequest对象的封装，用于发出一个针对JSON数据的HTTP请求，并且返回一个Promise对象。需要注意的是，在getJSON内部，resolve函数和reject函数调用时，都带有参数。 -如果调用resolve方法和reject方法时带有参数，那么它们的参数会被传递给回调函数。reject方法的参数通常是Error对象的实例，表示抛出的错误；resolve方法的参数除了正常的值以外，还可能是另一个Promise实例，表示异步操作的结果有可能是一个值，也有可能是另一个异步操作，比如像下面这样。 +如果调用resolve函数和reject函数时带有参数，那么它们的参数会被传递给回调函数。reject函数的参数通常是Error对象的实例，表示抛出的错误；resolve函数的参数除了正常的值以外，还可能是另一个Promise实例，表示异步操作的结果有可能是一个值，也有可能是另一个异步操作，比如像下面这样。 ```javascript var p1 = new Promise(function(resolve, reject){ @@ -96,67 +114,84 @@ var p2 = new Promise(function(resolve, reject){ }) ``` -上面代码中，p1和p2都是Promise的实例，但是p2的resolve方法将p1作为参数，p1的状态就会传递给p2。 +上面代码中，p1和p2都是Promise的实例，但是p2的resolve方法将p1作为参数，即一个异步操作的结果是返回另一个异步操作。 -注意，这时p1的状态决定了p2的状态。如果p1的状态是pending，那么p2的回调函数就会等待p1的状态改变；如果p1的状态已经是fulfilled或者rejected，那么p2的回调函数将会立刻执行。 +注意，这时p1的状态就会传递给p2，也就是说，p1的状态决定了p2的状态。如果p1的状态是Pending，那么p2的回调函数就会等待p1的状态改变；如果p1的状态已经是Resolved或者Rejected，那么p2的回调函数将会立刻执行。 ## Promise.prototype.then() -Promise.prototype.then方法返回的是一个新的Promise对象，因此可以采用链式写法，即then方法后面再调用另一个then方法。 +Promise实例具有then方法，也就是说，then方法是定义在原型对象Promise.prototype上的。它的作用是为Promise实例添加状态改变时的回调函数。前面说过，then方法的第一个参数是Resolved状态的回调函数，第二个参数（可选）是Rejected状态的回调函数。 + +then方法返回的是一个新的Promise实例（注意，不是原来那个Promise实例）。因此可以采用链式写法，即then方法后面再调用另一个then方法。 ```javascript - getJSON("/posts.json").then(function(json) { return json.post; }).then(function(post) { // ... }); - ``` 上面的代码使用then方法，依次指定了两个回调函数。第一个回调函数完成以后，会将返回结果作为参数，传入第二个回调函数。 -如果前一个回调函数返回的是Promise对象，这时后一个回调函数就会等待该Promise对象有了运行结果，才会进一步调用。 +采用链式的then，可以指定一组按照次序调用的回调函数。这时，前一个回调函数，有可能返回的还是一个Promise对象（即有异步操作），这时后一个回调函数，就会等待该Promise对象的状态发生变化，才会被调用。 ```javascript - getJSON("/post/1.json").then(function(post) { return getJSON(post.commentURL); -}).then(function(comments) { - // ... +}).then(function funcA(comments) { + console.log("Resolved: ", comments); +}, function funcB(err){ + console.log("Rejected: ", err); }); - ``` -then方法还可以接受第二个参数，表示Promise对象的状态变为rejected时的回调函数。 +上面代码中，第一个then方法指定的回调函数，返回的是另一个Promise对象。这时，第二个then方法指定的回调函数，就会等待这个新的Promise对象状态发生变化。如果变为Resolved，就调用funcA，如果状态变为Rejected，就调用funcB。 + +如果采用箭头函数，上面的代码可以写得更简洁。 + +```javascript +getJSON("/post/1.json").then( + post => getJSON(post.commentURL) +).then( + comments => console.log("Resolved: ", comments), + err => console.log("Rejected: ", err) +); +``` ## Promise.prototype.catch() -Promise.prototype.catch方法是`Promise.prototype.then(null, rejection)`的别名，用于指定发生错误时的回调函数。 +Promise.prototype.catch方法是`.then(null, rejection)`的别名，用于指定发生错误时的回调函数。 ```javascript - getJSON("/posts.json").then(function(posts) { // ... }).catch(function(error) { // 处理前一个回调函数运行时发生的错误 console.log('发生错误！', error); }); - ``` -上面代码中，getJSON方法返回一个Promise对象，如果该对象运行正常，则会调用then方法指定的回调函数；如果该方法抛出错误，则会调用catch方法指定的回调函数，处理这个错误。 +上面代码中，getJSON方法返回一个Promise对象，如果该对象状态变为Resolved，则会调用then方法指定的回调函数；如果异步操作抛出错误，状态就会变为Rejected，就会调用catch方法指定的回调函数，处理这个错误。 + +```javascript +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)); +``` 下面是一个例子。 ```javascript - var promise = new Promise(function(resolve, reject) { throw new Error('test') }); promise.catch(function(error) { console.log(error) }); // Error: test - ``` 上面代码中，Promise抛出一个错误，就被catch方法指定的回调函数捕获。 @@ -164,7 +199,6 @@ promise.catch(function(error) { console.log(error) }); 如果Promise状态已经变成resolved，再抛出错误是无效的。 ```javascript - var promise = new Promise(function(resolve, reject) { resolve("ok"); throw new Error('test'); @@ -173,7 +207,6 @@ promise .then(function(value) { console.log(value) }) .catch(function(error) { console.log(error) }); // ok - ``` 上面代码中，Promise在resolve语句后面，再抛出错误，不会被捕获，等于没有抛出。 @@ -181,7 +214,6 @@ promise Promise对象的错误具有“冒泡”性质，会一直向后传递，直到被捕获为止。也就是说，错误总是会被下一个catch语句捕获。 ```javascript - getJSON("/post/1.json").then(function(post) { return getJSON(post.commentURL); }).then(function(comments) { @@ -189,7 +221,6 @@ getJSON("/post/1.json").then(function(post) { }).catch(function(error) { // 处理前面三个Promise产生的错误 }); - ``` 上面代码中，一共有三个Promise对象：一个由getJSON产生，两个由then产生。它们之中任何一个抛出的错误，都会被最后一个catch捕获。 @@ -197,7 +228,6 @@ getJSON("/post/1.json").then(function(post) { 跟传统的try/catch代码块不同的是，如果没有使用catch方法指定错误处理的回调函数，Promise对象抛出的错误不会传递到外层代码，即不会有任何反应。 ```javascript - var someAsyncThing = function() { return new Promise(function(resolve, reject) { // 下面一行会报错，因为x没有声明 @@ -208,13 +238,11 @@ var someAsyncThing = function() { someAsyncThing().then(function() { console.log('everything is great'); }); - ``` 上面代码中，someAsyncThing函数产生的Promise对象会报错，但是由于没有调用catch方法，这个错误不会被捕获，也不会传递到外层代码，导致运行后没有任何输出。 ```javascript - var promise = new Promise(function(resolve, reject) { resolve("ok"); setTimeout(function() { throw new Error('test') }, 0) @@ -222,7 +250,6 @@ var promise = new Promise(function(resolve, reject) { promise.then(function(value) { console.log(value) }); // ok // Uncaught Error: test - ``` 上面代码中，Promise指定在下一轮“事件循环”再抛出错误，结果由于没有指定catch语句，就冒泡到最外层，成了未捕获的错误。 @@ -240,7 +267,6 @@ process.on('unhandledRejection', function (err, p) { 需要注意的是，catch方法返回的还是一个Promise对象，因此后面还可以接着调用then方法。 ```javascript - var someAsyncThing = function() { return new Promise(function(resolve, reject) { // 下面一行会报错，因为x没有声明 @@ -257,7 +283,6 @@ someAsyncThing().then(function() { }); // oh no [ReferenceError: x is not defined] // carry on - ``` 上面代码运行完catch方法指定的回调函数，会接着运行后面那个then方法指定的回调函数。 @@ -265,7 +290,6 @@ someAsyncThing().then(function() { catch方法之中，还能再抛出错误。 ```javascript - var someAsyncThing = function() { return new Promise(function(resolve, reject) { // 下面一行会报错，因为x没有声明 @@ -283,13 +307,11 @@ someAsyncThing().then(function() { console.log('carry on'); }); // oh no [ReferenceError: x is not defined] - ``` -上面代码中，catch方法抛出一个错误，因为后面没有别的catch方法了，导致这个错误不会被捕获，也不会到传递到外层。如果改写一下，结果就不一样了。 +上面代码中，catch方法抛出一个错误，因为后面没有别的catch方法了，导致这个错误不会被捕获，也不会传递到外层。如果改写一下，结果就不一样了。 ```javascript - someAsyncThing().then(function() { return someOtherAsyncThing(); }).catch(function(error) { @@ -301,19 +323,16 @@ someAsyncThing().then(function() { }); // oh no [ReferenceError: x is not defined] // carry on [ReferenceError: y is not defined] - ``` 上面代码中，第二个catch方法用来捕获，前一个catch方法抛出的错误。 -## Promise.all()，Promise.race() +## Promise.all() Promise.all方法用于将多个Promise实例，包装成一个新的Promise实例。 ```javascript - var p = Promise.all([p1,p2,p3]); - ``` 上面代码中，Promise.all方法接受一个数组作为参数，p1、p2、p3都是Promise对象的实例。（Promise.all方法的参数不一定是数组，但是必须具有iterator接口，且返回的每个成员都是Promise实例。） @@ -327,74 +346,67 @@ p的状态由p1、p2、p3决定，分成两种情况。 下面是一个具体的例子。 ```javascript - // 生成一个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){ // ... }); - ``` +## Promise.race() Promise.race方法同样是将多个Promise实例，包装成一个新的Promise实例。 ```javascript - var p = Promise.race([p1,p2,p3]); - ``` -上面代码中，只要p1、p2、p3之中有一个实例率先改变状态，p的状态就跟着改变。那个率先改变的Promise实例的返回值，就传递给p的返回值。 +上面代码中，只要p1、p2、p3之中有一个实例率先改变状态，p的状态就跟着改变。那个率先改变的Promise实例的返回值，就传递给p的回调函数。 如果Promise.all方法和Promise.race方法的参数，不是Promise实例，就会先调用下面讲到的Promise.resolve方法，将参数转为Promise实例，再进一步处理。 -## Promise.resolve()，Promise.reject() +## Promise.resolve() 有时需要将现有对象转为Promise对象，Promise.resolve方法就起到这个作用。 ```javascript - var jsPromise = Promise.resolve($.ajax('/whatever.json')); - ``` -上面代码将jQuery生成deferred对象，转为一个新的ES6的Promise对象。 +上面代码将jQuery生成deferred对象，转为一个新的Promise对象。 -如果Promise.resolve方法的参数，不是具有then方法的对象（又称thenable对象），则返回一个新的Promise对象，且它的状态为fulfilled。 +如果Promise.resolve方法的参数，不是具有then方法的对象（又称thenable对象），则返回一个新的Promise对象，且它的状态为Resolved。 ```javascript - var p = Promise.resolve('Hello'); p.then(function (s){ console.log(s) }); // Hello - ``` -上面代码生成一个新的Promise对象的实例p，它的状态为fulfilled，所以回调函数会立即执行，Promise.resolve方法的参数就是回调函数的参数。 +上面代码生成一个新的Promise对象的实例p。由于字符串Hello不属于异步操作（判断方法是它不是具有then方法的对象），返回Promise实例的状态从一生成就是Resolved，所以回调函数会立即执行。Promise.resolve方法的参数，会同时传给回调函数。 -所以，如果希望得到一个Promise对象，比较方便的方法就是直接调用Promise.resolve方法。 +Promise.resolve方法允许调用时不带参数。所以，如果希望得到一个Promise对象，比较方便的方法就是直接调用Promise.resolve方法。 ```javascript - var p = Promise.resolve(); p.then(function () { // ... }); - ``` 上面代码的变量p就是一个Promise对象。 -如果Promise.resolve方法的参数是一个Promise对象的实例，则会被原封不动地返回。 +如果Promise.resolve方法的参数是一个Promise实例，则会被原封不动地返回。 + +## Promise.reject() Promise.reject(reason)方法也会返回一个新的Promise实例，该实例的状态为rejected。Promise.reject方法的参数reason，会被传递给实例的回调函数。 diff --git a/docs/reference.md b/docs/reference.md index 71a0c39..d62ad41 100644 --- a/docs/reference.md +++ b/docs/reference.md @@ -101,6 +101,7 @@ - Jake Archibald, [JavaScript Promises: There and back again](http://www.html5rocks.com/en/tutorials/es6/promises/) - Tilde, [rsvp.js](https://github.com/tildeio/rsvp.js) - Sandeep Panda, [An Overview of JavaScript Promises](http://www.sitepoint.com/overview-javascript-promises/): ES6 Promise入门介绍 +- Dave Atchley, [ES6 Promises](http://www.datchley.name/es6-promises/): Promise的语法介绍 - Jafar Husain, [Async Generators](https://docs.google.com/file/d/0B4PVbLpUIdzoMDR5dWstRllXblU/view?sle=true): 对async与Generator混合使用的一些讨论 - Axel Rauschmayer, [ECMAScript 6 promises (2/2): the API](http://www.2ality.com/2014/10/es6-promises-api.html): 对ES6 Promise规格和用法的详细介绍 - Jack Franklin, [Embracing Promises in JavaScript](http://javascriptplayground.com/blog/2015/02/promises/): catch方法的例子