特别说明,为便于查阅,文章转自https://github.com/getify/You-Dont-Know-JS
如果你写过任何数量相当的JavaScript,这就不是什么秘密:异步编程是一种必须的技能。管理异步的主要机制曾经是函数回调。
然而,ES6增加了一种新特性:Promise,来帮助你解决仅使用回调来管理异步的重大缺陷。另外,我们可以重温generator(前一章中提到的)来看看一种将两者组合的模式,它是JavaScript中异步流程控制编程向前迈出的重要一步。
Promises
让我们辨明一些误解:Promise不是回调的替代品。Promise提供了一种可信的中介机制 —— 也就是,在你的调用代码和将要执行任务的异步代码之间 —— 来管理回调。
另一种考虑Promise的方式是作为一种事件监听器,你可以在它上面注册监听一个通知你任务何时完成的事件。它是一个仅被触发一次的事件,但不管怎样可以被看作是一个事件。
Promise可以被链接在一起,它们可以是一系列顺序的、异步完成的步骤。与all(..)
方法(用经典的术语将,叫“门”)和race(..)
方法(用经典的术语将,叫“闩”)这样的高级抽象一起,promise链可以提供一种异步流程控制的机制。
还有另外一种概念化Promise的方式是,将它看作一个 未来值,一个与时间无关的值的容器。无论底层的值是否是最终值,这种容器都可以被同样地推理。观测一个Promise的解析会在这个值准备好的时候将它抽取出来。换言之,一个Promise被认为是一个同步函数返回值的异步版本。
一个Promise只可能拥有两种解析结果:完成或拒绝,并带有一个可选的信号值。如果一个Promise被完成,这个最终值称为一个完成值。如果它被拒绝,这个最终值称为理由(也就是“拒绝的理由”)。Promise只可能被解析(完成或拒绝)一次。任何其他的完成或拒绝的尝试都会被简单地忽略,一旦一个Promise被解析,它就成为一个不可被改变的值(immutable)。
显然,有几种不同的方式可以来考虑一个Promise是什么。没有一个角度就它自身来说是完全充分的,但是每一个角度都提供了整体的一个方面。这其中的要点是,它们为仅使用回调的异步提供了一个重大的改进,也就是它们提供了顺序、可预测性、以及可信性。
创建与使用 Promises
要构建一个promise实例,可以使用Promise(..)
构造器:
var p = new Promise( function pr(resolve,reject){
// ..
} );
Promise(..)
构造器接收一个单独的函数(pr(..)
),它被立即调用并以参数值的形式收到两个控制函数,通常被命名为resolve(..)
和reject(..)
。它们被这样使用:
- 如果你调用
reject(..)
,promise就会被拒绝,而且如果有任何值被传入reject(..)
,它就会被设置为拒绝的理由。 - 如果你不使用参数值,或任何非promise值调用
resolve(..)
,promise就会被完成。 - 如果你调用
resolve(..)
并传入另一个promise,这个promise就会简单地采用 —— 要么立即要么最终地 —— 这个被传入的promise的状态(不是完成就是拒绝)。
这里是你通常如何使用一个promise来重构一个依赖于回调的函数调用。假定你始于使用一个ajax(..)
工具,它期预期要调用一个错误优先风格的回调:
function ajax(url,cb) {
// 发起请求,最终调用 `cb(..)`
}
// ..
ajax( "http://some.url.1", function handler(err,contents){
if (err) {
// 处理ajax错误
}
else {
// 处理成功的`contents`
}
} );
你可以将它转换为:
function ajax(url) {
return new Promise( function pr(resolve,reject){
// 发起请求,最终不是调用 `resolve(..)` 就是调用 `reject(..)`
} );
}
// ..
ajax( "http://some.url.1" )
.then(
function fulfilled(contents){
// 处理成功的 `contents`
},
function rejected(reason){
// 处理ajax的错误reason
}
);
Promise拥有一个方法then(..)
,它接收一个或两个回调函数。第一个函数(如果存在的话)被看作是promise被成功地完成时要调用的处理器。第二个函数(如果存在的话)被看作是promise被明确拒绝时,或者任何错误/异常在解析的过程中被捕捉到时要调用的处理器。
如果这两个参数值之一被省略或者不是一个合法的函数 —— 通常你会用null
来代替 —— 那么一个占位用的默认等价物就会被使用。默认的成功回调将传递它的完成值,而默认的错误回调将传播它的拒绝理由。
调用then(null,handleRejection)
的缩写是catch(handleRejection)
。
then(..)
和catch(..)
两者都自动地构建并返回另一个promise实例,它被链接在原本的promise上,接收原本的promise的解析结果 —— (实际被调用的)完成或拒绝处理器返回的任何值。考虑如下代码:
ajax( "http://some.url.1" )
.then(
function fulfilled(contents){
return contents.toUpperCase();
},
function rejected(reason){
return "DEFAULT VALUE";
}
)
.then( function fulfilled(data){
// 处理来自于原本的promise的处理器中的数据
} );
在这个代码段中,我们要么从fulfilled(..)
返回一个立即值,要么从rejected(..)
返回一个立即值,然后在下一个事件周期中这个立即值被第二个then(..)
的fulfilled(..)
接收。如果我们返回一个新的promise,那么这个新promise就会作为解析结果被纳入与采用:
ajax( "http://some.url.1" )
.then(
function fulfilled(contents){
return ajax(
"http://some.url.2?v=" + contents
);
},
function rejected(reason){
return ajax(
"http://backup.url.3?err=" + reason
);
}
)
.then( function fulfilled(contents){
// `contents` 来自于任意一个后续的 `ajax(..)` 调用
} );
要注意的是,在第一个fulfilled(..)
中的一个异常(或者promise拒绝)将 不会 导致第一个rejected(..)
被调用,因为这个处理仅会应答第一个原始的promise的解析。取代它的是,第二个then(..)
调用所针对的第二个promise,将会收到这个拒绝。
在上面的代码段中,我们没有监听这个拒绝,这意味着它会为了未来的观察而被静静地保持下来。如果你永远不通过调用then(..)
或catch(..)
来观察它,那么它将会成为未处理的。有些浏览器的开发者控制台可能会探测到这些未处理的拒绝并报告它们,但是这不是有可靠保证的;你应当总是观察promise拒绝。
注意: 这只是Promise理论和行为的简要概览。要进行更加深入的探索,参见本系列的 异步与性能 的第三章。
Thenables
Promise是Promise(..)
构造器的纯粹实例。然而,还存在称为 thenable 的类promise对象,它通常可以与Promise机制协作。
任何带有then(..)
函数的对象(或函数)都被认为是一个thenable。任何Promise机制可以接受与采用一个纯粹的promise的状态的地方,都可以处理一个thenable。
Thenable基本上是一个一般化的标签,标识着任何由除了Promise(..)
构造器之外的其他系统创建的类promise值。从这个角度上讲,一个thenable没有一个纯粹的Promise那么可信。例如,考虑这个行为异常的thenable:
var th = {
then: function thener( fulfilled ) {
// 永远会每100ms调用一次`fulfilled(..)`
setInterval( fulfilled, 100 );
}
};
如果你收到这个thenable并使用th.then(..)
将它链接,你可能会惊讶地发现你的完成处理器被反复地调用,而普通的Promise本应该仅仅被解析一次。
一般来说,如果你从某些其他系统收到一个声称是promise或thenable的东西,你不应当盲目地相信它。在下一节中,我们将会看到一个ES6 Promise的工具,它可以帮助解决信任的问题。
但是为了进一步理解这个问题的危险,让我们考虑一下,在 任何 一段代码中的 任何 对象,只要曾经被定义为拥有一个称为then(..)
的方法就都潜在地会被误认为是一个thenable —— 当然,如果和Promise一起使用的话 —— 无论这个东西是否有意与Promise风格的异步编码有一丝关联。
在ES6之前,对于称为then(..)
的方法从来没有任何特别的保留措施,正如你能想象的那样,在Promise出现在雷达屏幕上之前就至少有那么几种情况,它已经被选择为方法的名称了。最有可能用错thenable的情况就是使用then(..)
的异步库不是严格兼容Promise的 —— 在市面上有好几种。
这份重担将由你来肩负:防止那些将被误认为一个thenable的值被直接用于Promise机制。
Promise
API
Promise
API还为处理Promise提供了一些静态方法。
Promise.resolve(..)
创建一个被解析为传入的值的promise。让我们将它的工作方式与更手动的方法比较一下:
var p1 = Promise.resolve( 42 );
var p2 = new Promise( function pr(resolve){
resolve( 42 );
} );
p1
和p2
将拥有完全相同的行为。使用一个promise进行解析也一样:
var theP = ajax( .. );
var p1 = Promise.resolve( theP );
var p2 = new Promise( function pr(resolve){
resolve( theP );
} );
提示: Promise.resolve(..)
就是前一节提出的thenable信任问题的解决方案。任何你还不确定是一个可信promise的值 —— 它甚至可能是一个立即值 —— 都可以通过传入Promise.resolve(..)
来进行规范化。如果这个值已经是一个可识别的promise或thenable,它的状态/解析结果将简单地被采用,将错误行为与你隔绝开。如果相反它是一个立即值,那么它将会被“包装”进一个纯粹的promise,以此将它的行为规范化为异步的。
Promise.reject(..)
创建一个立即被拒绝的promise,与它的Promise(..)
构造器对等品一样:
var p1 = Promise.reject( "Oops" );
var p2 = new Promise( function pr(resolve,reject){
reject( "Oops" );
} );
虽然resolve(..)
和Promise.resolve(..)
可以接收一个promise并采用它的状态/解析结果,但是reject(..)
和Promise.reject(..)
不会区分它们收到什么样的值。所以,如果你使用一个promise或thenable进行拒绝,这个promise/thenable本身将会被设置为拒绝的理由,而不是它底层的值。
Promise.all([ .. ])
接收一个或多个值(例如,立即值,promise,thenable)的数组。它返回一个promise,这个promise会在所有的值完成时完成,或者在这些值中第一个被拒绝的值出现时被立即拒绝。
使用这些值/promises:
var p1 = Promise.resolve( 42 );
var p2 = new Promise( function pr(resolve){
setTimeout( function(){
resolve( 43 );
}, 100 );
} );
var v3 = 44;
var p4 = new Promise( function pr(resolve,reject){
setTimeout( function(){
reject( "Oops" );
}, 10 );
} );
让我们考虑一下使用这些值的组合,Promise.all([ .. ])
如何工作:
Promise.all( [p1,p2,v3] )
.then( function fulfilled(vals){
console.log( vals ); // [42,43,44]
} );
Promise.all( [p1,p2,v3,p4] )
.then(
function fulfilled(vals){
// 永远不会跑到这里
},
function rejected(reason){
console.log( reason ); // Oops
}
);
Promise.all([ .. ])
等待所有的值完成(或第一个拒绝),而Promise.race([ .. ])
仅会等待第一个完成或拒绝。考虑如下代码:
// 注意:为了避免时间的问题误导你,
// 重建所有的测试值!
Promise.race( [p2,p1,v3] )
.then( function fulfilled(val){
console.log( val ); // 42
} );
Promise.race( [p2,p4] )
.then(
function fulfilled(val){
// 永远不会跑到这里
},
function rejected(reason){
console.log( reason ); // Oops
}
);
警告: 虽然 Promise.all([])
将会立即完成(没有任何值),但是 Promise.race([])
将会被永远挂起。这是一个奇怪的不一致,我建议你应当永远不要使用空数组调用这些方法。
Generators + Promises
将一系列promise在一个链条中表达来代表你程序的异步流程控制是 可能 的。考虑如如下代码:
step1()
.then(
step2,
step1Failed
)
.then(
function step3(msg) {
return Promise.all( [
step3a( msg ),
step3b( msg ),
step3c( msg )
] )
}
)
.then(step4);
但是对于表达异步流程控制来说有更好的选项,而且在代码风格上可能比长长的promise链更理想。我们可以使用在第三章中学到的generator来表达我们的异步流程控制。
要识别一个重要的模式:一个generator可以yield出一个promise,然后这个promise可以使用它的完成值来推进generator。
考虑前一个代码段,使用generator来表达:
function *main() {
try {
var ret = yield step1();
}
catch (err) {
ret = yield step1Failed( err );
}
ret = yield step2( ret );
// step 3
ret = yield Promise.all( [
step3a( ret ),
step3b( ret ),
step3c( ret )
] );
yield step4( ret );
}
从表面上看,这个代码段要比前一个promise链等价物要更繁冗。但是它提供了更加吸引人的 —— 而且重要的是,更加容易理解和阅读的 —— 看起来同步的代码风格(“return”值的=
赋值操作,等等),对于try..catch
错误处理可以跨越那些隐藏的异步边界使用来说就更是这样。
为什么我们要与generator一起使用Promise?不用Promise进行异步generator编码当然是可能的。
Promise是一个可信的系统,它将普通的回调和thunk中发生的控制倒转(参见本系列的 异步与性能)反转回来。所以组合Promise的可信性与generator中代码的同步性有效地解决了回调的主要缺陷。另外,像Promise.all([ .. ])
这样的工具是一个非常美好、干净的方式 —— 在一个generator的一个yield
步骤中表达并发。
那么这种魔法是如何工作的?我们需要一个可以运行我们generator的 运行器(runner),接收一个被yield
出来的promise并连接它,让它要么使用成功的完成推进generator,要么使用拒绝的理由向generator抛出异常。
许多具备异步能力的工具/库都有这样的“运行器”;例如,Q.spawn(..)
和我的asynquence中的runner(..)
插件。这里有一个独立的运行器来展示这种处理如何工作:
function run(gen) {
var args = [].slice.call( arguments, 1), it;
it = gen.apply( this, args );
return Promise.resolve()
.then( function handleNext(value){
var next = it.next( value );
return (function handleResult(next){
if (next.done) {
return next.value;
}
else {
return Promise.resolve( next.value )
.then(
handleNext,
function handleErr(err) {
return Promise.resolve(
it.throw( err )
)
.then( handleResult );
}
);
}
})( next );
} );
}
注意: 这个工具的更丰富注释的版本,参见本系列的 异步与性能。另外,由各种异步库提供的这种运行工具通常要比我们在这里展示的东西更强大。例如,asynquence的runner(..)
可以处理被yield
的promise、序列、thunk、以及(非promise的)间接值,给你终极的灵活性。
于是现在运行早先代码段中的*main()
就像这样容易:
run( main )
.then(
function fulfilled(){
// `*main()` 成功地完成了
},
function rejected(reason){
// 噢,什么东西搞错了
}
);
实质上,在你程序中的任何拥有多于两个异步步骤的流程控制逻辑的地方,你就可以 而且应当 使用一个由运行工具驱动的promise-yielding generator来以一种同步的风格表达流程控制。这样做将产生更易于理解和维护的代码。
这种“让出一个promise推进generator”的模式将会如此常见和如此强大,以至于ES6之后的下一个版本的JavaScript几乎可以确定将会引入一中新的函数类型,它无需运行工具就可以自动地执行。我们将在第八章中讲解async function
(正如它们期望被称呼的那样)。
复习
随着JavaScript在它被广泛采用过程中的日益成熟与成长,异步编程越发地成为关注的中心。对于这些异步任务来说回调并不完全够用,而且在更精巧的需求面前全面崩塌了。
可喜的是,ES6增加了Promise来解决回调的主要缺陷之一:在可预测的行为上缺乏可信性。Promise代表一个潜在异步任务的未来完成值,跨越同步和异步的边界将行为进行了规范化。
但是,Promise与generator的组合才完全揭示了这样做的好处:将我们的异步流程控制代码重新安排,将难看的回调浆糊(也叫“地狱”)弱化并抽象出去。
目前,我们可以在各种异步库的运行器的帮助下管理这些交互,但是JavaScript最终将会使用一种专门的独立语法来支持这种交互模式!