webcourse/Webcourse
3
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

update: Promise 详解

Browse Source
This commit is contained in:
qianguyihao 2021-04-30 17:55:17 +08:00
parent 491c425acd
commit 9c15a2955a
3 changed files with 835 additions and 612 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

793
05-JavaScript之ES6语法/10-Promise入门详解.md
View File

@ -1,4 +1,4 @@
## 异步调用 ## 前言：异步和回调
### 异步 ### 异步
@ -6,9 +6,7 @@ JavaScript 的执行环境是**单线程**。
所谓单线程，是指 JS 引擎中负责解释和执行 JavaScript 代码的线程只有一个，也就是一次只能完成一项任务，这个任务执行完后才能执行下一个，它会「阻塞」其他任务。这个任务可称为主线程。 所谓单线程，是指 JS 引擎中负责解释和执行 JavaScript 代码的线程只有一个，也就是一次只能完成一项任务，这个任务执行完后才能执行下一个，它会「阻塞」其他任务。这个任务可称为主线程。
异步模式可以一起执行**多个任务**。 异步模式可以一起执行**多个任务**。常见的异步模式有以下几种：
常见的异步模式有以下几种：
- 定时器 - 定时器
@ -22,22 +20,60 @@ JavaScript 的执行环境是**单线程**。
js 中常见的接口调用方式，有以下几种： js 中常见的接口调用方式，有以下几种：
- 原生 ajax - 原生 ajax、基于 jQuery 的 ajax
- 基于 jQuery 的 ajax
- Fetch
- Promise - Promise
- Fetch
- axios - axios
### 多次异步调用的依赖分析 ### 多次异步调用的顺序
- 多次异步调用的结果，顺序可能不同步。 - 多次异步调用的结果，顺序可能不同步。
- 异步调用的结果如果**存在依赖**，则需要嵌套。 - 异步调用的结果如果**存在依赖**，则需要通过回调函数进行嵌套。
在 ES5 中，当进行多层嵌套回调时，会导致代码层次过多，很难进行维护和二次开发；而且会导致**回调地狱**的问题。ES6 中的 Promise 就可以解决这两个问题。 ### 回调地狱的举例
假设买菜、做饭、洗碗、倒厨余垃圾都是异步的。
但真实的场景中，实际的操作流程是：买菜成功之后，才能开始做饭。做饭成功后，才能开始洗碗。洗碗结束后， 再倒厨余垃圾。这里的一系列动作就涉及到了多层嵌套调用，也就是回调地狱。
在 ES5 中，当进行多层嵌套回调时，会导致代码层次过多，很难进行后续维护和二次开发；而且会导致**回调地狱**的问题。ES6 中的 Promise 就可以解决这两个问题。
## Promise 概述 ## Promise 概述
### 为什么需要 Promise？
如上一段所述，Javascript 是⼀⻔单线程语⾔。早期我们解决异步场景时，⼤部分情况都是通过回调函数来进⾏。
例如在浏览器中发送 ajax 请求，就是常⻅的⼀个异步场景，发送请求后，需要等待一段时间，等服务端响应之后我们才能拿到结果。如果我们希望在异步结束之后执⾏某个操作，就只能通过**回调函数**这样的⽅式进⾏操作。
```js
var dynamicFunc = function (callback) {
setTimeout(function () {
callback();
}, 1000);
};
dynamicFunc(function () {
console.log('qian gu');
});
```
例如上⾯这个例⼦，dynamicFunc 就是⼀个异步函数，⾥⾯ setTimeout 会在 1s 之后调⽤传⼊的 callback 函数。按照上⾯的调⽤⽅式，最终 1s 之后，会打印 qian gu 这个结果。
同样的，如果后续还有内容需要在异步函数结束时输出，就需要多个异步函数进⾏嵌套，⾮常不利于后续的维护，而且会导致**回调地狱**的问题：
```js
setTimeout(function () {
console.log('qiangu1');
setTimeout(function () {
console.log('qiangu2');
}, 2000);
}, 1000);
```
为了能使回调函数以更优雅的⽅式进⾏调⽤，在 ES6 语法中，新增了⼀个名为 Promise 的新规范。
### Promise 的介绍和优点 ### Promise 的介绍和优点
ES6 中的 Promise 是异步编程的一种方案。从语法上讲，Promise 是一个对象，它可以获取异步操作的消息。 ES6 中的 Promise 是异步编程的一种方案。从语法上讲，Promise 是一个对象，它可以获取异步操作的消息。
@ -48,37 +84,29 @@ Promise 对象, 可以**用同步的表现形式来书写异步代码**（也就
- 语法非常简洁、可读性强。Promise 对象提供了简洁的 API，使得控制异步操作更加容易。 - 语法非常简洁、可读性强。Promise 对象提供了简洁的 API，使得控制异步操作更加容易。
### 回调地狱的举例 ## Promise 基础
假设买菜、做饭、洗碗、倒厨余垃圾都是异步的。 ### Promise 的基本用法
但真实的场景中，实际的操作流程是：买菜成功之后，才能开始做饭。做饭成功后，才能开始洗碗。洗碗结束后， 再倒厨余垃圾。这里的一系列动作就涉及到了多层嵌套调用，也就是回调地狱。 （1）通过 `new Promise()` 构造出一个 Promise 实例。Promise 的构造函数中传入一个参数，这个参数是一个函数，该函数用于处理异步任务。
## Promise 的基本用法 （2）函数中传入两个参数：resolve 和 reject，分别表示异步执行成功后的回调函数和异步执行失败后的回调函数。代表着我们需要改变当前实例的状态到**已完成**或是**已拒绝**。
（1）使用 new 实例化一个 Promise 对象，Promise 的构造函数中传递一个参数。这个参数是一个函数，该函数用于处理异步任务。 （3）通过 promise.then() 处理返回结果（这里的 `promise` 指的是 Promise 实例）。
（2）并且传入两个参数：resolve 和 reject，分别表示异步执行成功后的回调函数和异步执行失败后的回调函数； 接下来，我们来具体看看， promise 的代码是怎么写的。
（3）通过 promise.then() 处理返回结果。这里的 `promise` 指的是 Promise 实例。 ### Promise 处理异步任务的过程
### Promise 处理异步任务 通过 Promise 处理异步任务的典型写法如下：
```html ```js
<!DOCTYPE html> // 第一步：model层的接口封装
<html lang="en"> function promiseA() {
<head> return new Promise((resolve, reject) => {
<meta charset="UTF-8" /> // 这里做异步任务（比如 ajax 请求接口。这里暂时用定时器代替）
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> setTimeout(() => {
<title>Document</title> var data = { retCode: 0, msg: 'qianguyihao' }; // 接口返回的数据，返回码 retCode 是动态数据
</head>
<body>
<script>
// 第一步：model层的接口封装
const promise = new Promise((resolve, reject) => {
// 这里做异步任务（比如ajax 请求接口。这里暂时用定时器代替）
setTimeout(function () {
var data = { retCode: 0, msg: 'qianguyihao' }; // 接口返回的数据
if (data.retCode == 0) { if (data.retCode == 0) {
// 接口请求成功时调用 // 接口请求成功时调用
resolve(data); resolve(data);
@ -88,90 +116,127 @@ Promise 对象, 可以**用同步的表现形式来书写异步代码**（也就
} }
}, 100); }, 100);
}); });
}
// 第二步：业务层的接口调用。这里的 data 就是 从 resolve 和 reject 传过来的，也就是从接口拿到的数据 // 第二步：业务层的接口调用。这里的 data 就是 从 resolve 和 reject 传过来的，也就是从接口拿到的数据
promise promiseA()
.then((data) => { .then((data) => {
// 从 resolve 获取正常结果 // 从 resolve 获取正常结果
console.log(data); console.log(data);
}) })
.catch((data) => { .catch((e) => {
// 从 reject 获取异常结果 // 从 reject 获取异常结果
console.log(data); console.log(e);
}); });
</script>
</body>
</html>
``` ```
上方代码中，当从接口返回的数据`data.retCode`的值不同时，可能会走 resolve，也可能会走 reject，这个由你自己的业务决定。 上方代码中，当从接口返回的数据`data.retCode`的值（接口返回码）不同时，可能会走 resolve，也可能会走 reject，这个由你自己的业务决定。
### Promise 封装 Ajax 请求 上面的写法中，是将 promise 实例定义成了一个**函数** `PromiseA`。我们也可以将 promise 实例定义成一个**变量** `promiseB`，达到的效果是一模一样的。写法如下：（写法上略有区别）
写法1：
```js ```js
const request = require('request'); // 第一步：model层的接口封装
const promiseB = new Promise((resolve, reject) => {
// Promise 封装接口 // 这里做异步任务（比如ajax 请求接口。这里暂时用定时器代替）
function request1() { setTimeout(() => {
return new Promise((resolve, reject) => { var data = { retCode: 0, msg: 'qianguyihao' }; // 接口返回的数据，返回码 retCode 是动态数据
request('https://www.baidu.com', function (response) { if (data.retCode == 0) {
if (response.retCode == 200) { // 接口请求成功时调用
// 这里的 response 是接口1的返回结果 resolve(data);
resolve('request1 success' + response);
} else { } else {
reject('接口请求失败'); // 接口请求失败时调用
reject({ retCode: -1, msg: 'network error' });
} }
}, 100);
});
// 第二步：业务层的接口调用。这里的 data 就是 从 resolve 和 reject 传过来的，也就是从接口拿到的数据
promiseB
.then((data) => {
// 从 resolve 获取正常结果
console.log(data);
})
.catch((e) => {
// 从 reject 获取异常结果
console.log(e);
}); });
```
### 捕获 reject 异常状态的两种写法
我们有两种写法可以捕获并处理 reject 异常状态。上一小段中，用的就是其中一种写法。
这两种写法的代码举例如下：
```js
// 第一步：model层的接口封装
function promiseA() {
return new Promise((resolve, reject) => {
// 这里做异步任务（比如 ajax 请求接口。这里暂时用定时器代替）
setTimeout(() => {
var data = { retCode: 0, msg: 'qianguyihao' }; // 接口返回的数据，返回码 retCode 是动态数据
if (data.retCode == 0) {
// 接口请求成功时调用
resolve(data);
} else {
// 接口请求失败时调用
reject({ retCode: -1, msg: 'network error' });
}
}, 100);
}); });
} }
request1().then((res1) => { const onResolve = function (value) {
// 接口1请求成功后，打印接口1的返回结果 console.log(value);
console.log(res1);
return request2();
});
```
写法2：
```js
const request = require('request');
// Promise 封装接口1
const request1 = function () {
const promise = new Promise((resolve, reject) => {
request('https://www.baidu.com', function (response) {
if (response.retCode == 200) {
// 这里的 response 是接口1的返回结果
resolve('request1 success' + response);
} else {
reject('接口请求失败');
}
});
});
return promise;
}; };
// 先发起request1，等resolve后再发起request2；紧接着，等 request2有了 resolve之后，再发起 request3 const onReject = function (e) {
request1().then((res1) => { console.log(e);
// 接口1请求成功后，打印接口1的返回结果 };
console.log(res1);
return request2();
});
// 写法1：通过 catch 方法捕获 状态变为已拒绝时的 promise
promiseA().then(onResolve).catch(onReject);
// 写法2：then 可以传两个参数，第⼀个参数为 resolve 后执⾏，第⼆个参数为 reject 后执⾏
promiseA().then(onResolve, onReject);
// 【错误写法】写法3：通过 try catch 捕获 状态变为已拒绝时的 promise
// 这种写法是错误的，因为 try catch只能捕获同步代码里的异常，而 promise.reject() 是异步代码。
try {
promiseA().then(onResolve);
} catch (e) {
// 语法上，catch必须要传入一个参数，否则报错
onReject(e);
}
``` ```
需要注意的是，上面的写法 3 是错误的。运行之后，控制台会报如下错误：
## promise 对象的 3 个状态（了解即可） ![](http://img.smyhvae.com/20210430_1553.png)
- 初始化状态（等待状态）：pending [解释如下](https://blog.csdn.net/xiaoluodecai/article/details/107297404)：
- 成功状态：fulfilled try-catch 主要用于捕获异常，注意，这里的异常是指**同步**函数的异常。如果 try 里面的异步方法出现了异常，此时 catch 是无法捕获到异常的。
- 失败状态：rejected 原因是：当异步函数抛出异常时，对于宏任务而言，执行函数时已经将该函数推入栈，此时并不在 try-catch 所在的栈，所以 try-catch 并不能捕获到错误。对于微任务而言（比如 promise）promise 的构造函数的异常只能被自带的 reject 也就是.catch 函数捕获到。
### 小结
1、promise 有三种状态：等待中、成功、失败。等待中状态可以更改为成功或失败，已经更改过状态后⽆法继续更改（例如从失败改为成功）。
2、promise 实例中需要传⼊⼀个函数，他接受两个函数参数，执⾏第⼀个参数之后就会改变当前 promise 为「成功」状态，执⾏第⼆个参数之后就会变为「失败」状态。
3、通过 .then ⽅法，即可在上⼀个 promise 达到成功时继续执⾏下⼀个函数或 promise。同时通过 resolve 或 reject 时传⼊参数，即可给下⼀个函数或 promise 传⼊初始值。
4、失败的 promise，后续可以通过 promise 自带的 .catch ⽅法或是 .then ⽅法的第⼆个参数进⾏捕获。
## promise 对象的 3 个状态
- 初始化（等待中）：pending
- 成功：fulfilled
- 失败：rejected
（1）当 new Promise()执行之后，promise 对象的状态会被初始化为`pending`，这个状态是初始化状态。`new Promise()`这行代码，括号里的内容是同步执行的。括号里定义一个 function，function 有两个参数：resolve 和 reject。如下： （1）当 new Promise()执行之后，promise 对象的状态会被初始化为`pending`，这个状态是初始化状态。`new Promise()`这行代码，括号里的内容是同步执行的。括号里定义一个 function，function 有两个参数：resolve 和 reject。如下：
@ -216,32 +281,129 @@ promise.then(
); );
``` ```
## 基于 Promise 处理多次 Ajax 请求（链式调用）【重要】 ## 如何封装异步操作为 promise
实际开发中，我们经常需要同时请求多个接口。比如说：在请求完`接口1`的数据`data1`之后，需要根据`data1`的数据，继续请求接口 2，获取`data2`；然后根据`data2`的数据，继续请求接口 3。 ### Promise 封装异步任务
换而言之，现在有三个网络请求，请求 2 必须依赖请求 1 的结果，请求 3 必须依赖请求 2 的结果，如果按照往常的写法，会有三层回调，会陷入“回调地狱”。 **传统写法**：
这种场景其实就是接口的多层嵌套调用。有了 Promise 之后，我们可以把多层嵌套调用按照**线性**的方式进行书写，非常优雅。也就是说：Promise 可以把原本的**多层嵌套调用**改进为**链式调用**。 写法 1：
代码举例：（多次 Ajax 请求，链式调用） ```js
// 定义一个异步的延迟函数：异步函数结束1秒之后，再执行cb回调函数
function fun1(cb) {
setTimeout(function () {
console.log('即将执行cb回调函数');
cb();
}, 1000);
}
```html // 先执行异步函数 fun1，再执行回调函数 myCallback
<!DOCTYPE html> fun1(myCallback);
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Document</title>
</head>
<body>
<script>
const request = require('request');
// Promise 封装接口1 // 定义回调函数
const request1 = function () { function myCallback() {
const promise = new Promise((resolve, reject) => { console.log('我是延迟执行的cb回调函数');
request('https://www.baidu.com', function (response) { }
```
写法 2：（精简版，更常见）
```js
// 定义一个异步的延迟函数：异步函数结束1秒之后，再执行cb回调函数
function fun1(cb) {
setTimeout(cb, 1000);
}
// 先执行异步函数fun1，再执行回调函数
fun1(function () {
console.log('我是延迟执行的cb回调函数');
});
```
上⾯的例⼦就是最传统的写法，在异步结束后通过传入回到函数的方式执⾏函数。
学习 Promise 之后，我们可以将这个异步函数封装为 Promise，如下。
**Promise 写法**：
```js
function fun2() {
return new Promise((resolve) => {
setTimeout(resolve, 1000);
});
}
// 上面的 fun2 也可以写成：
// function fun2() {
// return new Promise((resolve) => {
// setTimeout(() => {
// resolve();
// }, 1000);
// });
// }
// 先执行异步函数fun1，再执行回调函数
fun2().then(() => {
console.log('我是延迟执行的回调函数');
});
```
### Promise 封装 Ajax 请求
**传统写法**：
```js
// 定义 ajax 请求：传入回调函数 success 和 fail
function ajax(url, success, fail) {
var client = new XMLHttpRequest();
client.open('GET', url);
client.onreadystatechange = function () {
if (this.readyState !== 4) {
return;
}
if (this.status === 200) {
success(this.response);
} else {
fail(new Error(this.statusText));
}
};
client.send();
}
// 执行 ajax 请求
ajax(
'/ajax.json',
function () {
console.log('qianguyihao 成功');
},
function () {
console.log('失败');
}
);
```
上面的传统写法里，定义和执行 ajax 时需要传⼊ success 和 fail 这两个回调函数，进而执行回调函数。
有了 Promise 之后，我们不需要传入回调函数，而是：
- 先将 promise 实例化；
- 然后在原来执行回调函数的地方，改为执行对应的改变 promise 状态的函数；
- 并通过 then ... catch 或者 then ...then 等写法，实现链式调用，提高代码可读性。
和传统写法相比，promise 在写法上的大致区别是：定义异步函数的时候，将 callback 改为 resolve 和 reject，待状态改变之后，我们在外面控制具体执行哪些函数。
**Promise 写法**：
```js
const request = require('request');
// Promise 定义接口
function request1() {
return new Promise((resolve, reject) => {
request('https://www.baidu.com', (response) => {
if (response.retCode == 200) { if (response.retCode == 200) {
// 这里的 response 是接口1的返回结果 // 这里的 response 是接口1的返回结果
resolve('request1 success' + response); resolve('request1 success' + response);
@ -250,423 +412,24 @@ promise.then(
} }
}); });
}); });
}
return promise; request1()
};
// Promise 封装接口2
const request2 = function () {
const promise = new Promise((resolve, reject) => {
request('https://www.jd.com', function (response) {
if (response.retCode == 200) {
// 这里的 response 是接口2的返回结果
resolve('request2 success' + response);
} else {
reject('接口请求失败');
}
});
});
return promise;
};
// Promise 封装接口3
const request3 = function () {
const promise = new Promise((resolve, reject) => {
request('https://www.taobao.com', function (response) {
if (response.retCode == 200) {
// 这里的 response 是接口3的返回结果
resolve('request3 success' + response);
} else {
reject('接口请求失败');
}
});
});
return promise;
};
// 先发起request1，等resolve后再发起request2；紧接着，等 request2有了 resolve之后，再发起 request3
request1()
.then((res1) => { .then((res1) => {
// 接口1请求成功后，打印接口1的返回结果 // 接口1请求成功后，打印接口1的返回结果
console.log(res1); console.log(res1);
return request2(); return request2();
}) })
.then((res2) => { .catch((e) => {
// 接口2请求成功后，打印接口2的返回结果
console.log(res2);
return request3();
})
.then((res3) => {
// 接口3请求成功后，打印接口3的返回结果
console.log(res3);
});
</script>
</body>
</html>
```
上面代码中，then 是可以链式调用的，后面的 then 可以拿到前面 resolve 出来的数据。
这个举例很经典，需要多看几遍。
## return 的函数返回值
return 后面的返回值，有两种情况：
- 情况 1：返回 Promise 实例对象。返回的该实例对象会调用下一个 then。
- 情况 2：返回普通值。返回的普通值会直接传递给下一个 then，通过 then 参数中函数的参数接收该值。
我们针对上面这两种情况，详细解释一下。
### 情况 1：返回 Promise 实例对象
举例如下：（这个例子，跟上一段 Ajax 链式调用 的例子差不多）
```html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Document</title>
</head>
<body>
<script type="text/javascript">
/*
基于Promise发送Ajax请求
*/
function queryData(url) {
return new Promise((resolve, reject) => {
var xhr = new XMLHttpRequest();
xhr.onreadystatechange = function () {
if (xhr.readyState != 4) return;
if (xhr.readyState == 4 && xhr.status == 200) {
// 处理正常情况
resolve(xhr.responseText);
} else {
// 处理异常情况
reject('接口请求失败');
}
};
xhr.responseType = 'json'; // 设置返回的数据类型
xhr.open('get', url);
xhr.send(null); // 请求接口
});
}
// 发送多个ajax请求并且保证顺序
queryData('http://localhost:3000/api1')
.then(
(data1) => {
console.log(JSON.stringify(data1));
return queryData('http://localhost:3000/api2');
},
(error1) => {
console.log(error1);
}
)
.then(
(data2) => {
console.log(JSON.stringify(data2));
// 这里的 return，返回的是 Promise 实例对象
return new Promise((resolve, reject) => {
resolve('qianguyihao');
});
},
(error2) => {
console.log(error2);
}
)
.then((data3) => {
console.log(data3);
});
</script>
</body>
</html>
```
### 情况 2：返回 普通值
```html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Document</title>
</head>
<body>
<script type="text/javascript">
/*
基于Promise发送Ajax请求
*/
function queryData(url) {
return new Promise((resolve, reject) => {
var xhr = new XMLHttpRequest();
xhr.onreadystatechange = function () {
if (xhr.readyState != 4) return;
if (xhr.readyState == 4 && xhr.status == 200) {
// 处理正常情况
resolve(xhr.responseText);
} else {
// 处理异常情况
reject('接口请求失败');
}
};
xhr.responseType = 'json'; // 设置返回的数据类型
xhr.open('get', url);
xhr.send(null); // 请求接口
});
}
// 发送多个ajax请求并且保证顺序
queryData('http://localhost:3000/api1')
.then(
(data1) => {
console.log(JSON.stringify(data1));
return queryData('http://localhost:3000/api2');
},
(error1) => {
console.log(error1);
}
)
.then(
(data2) => {
console.log(JSON.stringify(data2));
// 返回普通值
return 'qianguyihao';
},
(error2) => {
console.log(error2);
}
)
/*
既然上方返回的是 普通值，那么，这里的 then 是谁来调用呢？
答案是：这里会产生一个新的 默认的 promise实例，来调用这里的then，确保可以继续进行链式操作。
*/
.then((data3) => {
// 这里的 data3 接收的是 普通值 'qianguyihao'
console.log(data3);
});
</script>
</body>
</html>
```
## Promise 的常用 API：实例方法【重要】
Promise 自带的 API 提供了如下实例方法：
- promise.then()：获取异步任务的正常结果。
- promise.catch()：获取异步任务的异常结果。
- promise.finaly()：异步任务无论成功与否，都会执行。
代码举例如下。
写法 1：
```html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Document</title>
</head>
<body>
<script>
function queryData() {
return new Promise((resolve, reject) => {
setTimeout(function () {
var data = { retCode: 0, msg: 'qianguyihao' }; // 接口返回的数据
if (data.retCode == 0) {
// 接口请求成功时调用
resolve(data);
} else {
// 接口请求失败时调用
reject({ retCode: -1, msg: 'network error' });
}
}, 100);
});
}
queryData()
.then((data) => {
// 从 resolve 获取正常结果
console.log('接口请求成功时，走这里');
console.log(data);
})
.catch((data) => {
// 从 reject 获取异常结果 // 从 reject 获取异常结果
console.log('接口请求失败时，走这里'); console.log(e);
console.log(data);
})
.finally(() => {
console.log('无论接口请求成功与否，都会走这里');
}); });
</script>
</body>
</html>
``` ```
写法 2：（和上面的写法 1 等价） ## 总结
```html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Document</title>
</head>
<body>
<script>
function queryData() {
return new Promise((resolve, reject) => {
setTimeout(function () {
var data = { retCode: 0, msg: 'qianguyihao' }; // 接口返回的数据
if (data.retCode == 0) {
// 接口请求成功时调用
resolve(data);
} else {
// 接口请求失败时调用
reject({ retCode: -1, msg: 'network error' });
}
}, 100);
});
}
queryData() 了解这些内容之后， 你已经对 Promise 有了基本了解。下一篇文章，我们来讲一讲 Promise的常见用法。
.then(
(data) => {
// 从 resolve 获取正常结果
console.log('接口请求成功时，走这里');
console.log(data);
},
(data) => {
// 从 reject 获取异常结果
console.log('接口请求失败时，走这里');
console.log(data);
}
)
.finally(() => {
console.log('无论接口请求成功与否，都会走这里');
});
</script>
</body>
</html>
```
**注意**：写法 1 和写法 2 的作用是完全等价的。只不过，写法 2 是把 catch 里面的代码作为 then 里面的第二个参数而已。
## Promise 的常用 API：对象方法【重要】
Promise 自带的 API 提供了如下对象方法：
- Promise.all()：并发处理多个异步任务，所有任务都执行成功，才能得到结果。
- Promise.race(): 并发处理多个异步任务，只要有一个任务执行成功，就能得到结果。
下面来详细介绍。
### Promise.all() 代码举例
代码举例：
```html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Document</title>
</head>
<body>
<script type="text/javascript">
/*
封装 Promise 接口调用
*/
function queryData(url) {
return new Promise((resolve, reject) => {
var xhr = new XMLHttpRequest();
xhr.onreadystatechange = function () {
if (xhr.readyState != 4) return;
if (xhr.readyState == 4 && xhr.status == 200) {
// 处理正常结果
resolve(xhr.responseText);
} else {
// 处理异常结果
reject('服务器错误');
}
};
xhr.open('get', url);
xhr.send(null);
});
}
var promise1 = queryData('http://localhost:3000/api1');
var promise2 = queryData('http://localhost:3000/api2');
var promise3 = queryData('http://localhost:3000/api3');
Promise.all([promise1, promise2, promise3]).then((result) => {
console.log(result);
});
</script>
</body>
</html>
```
### Promise.race() 代码举例
代码举例：
```html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Document</title>
</head>
<body>
<script type="text/javascript">
/*
封装 Promise 接口调用
*/
function queryData(url) {
return new Promise((resolve, reject) => {
var xhr = new XMLHttpRequest();
xhr.onreadystatechange = function () {
if (xhr.readyState != 4) return;
if (xhr.readyState == 4 && xhr.status == 200) {
// 处理正常结果
resolve(xhr.responseText);
} else {
// 处理异常结果
reject('服务器错误');
}
};
xhr.open('get', url);
xhr.send(null);
});
}
var promise1 = queryData('http://localhost:3000/api1');
var promise2 = queryData('http://localhost:3000/api2');
var promise3 = queryData('http://localhost:3000/api3');
Promise.race([promise1, promise2, promise3]).then((result) => {
console.log(result);
});
</script>
</body>
</html>
```
了解这些内容之后， Promise 的基本用法，你就已经掌握了。
## 参考链接 ## 参考链接

454
05-JavaScript之ES6语法/11-Promise的常见用法和API.md Normal file
View File

@ -0,0 +1,454 @@
## 链式调用：基于 Promise 处理多次 Ajax 请求【重要】
实际开发中，我们经常需要同时请求多个接口。比如说：在请求完`接口1`的数据`data1`之后，需要根据`data1`的数据，继续请求接口 2，获取`data2`；然后根据`data2`的数据，继续请求接口 3。
换而言之，现在有三个网络请求，请求 2 必须依赖请求 1 的结果，请求 3 必须依赖请求 2 的结果，如果按照往常的写法，会有三层回调，会陷入“回调地狱”。
这种场景其实就是接口的多层嵌套调用。有了 Promise 之后，我们可以把多层嵌套调用按照**线性**的方式进行书写，非常优雅。也就是说：Promise 可以把原本的**多层嵌套调用**改进为**链式调用**。
代码举例：（多次 Ajax 请求，链式调用）
```html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Document</title>
</head>
<body>
<script>
const request = require('request');
// Promise 封装接口1
const request1 = function () {
const promise = new Promise((resolve, reject) => {
request('https://www.baidu.com', function (response) {
if (response.retCode == 200) {
// 这里的 response 是接口1的返回结果
resolve('request1 success' + response);
} else {
reject('接口请求失败');
}
});
});
return promise;
};
// Promise 封装接口2
const request2 = function () {
const promise = new Promise((resolve, reject) => {
request('https://www.jd.com', function (response) {
if (response.retCode == 200) {
// 这里的 response 是接口2的返回结果
resolve('request2 success' + response);
} else {
reject('接口请求失败');
}
});
});
return promise;
};
// Promise 封装接口3
const request3 = function () {
const promise = new Promise((resolve, reject) => {
request('https://www.taobao.com', function (response) {
if (response.retCode == 200) {
// 这里的 response 是接口3的返回结果
resolve('request3 success' + response);
} else {
reject('接口请求失败');
}
});
});
return promise;
};
// 先发起request1，等resolve后再发起request2；紧接着，等 request2有了 resolve之后，再发起 request3
request1()
.then((res1) => {
// 接口1请求成功后，打印接口1的返回结果
console.log(res1);
return request2();
})
.then((res2) => {
// 接口2请求成功后，打印接口2的返回结果
console.log(res2);
return request3();
})
.then((res3) => {
// 接口3请求成功后，打印接口3的返回结果
console.log(res3);
});
</script>
</body>
</html>
```
上面代码中，then 是可以链式调用的，后面的 then 可以拿到前面 resolve 出来的数据。
这个举例很经典，需要多看几遍。
## return 的函数返回值
return 后面的返回值，有两种情况：
- 情况 1：返回 Promise 实例对象。返回的该实例对象会调用下一个 then。
- 情况 2：返回普通值。返回的普通值会直接传递给下一个 then，通过 then 参数中函数的参数接收该值。
我们针对上面这两种情况，详细解释一下。
### 情况 1：返回 Promise 实例对象
举例如下：（这个例子，跟上一段 Ajax 链式调用 的例子差不多）
```html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Document</title>
</head>
<body>
<script type="text/javascript">
/*
基于Promise发送Ajax请求
*/
function queryData(url) {
return new Promise((resolve, reject) => {
var xhr = new XMLHttpRequest();
xhr.onreadystatechange = function () {
if (xhr.readyState != 4) return;
if (xhr.readyState == 4 && xhr.status == 200) {
// 处理正常情况
resolve(xhr.responseText);
} else {
// 处理异常情况
reject('接口请求失败');
}
};
xhr.responseType = 'json'; // 设置返回的数据类型
xhr.open('get', url);
xhr.send(null); // 请求接口
});
}
// 发送多个ajax请求并且保证顺序
queryData('http://localhost:3000/api1')
.then(
(data1) => {
console.log(JSON.stringify(data1));
return queryData('http://localhost:3000/api2');
},
(error1) => {
console.log(error1);
}
)
.then(
(data2) => {
console.log(JSON.stringify(data2));
// 这里的 return，返回的是 Promise 实例对象
return new Promise((resolve, reject) => {
resolve('qianguyihao');
});
},
(error2) => {
console.log(error2);
}
)
.then((data3) => {
console.log(data3);
});
</script>
</body>
</html>
```
### 情况 2：返回 普通值
```html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Document</title>
</head>
<body>
<script type="text/javascript">
/*
基于Promise发送Ajax请求
*/
function queryData(url) {
return new Promise((resolve, reject) => {
var xhr = new XMLHttpRequest();
xhr.onreadystatechange = function () {
if (xhr.readyState != 4) return;
if (xhr.readyState == 4 && xhr.status == 200) {
// 处理正常情况
resolve(xhr.responseText);
} else {
// 处理异常情况
reject('接口请求失败');
}
};
xhr.responseType = 'json'; // 设置返回的数据类型
xhr.open('get', url);
xhr.send(null); // 请求接口
});
}
// 发送多个ajax请求并且保证顺序
queryData('http://localhost:3000/api1')
.then(
(data1) => {
console.log(JSON.stringify(data1));
return queryData('http://localhost:3000/api2');
},
(error1) => {
console.log(error1);
}
)
.then(
(data2) => {
console.log(JSON.stringify(data2));
// 返回普通值
return 'qianguyihao';
},
(error2) => {
console.log(error2);
}
)
/*
既然上方返回的是 普通值，那么，这里的 then 是谁来调用呢？
答案是：这里会产生一个新的 默认的 promise实例，来调用这里的then，确保可以继续进行链式操作。
*/
.then((data3) => {
// 这里的 data3 接收的是 普通值 'qianguyihao'
console.log(data3);
});
</script>
</body>
</html>
```
## Promise 的常用 API：实例方法【重要】
Promise 自带的 API 提供了如下实例方法：
- promise.then()：获取异步任务的正常结果。
- promise.catch()：获取异步任务的异常结果。
- promise.finaly()：异步任务无论成功与否，都会执行。
代码举例如下。
写法 1：
```html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Document</title>
</head>
<body>
<script>
function queryData() {
return new Promise((resolve, reject) => {
setTimeout(function () {
var data = { retCode: 0, msg: 'qianguyihao' }; // 接口返回的数据
if (data.retCode == 0) {
// 接口请求成功时调用
resolve(data);
} else {
// 接口请求失败时调用
reject({ retCode: -1, msg: 'network error' });
}
}, 100);
});
}
queryData()
.then((data) => {
// 从 resolve 获取正常结果
console.log('接口请求成功时，走这里');
console.log(data);
})
.catch((data) => {
// 从 reject 获取异常结果
console.log('接口请求失败时，走这里');
console.log(data);
})
.finally(() => {
console.log('无论接口请求成功与否，都会走这里');
});
</script>
</body>
</html>
```
写法 2：（和上面的写法 1 等价）
```html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Document</title>
</head>
<body>
<script>
function queryData() {
return new Promise((resolve, reject) => {
setTimeout(function () {
var data = { retCode: 0, msg: 'qianguyihao' }; // 接口返回的数据
if (data.retCode == 0) {
// 接口请求成功时调用
resolve(data);
} else {
// 接口请求失败时调用
reject({ retCode: -1, msg: 'network error' });
}
}, 100);
});
}
queryData()
.then(
(data) => {
// 从 resolve 获取正常结果
console.log('接口请求成功时，走这里');
console.log(data);
},
(data) => {
// 从 reject 获取异常结果
console.log('接口请求失败时，走这里');
console.log(data);
}
)
.finally(() => {
console.log('无论接口请求成功与否，都会走这里');
});
</script>
</body>
</html>
```
**注意**：写法 1 和写法 2 的作用是完全等价的。只不过，写法 2 是把 catch 里面的代码作为 then 里面的第二个参数而已。
## Promise 的常用 API：对象方法【重要】
Promise 自带的 API 提供了如下对象方法：
- Promise.all()：并发处理多个异步任务，所有任务都执行成功，才能得到结果。
- Promise.race(): 并发处理多个异步任务，只要有一个任务执行成功，就能得到结果。
下面来详细介绍。
### Promise.all() 代码举例
代码举例：
```html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Document</title>
</head>
<body>
<script type="text/javascript">
/*
封装 Promise 接口调用
*/
function queryData(url) {
return new Promise((resolve, reject) => {
var xhr = new XMLHttpRequest();
xhr.onreadystatechange = function () {
if (xhr.readyState != 4) return;
if (xhr.readyState == 4 && xhr.status == 200) {
// 处理正常结果
resolve(xhr.responseText);
} else {
// 处理异常结果
reject('服务器错误');
}
};
xhr.open('get', url);
xhr.send(null);
});
}
var promise1 = queryData('http://localhost:3000/api1');
var promise2 = queryData('http://localhost:3000/api2');
var promise3 = queryData('http://localhost:3000/api3');
Promise.all([promise1, promise2, promise3]).then((result) => {
console.log(result);
});
</script>
</body>
</html>
```
### Promise.race() 代码举例
代码举例：
```html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Document</title>
</head>
<body>
<script type="text/javascript">
/*
封装 Promise 接口调用
*/
function queryData(url) {
return new Promise((resolve, reject) => {
var xhr = new XMLHttpRequest();
xhr.onreadystatechange = function () {
if (xhr.readyState != 4) return;
if (xhr.readyState == 4 && xhr.status == 200) {
// 处理正常结果
resolve(xhr.responseText);
} else {
// 处理异常结果
reject('服务器错误');
}
};
xhr.open('get', url);
xhr.send(null);
});
}
var promise1 = queryData('http://localhost:3000/api1');
var promise2 = queryData('http://localhost:3000/api2');
var promise3 = queryData('http://localhost:3000/api3');
Promise.race([promise1, promise2, promise3]).then((result) => {
console.log(result);
});
</script>
</body>
</html>
```

6
05-JavaScript之ES6语法/11-ES7：async函数详解.md → 05-JavaScript之ES6语法/12-ES7：async函数详解.md
View File

@ -58,6 +58,12 @@ async 后面可以跟一个 Promise 实例对象。代码举例如下：
暂略。 暂略。
### Promise、async...await、Generator的对比
我们在使用 Promise、async...await、Generator 的时候，返回的都是 Promise 的实例。
如果直接使用 Promise，则需要通过 then 来进行链式调用；如果使用 async...await、Generator，写起来更像同步的代码。
## 参考链接 ## 参考链接
- [js async await 终极异步解决方案](https://www.cnblogs.com/CandyManPing/p/9384104.html) - [js async await 终极异步解决方案](https://www.cnblogs.com/CandyManPing/p/9384104.html)