Promise

Promise是一种处理异步编程的形式,其是以"上帝"的视角来组织代码的。

这种视角用代码具体体现出来就是Promise的链式调用,Promise.prototype.then(fuc1,fuc2)方法返回的是一个新的Promise对象。这样的链式写法比起嵌套的回调函数写法更符合人的阅读规范。其本质是没有改变的,then里面的函数还是需要某个结果返回之后改变Promise的状态才会被调用。

一个具体的例子:

根据某个名字查出这个人的其他具体信息。现在假设有这样的数据接口,根据名字只能查出为该名的人的身份证号码,然后根据身份证号码能查出这个人的其他具体信息。

let promise = new Promise((resolve, reject) => {
    //根据name取id
    $.ajax({
        url : 'xxx?name=xxx',
        success : (res) => {
          if(res.statusCode === 200){
              resolve(res.id);   //将id传入回调函数
          }else{
              reject(New Error('error'));
          }  
        },
    });
}).then((id) => {
    //当上一个promise状态变为resolved之后,调用该函数,根据id获取信息
    $.ajax({
        url : 'xxx?id='+id,
        success : (red) => {
            if(res.statusCode === 200){
                console.log(res.data);
            }else{
                throw new Error('error');
            }
        }
    });
},(err) => {
    throw err;
}).catch((err) => {
    console.log(err);
});

上面的代码每一个then中的函数,就相当处理已知的一种结果,这样看上去是一步一步,而不用嵌套写回调函数。

用嵌套回调函数的写法:

$.ajax({
    url : 'xxx?name=xxx',
    success : (res) => {
        if(res.statusCode === 200){
            $.ajax({
                url : 'xxx?id='+res.data.id,
                success : (res) => {
                  if(res.statusCode === 200){
                      console.log(res.data);
                  }  
                },
            });
        }
    },
});

对Promise感性的认识可以参考张鑫旭的博文

Promise对象的特点

  • 对象的状态不受外界影响。Promise对象代表一个异步操作,有三种状态:pending(进行中)、fulfilled(已成功)和rejected(已失败)。只有异步操作的结果,可以决定当前是哪一种状态,任何其他操作都无法改变这个状态。这也是Promise这个名字的由来,它的英语意思就是“承诺”,表示其他手段无法改变。
  • 一旦状态改变,就不会再变,任何时候都可以得到这个结果。Promise对象的状态改变,只有两种可能:从pending变为fulfilled和从pending变为rejected。只要这两种情况发生,状态就凝固了,不会再变了,会一直保持这个结果,这时就称为 resolved(已定型)。如果改变已经发生了,你再对Promise对象添加回调函数,也会立即得到这个结果。这与事件(Event)完全不同,事件的特点是,如果你错过了它,再去监听,是得不到结果的。

有了Promise对象,就可以将异步操作以同步操作的流程表达出来,避免了层层嵌套的回调函数。此外,Promise对象提供统一的接口,使得控制异步操作更加容易。

Promise也有一些缺点。首先,无法取消Promise,一旦新建它就会立即执行,无法中途取消。其次,如果不设置回调函数,Promise内部抛出的错误,不会反应到外部。第三,当处于pending状态时,无法得知目前进展到哪一个阶段(刚刚开始还是即将完成)。

基本用法

const promise = new Promise(function(resolve, reject){
    // TODO
    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){
    //do something
},function(error){
    //failure
});

第二个函数是可选的,不一定要提供。这两个函数都接受Promise对象传出的值作为参数。

let promise = new Promise(function(resolve, reject){
    console.log('Promise');
    resolve();
    console.log('continue');
})

promise.then(function(value){
    console.log('resolved.')
});

console.log('Hi');
//输出顺序
//Promise
//continue
//Hi
//resolved

**注意**
Promise新建后就会立即执行,在改变Promise之后,就是调用resolve(),reject()之后,在其之后的代码还是会继续执行完

Promise状态改变触发回调函数是在本轮事件轮循结束之前,而不是在下轮轮循开始之后

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

下面是一个用Promise对象实现的 Ajax 操作的例子。

