ES6 Promise对象的理解学习

￡神魔★判官ぃ 2023-01-03 04:22 191阅读 0赞

### 文章目录 ###

*  前言
 *  一、定义
 *  二、基本用法
 *  三、应用
 *  四、Promise.prototype.then()
 *  五、Promise.prototype.catch()
 *  六、Promise.prototype.finally()
 *  七、Promise.all()
 *  八、Promise.race()
 *  九、Promise.allSettled()
 *  十、Promise.any()
 *  十一、Promise.resolve()
 *  十二、Promise.reject()
 *  参考文章

# 前言 #

> Promise改善异步代码的处理，Async/await改善Promise的使用。

# 一、定义 #

Promise 是异步编程的一种解决方案，比传统的解决方案——回调函数和事件——更合理和更强大。

所谓Promise，简单说就是一个容器，里面保存着某个未来才会结束的事件（通常是一个异步操作）的结果。从语法上说，**Promise 是一个对象，从它可以获取异步操作的消息**。

**Promise对象有以下两个特点：**

（1）对象的状态不受外界影响。Promise对象代表一个异步操作，有三种状态：`pending`（进行中）、`fulfilled`（已成功）和`rejected`（已失败）。只有异步操作的结果，可以决定当前是哪一种状态，任何其他操作都无法改变这个状态。

（2）一旦状态改变，就不会再变，任何时候都可以得到这个结果。Promise对象的状态改变，只有两种可能：`从pending变为fulfilled`和`从pending变为rejected`。只要这两种情况发生，状态就凝固了，不会再变了，会一直保持这个结果，这时就称为 `resolved`（已定型）。如果改变已经发生了，你再对Promise对象添加回调函数，也会立即得到这个结果。这与事件（Event）完全不同，事件的特点是，如果你错过了它，再去监听，是得不到结果的。

**优点：**

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

**缺点：**

（1）无法取消Promise，一旦新建它就会立即执行，无法中途取消。  
（2）如果不设置回调函数，Promise内部抛出的错误，不会反应到外部。  
（3）当处于pending状态时，无法得知目前进展到哪一个阶段（刚刚开始还是即将完成）。

# 二、基本用法 #

ES6 规定，**`Promise`对象是一个构造函数，用来生成`Promise`实例**。

下面代码创造了一个`Promise`实例。

const 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`状态和`rejected`状态的回调函数。**

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

`then`方法可以接受两个回调函数作为参数。第一个回调函数是Promise对象的状态变为resolved时调用，第二个回调函数是Promise对象的状态变为rejected时调用。这两个函数都是可选的，不一定要提供。它们都接受Promise对象传出的值作为参数。

# 三、应用 #

**（1）创建Promise对象的简单例子**

function timeout(ms) { 
        return new Promise((resolve, reject) => { 
        	console.log('Promise');
            // setTimeout(function(){ 
            // resolve('123')
            // }, ms)
            //等同于
            setTimeout(resolve, ms, 'done')
        })
    }
    timeout(3000).then((resolve) => { 
        console.log(resolve)
    })

上面代码中，timeout方法返回一个Promise实例，Promise 会立即执行。过了指定的时间（ms参数）以后，Promise实例的状态变为`resolved`，就会触发`then`方法绑定的回调函数。

**（2）异步加载图片**

上面代码中，使用Promise包装了一个图片加载的异步操作。如果加载成功，就调用`resolve`方法，否则就调用`reject`方法。

**（3）用Promise对象实现的 Ajax**

上面代码中，getJSON是对 `XMLHttpRequest` 对象的封装，用于发出一个针对 JSON 数据的 HTTP 请求，并且返回一个Promise对象。

**（4）resolve函数的参数是另一个 Promise 实例**

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

上面代码中，`p1`和`p2`都是 Promise 的实例，但是`p2`的`resolve`方法将`p1`作为参数，即一个异步操作的结果是返回另一个异步操作。这时，`p1`的状态就会传递给`p2`，也就是说，`p1`的状态决定了`p2`的状态。如果`p1`的状态是`pending`，那么`p2`的回调函数就会等待`p1`的状态改变；如果`p1`的状态已经是`resolved`或者`rejected`，那么`p2`的回调函数将会立刻执行。

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

# 四、Promise.prototype.then() #

Promise 实例具有`then`方法，也就是说，`then`方法是定义在原型对象`Promise.prototype`上的。它的作用是为 Promise 实例添加状态改变时的回调函数。

getJSON("/posts.json").then(function(json) { 
      	return json.post;
    }).then(function(post) { 
      	// ...
    });

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

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

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

# 五、Promise.prototype.catch() #

`Promise.prototype.catch()`方法是`.then(null, rejection)`或`.then(undefined, rejection)`的别名，用于指定发生错误时的回调函数。

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));

看下面一个例子。

上面代码中，如果Promise 对象状态变为resolved，则会调用then()方法指定的回调函数；如果异步操作抛出错误，状态就会变为rejected，就会调用catch()方法指定的回调函数，处理这个错误。另外，**`then()`方法指定的回调函数，如果运行中抛出错误，也会被catch()方法捕获。**

注意，以下3种写法是等价的。

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

比较上面三种写法，可以发现`reject()`方法的作用，等同于抛出错误。

同时，如果 Promise 状态已经变成`resolved`，再抛出错误是无效的。

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

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`方法。因为`catch`方法可以捕获前面`then`方法执行中的错误，也更接近同步的写法（`try/catch`）。

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

