Promise是JavaScript异步操作解决方案。介绍Promise之前,先对异步操作做一个详细介绍。
JavaScript的异步执行
概述
Javascript语言的执行环境是”单线程”(single thread)。所谓”单线程”,就是指一次只能完成一件任务。如果有多个任务,就必须排队,前面一个任务完成,再执行后面一个任务。
这种模式的好处是实现起来比较简单,执行环境相对单纯;坏处是只要有一个任务耗时很长,后面的任务都必须排队等着,会拖延整个程序的执行。常见的浏览器无响应(假死),往往就是因为某一段Javascript代码长时间运行(比如死循环),导致整个页面卡在这个地方,其他任务无法执行。
JavaScript语言本身并不慢,慢的是读写外部数据,比如等待Ajax请求返回结果。这个时候,如果对方服务器迟迟没有响应,或者网络不通畅,就会导致脚本的长时间停滞。
为了解决这个问题,Javascript语言将任务的执行模式分成两种:同步(Synchronous)和异步(Asynchronous)。”同步模式”就是传统做法,后一个任务等待前一个任务结束,然后再执行,程序的执行顺序与任务的排列顺序是一致的、同步的。这往往用于一些简单的、快速的、不涉及读写的操作。
“异步模式”则完全不同,每一个任务分成两段,第一段代码包含对外部数据的请求,第二段代码被写成一个回调函数,包含了对外部数据的处理。第一段代码执行完,不是立刻执行第二段代码,而是将程序的执行权交给第二个任务。等到外部数据返回了,再由系统通知执行第二段代码。所以,程序的执行顺序与任务的排列顺序是不一致的、异步的。
以下总结了”异步模式”编程的几种方法,理解它们可以让你写出结构更合理、性能更出色、维护更方便的JavaScript程序。
回调函数
回调函数是异步编程最基本的方法。
假定有两个函数f1和f2,后者等待前者的执行结果。
1 f1(); 2 f2();
上面代码中,f2
必须要等到f1
执行完,才能执行。
如果f1
是一个很耗时的任务,可以考虑改写f1
,把f2
写成f1
的回调函数。
1 function f1(callback) { 2 setTimeout(function () { 3 // f1的任务代码 4 // ... 5 callback(); 6 }, 0); 7 }
执行代码就变成下面这样。
1 f1(f2);
采用这种方式,我们把同步操作变成了异步操作,setTimeout(fn, 0)
将fn
放到下一轮事件循环执行。f1
不会堵塞程序运行,相当于先执行程序的主要逻辑,将耗时的操作推迟执行。
回调函数的优点是简单、容易理解和部署,缺点是不利于代码的阅读和维护,各个部分之间高度耦合(Coupling),使得程序结构混乱、流程难以追踪(尤其是回调函数嵌套的情况),而且每个任务只能指定一个回调函数。
事件监听
另一种思路是采用事件驱动模式。任务的执行不取决于代码的顺序,而取决于某个事件是否发生。
还是以f1
和f2
为例。首先,为f1绑定一个事件(这里采用的jQuery的写法)。
1 f1.on('done', f2);
上面这行代码的意思是,当f1发生done事件,就执行f2。然后,对f1进行改写:
1 function f1(){ 2 setTimeout(function () { 3 // f1的任务代码 4 f1.trigger('done'); 5 }, 1000); 6 }
上面代码中,f1.trigger('done')
表示,执行完成后,立即触发done
事件,从而开始执行f2
。
这种方法的优点是比较容易理解,可以绑定多个事件,每个事件可以指定多个回调函数,而且可以”去耦合“(Decoupling),有利于实现模块化。缺点是整个程序都要变成事件驱动型,运行流程会变得很不清晰。
发布/订阅
“事件”完全可以理解成”信号”,如果存在一个”信号中心”,某个任务执行完成,就向信号中心”发布”(publish)一个信号,其他任务可以向信号中心”订阅”(subscribe)这个信号,从而知道什么时候自己可以开始执行。这就叫做”发布/订阅模式“(publish-subscribe pattern),又称”观察者模式“(observer pattern)。
这个模式有多种实现,下面采用的是Ben Alman的Tiny Pub/Sub,这是jQuery的一个插件。
首先,f2向”信号中心”jQuery订阅”done”信号。
1 jQuery.subscribe("done", f2);
然后,f1进行如下改写:
1 function f1(){ 2 setTimeout(function () { 3 // f1的任务代码 4 jQuery.publish("done"); 5 }, 1000); 6 }
jQuery.publish(“done”)的意思是,f1执行完成后,向”信号中心”jQuery发布”done”信号,从而引发f2的执行。
f2完成执行后,也可以取消订阅(unsubscribe)。
1 jQuery.unsubscribe("done", f2);
这种方法的性质与”事件监听”类似,但是明显优于后者。因为我们可以通过查看”消息中心”,了解存在多少信号、每个信号有多少订阅者,从而监控程序的运行。
异步操作的流程控制
如果有多个异步操作,就存在一个流程控制的问题:确定操作执行的顺序,以后如何保证遵守这种顺序。
1 function async(arg, callback) { 2 console.log('参数为 ' + arg +' , 1秒后返回结果'); 3 setTimeout(function() { callback(arg * 2); }, 1000); 4 }
上面代码的async函数是一个异步任务,非常耗时,每次执行需要1秒才能完成,然后再调用回调函数。
如果有6个这样的异步任务,需要全部完成后,才能执行下一步的final函数。
1 function final(value) { 2 console.log('完成: ', value); 3 }
请问应该如何安排操作流程?
1 async(1, function(value){ 2 async(value, function(value){ 3 async(value, function(value){ 4 async(value, function(value){ 5 async(value, function(value){ 6 async(value, final); 7 }); 8 }); 9 }); 10 }); 11 });
上面代码采用6个回调函数的嵌套,不仅写起来麻烦,容易出错,而且难以维护。
串行执行
我们可以编写一个流程控制函数,让它来控制异步任务,一个任务完成以后,再执行另一个。这就叫串行执行。
1 var items = [ 1, 2, 3, 4, 5, 6 ]; 2 var results = []; 3 function series(item) { 4 if(item) { 5 async( item, function(result) { 6 results.push(result); 7 return series(items.shift()); 8 }); 9 } else { 10 return final(results); 11 } 12 } 13 series(items.shift());
上面代码中,函数series就是串行函数,它会依次执行异步任务,所有任务都完成后,才会执行final函数。items数组保存每一个异步任务的参数,results数组保存每一个异步任务的运行结果。
并行执行
流程控制函数也可以是并行执行,即所有异步任务同时执行,等到全部完成以后,才执行final函数。
1 var items = [ 1, 2, 3, 4, 5, 6 ]; 2 var results = []; 3 4 items.forEach(function(item) { 5 async(item, function(result){ 6 results.push(result); 7 if(results.length == items.length) { 8 final(results); 9 } 10 }) 11 });
上面代码中,forEach方法会同时发起6个异步任务,等到它们全部完成以后,才会执行final函数。
并行执行的好处是效率较高,比起串行执行一次只能执行一个任务,较为节约时间。但是问题在于如果并行的任务较多,很容易耗尽系统资源,拖慢运行速度。因此有了第三种流程控制方式。
并行与串行的结合
所谓并行与串行的结合,就是设置一个门槛,每次最多只能并行执行n个异步任务。这样就避免了过分占用系统资源。
1 var items = [ 1, 2, 3, 4, 5, 6 ]; 2 var results = []; 3 var running = 0; 4 var limit = 2; 5 6 function launcher() { 7 while(running < limit && items.length > 0) { 8 var item = items.shift(); 9 async(item, function(result) { 10 results.push(result); 11 running--; 12 if(items.length > 0) { 13 launcher(); 14 } else if(running == 0) { 15 final(); 16 } 17 }); 18 running++; 19 } 20 } 21 22 launcher();
上面代码中,最多只能同时运行两个异步任务。变量running记录当前正在运行的任务数,只要低于门槛值,就再启动一个新的任务,如果等于0,就表示所有任务都执行完了,这时就执行final函数。
Promise对象
简介
Promise对象是CommonJS工作组提出的一种规范,目的是为异步操作提供统一接口。
那么,什么是Promises?
首先,它是一个对象,也就是说与其他JavaScript对象的用法,没有什么两样;其次,它起到代理作用(proxy),充当异步操作与回调函数之间的中介。它使得异步操作具备同步操作的接口,使得程序具备正常的同步运行的流程,回调函数不必再一层层嵌套。
简单说,它的思想是,每一个异步任务立刻返回一个Promise对象,由于是立刻返回,所以可以采用同步操作的流程。这个Promises对象有一个then方法,允许指定回调函数,在异步任务完成后调用。
比如,异步操作f1
返回一个Promise对象,它的回调函数f2
写法如下。
1 (new Promise(f1)).then(f2);
这种写法对于多层嵌套的回调函数尤其方便。
1 // 传统写法 2 step1(function (value1) { 3 step2(value1, function(value2) { 4 step3(value2, function(value3) { 5 step4(value3, function(value4) { 6 // ... 7 }); 8 }); 9 }); 10 }); 11 12 // Promises的写法 13 (new Promise(step1)) 14 .then(step2) 15 .then(step3) 16 .then(step4);
从上面代码可以看到,采用Promises接口以后,程序流程变得非常清楚,十分易读。
注意,为了便于理解,上面代码的Promise对象的生成格式,做了简化,真正的语法请参照下文。
总的来说,传统的回调函数写法使得代码混成一团,变得横向发展而不是向下发展。Promises规范就是为了解决这个问题而提出的,目标是使用正常的程序流程(同步),来处理异步操作。它先返回一个Promise对象,后面的操作以同步的方式,寄存在这个对象上面。等到异步操作有了结果,再执行前期寄放在它上面的其他操作。
Promises原本只是社区提出的一个构想,一些外部函数库率先实现了这个功能。ECMAScript 6将其写入语言标准,因此目前JavaScript语言原生支持Promise对象。
Promise接口
前面说过,Promise接口的基本思想是,异步任务返回一个Promise对象。
Promise对象只有三种状态。
- 异步操作“未完成”(pending)
- 异步操作“已完成”(resolved,又称fulfilled)
- 异步操作“失败”(rejected)
这三种的状态的变化途径只有两种。
- 异步操作从“未完成”到“已完成”
- 异步操作从“未完成”到“失败”。
这种变化只能发生一次,一旦当前状态变为“已完成”或“失败”,就意味着不会再有新的状态变化了。因此,Promise对象的最终结果只有两种。
- 异步操作成功,Promise对象传回一个值,状态变为
resolved
。 - 异步操作失败,Promise对象抛出一个错误,状态变为
rejected
。
Promise对象使用then
方法添加回调函数。then
方法可以接受两个回调函数,第一个是异步操作成功时(变为resolved
状态)时的回调函数,第二个是异步操作失败(变为rejected
)时的回调函数(可以省略)。一旦状态改变,就调用相应的回调函数。
1 // po是一个Promise对象 2 po.then( 3 console.log, 4 console.error 5 );
上面代码中,Promise对象po
使用then
方法绑定两个回调函数:操作成功时的回调函数console.log
,操作失败时的回调函数console.error
(可以省略)。这两个函数都接受异步操作传回的值作为参数。
then
方法可以链式使用。
1 po 2 .then(step1) 3 .then(step2) 4 .then(step3) 5 .then( 6 console.log, 7 console.error 8 );
上面代码中,po
的状态一旦变为resolved
,就依次调用后面每一个then
指定的回调函数,每一步都必须等到前一步完成,才会执行。最后一个then
方法的回调函数console.log
和console.error
,用法上有一点重要的区别。console.log
只显示回调函数step3
的返回值,而console.error
可以显示step1
、step2
、step3
之中任意一个发生的错误。也就是说,假定step1
操作失败,抛出一个错误,这时step2
和step3
都不会再执行了(因为它们是操作成功的回调函数,而不是操作失败的回调函数)。Promises对象开始寻找,接下来第一个操作失败时的回调函数,在上面代码中是console.error
。这就是说,Promises对象的错误有传递性。
1 try { 2 var v1 = step1(po); 3 var v2 = step2(v1); 4 var v3 = step3(v2); 5 console.log(v3); 6 } catch (error) { 7 console.error(error); 8 }
Promise对象的生成
ES6提供了原生的Promise构造函数,用来生成Promise实例。
下面代码创造了一个Promise实例。
从同步的角度看,上面的代码大致等同于下面的形式。
1 var promise = new Promise(function(resolve, reject) { 2 // 异步操作的代码 3 4 if (/* 异步操作成功 */){ 5 resolve(value); 6 } else { 7 reject(error); 8 } 9 });
Promise构造函数接受一个函数作为参数,该函数的两个参数分别是resolve
和reject
。它们是两个函数,由JavaScript引擎提供,不用自己部署。
resolve
函数的作用是,将Promise对象的状态从“未完成”变为“成功”(即从Pending
变为Resolved
),在异步操作成功时调用,并将异步操作的结果,作为参数传递出去;reject
函数的作用是,将Promise对象的状态从“未完成”变为“失败”(即从Pending
变为Rejected
),在异步操作失败时调用,并将异步操作报出的错误,作为参数传递出去。
Promise实例生成以后,可以用then
方法分别指定Resolved
状态和Reject
状态的回调函数。
1 po.then(function(value) { 2 // success 3 }, function(value) { 4 // failure 5 });
用法辨析
Promise的用法,简单说就是一句话:使用then
方法添加回调函数。但是,不同的写法有一些细微的差别,请看下面四种写法,它们的差别在哪里?
1 // 写法一 2 doSomething().then(function () { 3 return doSomethingElse(); 4 }); 5 6 // 写法二 7 doSomething().then(function () { 8 doSomethingElse(); 9 }); 10 11 // 写法三 12 doSomething().then(doSomethingElse()); 13 14 // 写法四 15 doSomething().then(doSomethingElse);
为了便于讲解,下面这四种写法都再用then
方法接一个回调函数finalHandler
。写法一的finalHandler
回调函数的参数,是doSomethingElse
函数的运行结果。
1 doSomething().then(function () { 2 return doSomethingElse(); 3 }).then(finalHandler);
写法二的finalHandler
回调函数的参数是undefined
。
1 doSomething().then(function () { 2 doSomethingElse(); 3 return; 4 }).then(finalHandler);
写法三的finalHandler
回调函数的参数,是doSomethingElse
函数返回的回调函数的运行结果。
1 doSomething().then(doSomethingElse()) 2 .then(finalHandler);
写法四与写法一只有一个差别,那就是doSomethingElse
会接收到doSomething()
返回的结果。
1 doSomething().then(doSomethingElse) 2 .then(finalHandler);
Promise的应用
加载图片
我们可以把图片的加载写成一个Promise
对象。
1 var preloadImage = function (path) { 2 return new Promise(function (resolve, reject) { 3 var image = new Image(); 4 image.onload = resolve; 5 image.onerror = reject; 6 image.src = path; 7 }); 8 };
Ajax操作
Ajax操作是典型的异步操作,传统上往往写成下面这样。
1 function search(term, onload, onerror) { 2 var xhr, results, url; 3 url = 'http://example.com/search?q=' + term; 4 5 xhr = new XMLHttpRequest(); 6 xhr.open('GET', url, true); 7 8 xhr.onload = function (e) { 9 if (this.status === 200) { 10 results = JSON.parse(this.responseText); 11 onload(results); 12 } 13 }; 14 xhr.onerror = function (e) { 15 onerror(e); 16 }; 17 18 xhr.send(); 19 } 20 21 search("Hello World", console.log, console.error);
如果使用Promise对象,就可以写成下面这样。
1 function search(term) { 2 var url = 'http://example.com/search?q=' + term; 3 var xhr = new XMLHttpRequest(); 4 var result; 5 6 var p = new Promise(function (resolve, reject) { 7 xhr.open('GET', url, true); 8 xhr.onload = function (e) { 9 if (this.status === 200) { 10 result = JSON.parse(this.responseText); 11 resolve(result); 12 } 13 }; 14 xhr.onerror = function (e) { 15 reject(e); 16 }; 17 xhr.send(); 18 }); 19 20 return p; 21 } 22 23 search("Hello World").then(console.log, console.error);
加载图片的例子,也可以用Ajax操作完成。
1 function imgLoad(url) { 2 return new Promise(function(resolve, reject) { 3 var request = new XMLHttpRequest(); 4 request.open('GET', url); 5 request.responseType = 'blob'; 6 request.onload = function() { 7 if (request.status === 200) { 8 resolve(request.response); 9 } else { 10 reject(new Error('图片加载失败:' + request.statusText)); 11 } 12 }; 13 request.onerror = function() { 14 reject(new Error('发生网络错误')); 15 }; 16 request.send(); 17 }); 18 }
注意点
1)一般来说,不要在then方法里面定义 Reject 状态的回调函数(即then的第二个参数),总是使用catch方法。
// bad promise .then(function(data) { // success }, function(err) { // error }); // good promise .then(function(data) { //cb // success }) .catch(function(err) { // error });
2)Promise 对象后面要跟catch方法
一般总是建议,Promise 对象后面要跟catch方法,这样可以处理 Promise 内部发生的错误。catch方法返回的还是一个 Promise 对象,因此后面还可以接着调用then方法。
代码运行完catch方法指定的回调函数,会接着运行后面那个then方法指定的回调函数。如果没有报错,则会跳过catch方法。此时,要是最后的then方法里面报错,就与前面的catch无关了。
const 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方法用来捕获前一个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]
小结
Promise对象的优点在于,让回调函数变成了规范的链式写法,程序流程可以看得很清楚。它的一整套接口,可以实现许多强大的功能,比如为多个异步操作部署一个回调函数、为多个回调函数中抛出的错误统一指定处理方法等等。
而且,它还有一个前面三种方法都没有的好处:如果一个任务已经完成,再添加回调函数,该回调函数会立即执行(即你可以做同步操作)。所以,你不用担心是否错过了某个事件或信号。这种方法的缺点就是,编写和理解都相对比较难。