const getJSON = function(url){
    const promise =  new Promise(function(resolve, reject){
        const handler = function(){
            if(this.readyState !== 4){
                return;
            }
            if(this.status === 200){
                resolve(this.response);
            }else{
                reject(new Error(this.statusText));
            }
        };
        const client = new XMLHttpRequest();
        client.open("GET", url);
        client.onreadystatechange = handle;
        client.responseType = "json";
        client.setRequestHeader("Accept", "application/json");
        client.send();
    };
    
    return promise;
}

getJSON("/posts.json").then(function(json){
    console.log('Contents:'+json);
},function(error){
   console.log('error:'+error); 
});

reject函数的参数通常是Error对象的实例,表示抛出错误,resolve函数的参数除了正常的值之外,还可以是另一个Promise实例。

const p1 = new Promise(function(resolve, reject){
    // TODO
});

const p2 = new Promise(fucntion(resolve, reject){
    //TODO
    resolve(p1);
})

这时p1的状态就会传递给p2,也就是说,p1的状态决定了p2的状态。如果p1的状态是pending,那么p2的回调函数就会等待p1的状态改变;如果p1的状态已经是resolved或者rejected,那么p2的回调函数将会立刻执行。

const p1 = new Promise(function(resolve, reject){
    setTimeOut(() => reject(new Error('fail')),3000);
});

const p2 = new Promise(function(resolve, reject){
    setTimeOut(() => resolve(p1), 1000);
});

p2
.then(result => console.log(result))
.catch(error => console.log(error));

// Error: fail

上面代码中,p1是一个 Promise,3 秒之后变为rejected。p2的状态在 1 秒之后改变,resolve方法返回的是p1。由于p2返回的是另一个 Promise,导致p2自己的状态无效了,由p1的状态决定p2的状态。所以,后面的then语句都变成针对后者(p1)。又过了 2 秒,p1变为rejected,导致触发catch方法指定的回调函数。

注意,调用resolve或reject并不会终结 Promise 的参数函数的执行。

new Promise((resolve, reject) => {
  resolve(1);
  console.log(2);
}).then(r => {
  console.log(r);
});
// 2
// 1

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

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

new Promise((resolve, reject) => {
  return resolve(1);
  // 后面的语句不会执行
  console.log(2);
})

Promise.prototype.then()

Promise 实例具有then方法,也就是说,then方法是定义在原型对象Promise.prototype上的。它的作用是为 Promise 实例添加状态改变时的回调函数。前面说过,then方法的第一个参数是resolved状态的回调函数,第二个参数(可选)是rejected状态的回调函数。

then方法返回的是一个新的Promise实例(注意,不是原来那个Promise实例)。因此可以采用链式写法,即then方法后面再调用另一个then方法。

getJSON('/utl').then(function(json){
    return json.post;
}).then(function(post){
    console.log(post);
});

上面的代码使用then方法,依次指定了两个回调函数。第一个回调函数完成以后,会将返回结果作为参数,传入第二个回调函数。

采用链式的then,可以指定一组按照次序调用的回调函数。这时,前一个回调函数,有可能返回的还是一个Promise对象(即有异步操作),这时后一个回调函数,就会等待该Promise对象的状态发生变化,才会被调用。

getJSON('url').then(function(post){
    return getJSON(post.commentURL);
}).then(function func1(comments){
    console.log('resolved', comments);
},function func2(err){
    console.log('rejected', err);
});

上面代码中,第一个then方法指定的回调函数,返回的是另一个Promise对象。这时,第二个then方法指定的回调函数,就会等待这个新的Promise对象状态发生变化。如果变为resolved,就调用funcA,如果状态变为rejected,就调用funcB。

Promise.prototype.catch()

Promise.prototype.catch(rejectFunc)是.then(null, rejectFunc)的别名,用于指定发生错误时的回调。

以下两种写法等价。

const promise = new Promise((resolve, reject) => {
  try{
    throw new Error('error');
  }catch(e){
    reject(e);
  }  
});
promise.catch(error => console.log(error));

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

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

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

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

好的写法:

//good
promise
    .then(data => {
        // TODO
    })
    .catch(error => {
        // error
    });

//bad
promise
    .then(data => {
        //TODO
    }, error => {
        //error
    });

跟传统的try/catch代码块不同的是,如果没有使用catch方法指定错误处理的回调函数,Promise 对象抛出的错误不会传递到外层代码,即不会有任何反应。

Promise.resolve()

Promise.resolve()用于将现有的对象转为Promise对象。

const jsPromise = Promise.resolve($.ajax('url'));


//Promise.reslove()的等价写法。
Promise.resolve('foo');
//等价于
new Promise(resolve => resolve('foo'))
  • 参数为一个Promise实例
    如果参数是一个Promise实例,那么Promise.resolve将不做任何修改,返回原对象。
  • 参数是一个thenadle对象
    thenable对象是指都具有then方法的对象,比如下面这个对象
let thenable = {
    then : function(resolve, reject){
        resolve(42);
    })
}

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

let thenable = {
    then : function(resolve, reject){
        resolve(42);  //如果在此then函数中不改变Promise状态,则回调函数不会被执行。
    }
};

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

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

  • 参数不是具有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方法的参数,会同时传给回调函数。

  • 不带有任何参数

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

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

setTimeOut(() => {console.log('3');}, 0);

Promise.resolve().then(() => {
    console.log('2');
});

console.log('1');

//1
//2
//3

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

Promise.all()

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

const p1 = 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对象的数组
const 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 实例。

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

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

Promise.race方法的参数与Promise.all方法一样,如果不是 Promise 实例,就会先调用下面讲到的Promise.resolve方法,将参数转为 Promise 实例,再进一步处理。

  • 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.reject()方法的参数,会原封不动地作为reject的理由,变成后续方法的参数。这一点与Promise.resolve方法不一致。

参考

推荐阅读更多精彩内容

  • 00、前言Promise 是异步编程的一种解决方案,比传统的解决方案——回调函数和事件——更合理和更强大。它由社区...
    夜幕小草阅读 792评论 0 11
  • Promiese 简单说就是一个容器,里面保存着某个未来才会结束的事件(通常是一个异步操作)的结果,语法上说,Pr...
    雨飞飞雨阅读 1,391评论 2 18
  • Promise的含义:   Promise是异步编程的一种解决方案,比传统的解决方案——回调函数和事件——更合理和...
    呼呼哥阅读 1,006评论 0 15
  • //本文内容起初摘抄于 阮一峰 作者的译文,用于记录和学习,建议观者移步于原文 概念: 所谓的Promise,...
    曾经过往阅读 633评论 0 6
  • 我在乱岗之中,看见一座坟墓,我看见一个鲜活的生命葬入了泥土,那生命哭泣着来到这人世,向世界诉说她的到来...
    断梦残生阅读 381评论 0 0