所以一般总是建议，Promise 对象后面要跟`catch()`方法，这样可以处理 Promise 内部发生的错误。**`catch()`方法返回的还是一个 Promise 对象，因此后面还可以接着调用`then()`方法**。

上面代码运行完`catch()`方法指定的回调函数，会接着运行后面那个`then()`方法指定的回调函数。如果没有报错，则会跳过catch()方法。此时，**要是后面那个`then()`方法里面报错，就与前面的`catch()`无关了**。如果需要捕获`catch()`方法或`then()`方法里面的报错，应该在最后面再添加一个`.catch()`。

# 六、Promise.prototype.finally() #

`finally()`方法用于指定不管 Promise 对象最后状态如何，都会执行的操作。

promise
    .then(result => { ···})
    .catch(error => { ···})
    .finally(() => { ···});

上面代码中，不管promise最后的状态，**在执行完`then`或`catch`指定的回调函数以后**，都会执行`finally`方法指定的回调函数。

**`finally`方法的回调函数不接收任何参数**，这意味着没有办法知道，前面的 Promise 状态到底是`fulfilled`还是`rejected`。这表明，**`finally`方法里面的操作，应该是与状态无关的，不依赖于 Promise 的执行结果**。

# 七、Promise.all() #

`Promise.all()`方法用于将多个 Promise 实例，包装成一个新的 Promise 实例。

const 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对象的数组
    function createPromise (id){ 
        return new Promise(function(resolve, reject){ 
            return resolve(id);
        })
    }
    
    const promises = [2, 3, 5, 7, 11, 13].map(function (id) { 
      	return createPromise(id);
    });
    
    Promise.all(promises).then(function (posts) { 
      	console.log(posts)
    }).catch(function(reason){ 
      	console.log(reason)
    });
    
    //[2, 3, 5, 7, 11, 13]

上面代码中，promises是包含 6 个 Promise 实例的数组，只有这 6 个实例的状态都变成`fulfilled`，或者其中有一个变为`rejected`，才会调用`Promise.all`方法后面的回调函数。

注意，**如果作为参数的 Promise 实例，自己定义了`catch`方法，那么它一旦被`rejected`，并不会触发`Promise.all()`的`catch`方法。**

const p1 = new Promise((resolve, reject) => { 
        resolve('hello');
    })
    .then(result => result)
    .catch(e => e);
    
    const p2 = new Promise((resolve, reject) => { 
        throw new Error('报错了');
    })
    .then(result => result)
    .catch(e => e);
    
    Promise.all([p1, p2])
    .then(result => console.log(result))
    .catch(e => console.log(e));
    // ["hello", Error: 报错了]

上面代码中，`p1`会`resolved`，`p2`首先会`rejected`，但是`p2`有自己的`catch`方法，该方法返回的是一个新的 Promise 实例，`p2`指向的实际上是这个实例。该实例执行完`catch`方法后，也会变成`resolved`，导致`Promise.all()`方法参数里面的两个实例都会`resolved`，因此会调用`then`方法指定的回调函数，而不会调用`catch`方法指定的回调函数。

# 八、Promise.race() #

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

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

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

`p`的状态由`p1`、`p2`、`p3`决定，**只要`p1`、`p2`、`p3`之中有一个实例率先改变状态，`p`的状态就跟着改变**。那个率先改变的 Promise 实例的返回值，就传递给`p`的回调函数。

下面是一个例子，如果指定时间内没有获得结果，就将 Promise 的状态变为`reject`，否则变为`resolve`。

const p = Promise.race([
        new Promise(function(resolve, reject) { 
            setTimeout(() => resolve('resolve'), 5000)
        }),
        new Promise(function (resolve, reject) { 
            setTimeout(() => reject(new Error('request timeout')), 3000)
        })
    ]);
    
    p
    .then(console.log)
    .catch(console.error);

上面代码中，如果 3 秒之内第一个`promise`实例无法返回结果，变量`p`的状态就会变为`rejected`，从而触发`catch`方法指定的回调函数。

# 九、Promise.allSettled() #

`Promise.allSettled()`方法接受一组 Promise 实例作为参数，包装成一个新的 Promise 实例。**只有等到所有这些参数实例都返回结果，不管是`fulfilled`还是`rejected`，包装实例才会结束**。

该方法返回的新的 Promise 实例，**一旦结束，状态总是`fulfilled`**，不会变成`rejected`。状态变成`fulfilled`后，Promise 的监听函数接收到的参数是一个数组，每个成员对应一个传入`Promise.allSettled()`的 Promise 实例。

下面是一个使用`Promise.allSettled()`的例子。

const p = Promise.allSettled([
        new Promise(function(resolve, reject) { 
            setTimeout(() => resolve('resolve'), 4000)
        }),
        new Promise(function (resolve, reject) { 
            setTimeout(() => reject(new Error('request timeout')), 3000)
        })
    ]);
    
    p
    .then(console.log)
    .catch(console.error);

返回：  
![在这里插入图片描述][20210107173333684.png]

下面是一个应用`Promise.allSettled()`的例子。

const promises = [
    	fetch('/api-1'),
        fetch('/api-2'),
      	fetch('/api-3'),
    ];
    
    await Promise.allSettled(promises);
    removeLoadingIndicator();

上面代码中，对服务器发出三个请求，等到三个请求都结束，不管请求成功还是失败，加载的滚动图标就会消失。

下面是返回值用法的例子。

const promises = [ fetch('index.html'), fetch('https://does-not-exist/') ];
    const results = await Promise.allSettled(promises);
    
    // 过滤出成功的请求
    const successfulPromises = results.filter(p => p.status === 'fulfilled');
    
    // 过滤出失败的请求，并输出原因
    const errors = results
      .filter(p => p.status === 'rejected')
      .map(p => p.reason);

**有时候，我们不关心异步操作的结果，只关心这些操作有没有结束。这时，`Promise.allSettled()`方法就很有用。**`Promise.all()`方法无法做到这一点。

# 十、Promise.any() #

`Promise.any()`方法。该方法接受一组 Promise 实例作为参数，包装成一个新的 Promise 实例返回。**只要参数实例有一个变成`fulfilled`状态，包装实例就会变成`fulfilled`状态；如果所有参数实例都变成`rejected`状态，包装实例就会变成`rejected`状态**。

`Promise.any()`跟`Promise.race()`方法很像，只有一点不同，就是不会因为某个 Promise 变成`rejected`状态而结束。

`Promise.any()`抛出的错误，不是一个一般的错误，而是一个 `AggregateError` 实例。它相当于一个数组，每个成员对应一个被`rejected`的操作所抛出的错误。

下面是一个例子。

var resolved = Promise.resolve(42);
    var rejected = Promise.reject(-1);
    var alsoRejected = Promise.reject(Infinity);
    
    Promise.any([resolved, rejected, alsoRejected]).then(function (result) { 
        console.log(result); // 42
    });
    
    Promise.any([rejected, alsoRejected]).catch(function (results) { 
        console.log(results); // [-1, Infinity] 
        //这里我实际打印的是 AggregateError: All promises were rejected 有待验证
    });

# 十一、Promise.resolve() #

**`Promise.resolve()`方法可以将现有对象转为 Promise 对象。**

const 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`将不做任何修改、原封不动地返回这个实例。

**（2）参数是一个thenable对象**

`thenable`对象指的是具有`then`方法的对象，比如下面这个对象。

let thenable = { 
    	then: function(resolve, reject) { 
    		resolve(42);
    	}
    };

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

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

**（3）参数不是具有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()`方法的参数，会同时传给回调函数。

**（4）不带有任何参数**

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

const p = Promise.resolve();
    
    p.then(function () { 
    	 // ...
    });

上面代码的变量`p`就是一个 Promise 对象。

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

# 十二、Promise.reject() #

`Promise.reject()`方法也会返回一个新的 Promise 实例，该实例的状态为`rejected`。

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

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

`Promise.reject()`方法的参数，会原封不动地作为reject的理由，变成后续方法的参数。

Promise.reject('出错了')
    .catch(e => { 
    	console.log(e === '出错了')
    })
    // true

上面代码中，`Promise.reject()`方法的参数是一个字符串，后面`catch()`方法的参数`e`就是这个字符串。

# 参考文章 #

[https://es6.ruanyifeng.com/\#docs/promise][https_es6.ruanyifeng.com_docs_promise]  
[https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Guide/Using\_promises][https_developer.mozilla.org_zh-CN_docs_Web_JavaScript_Guide_Using_promises]

[20210107173333684.png]: /images/20221119/ad38d29d9b5c4bbd9173ac5a1bd68aee.png
[event loop]: https://blog.csdn.net/HuangsTing/article/details/111830927
[https_es6.ruanyifeng.com_docs_promise]: https://es6.ruanyifeng.com/#docs/promise
[https_developer.mozilla.org_zh-CN_docs_Web_JavaScript_Guide_Using_promises]: https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Guide/Using_promises