JavaScript高级系列(十七) - Promise用法的详细解析

JavaScript高级系列(十七) - Promise用法的详细解析

Promise是ES6之后新增的一个重要知识点(也可以说是最重要的知识点之一),是每个前端开发都必须要掌握的知识点。

但是对于Promise的学习来说,很多同学会觉得有点迷茫,刚开始不知所云、困难重重。

本章中我们会详细学习Promise的各种用法(事无巨细),并且还会通过手写Promise让大家了解它的底层原理。

一. 认识Promise

1.1. 异步回调处理

在ES6出来之后,有很多关于Promise的讲解、文章,也有很多经典的书籍讲解Promise,包括JavaScript高级程序设计、你不知道的JavaScript。

  • 虽然等你学会Promise之后,会觉得Promise不过如此,但是在初次接触的时候都会觉得这个东西不好理解;
  • 而网上的很多资料对于它的切入点,我一直觉得对于新手来说特别的不友好;
  • 看到一大堆的例子,但是依然不知道这个东西有什么作用?

那么这里我从一个实际的例子来作为切入点:

  • 我们调用一个函数,这个函数中发送网络请求(我们可以用定时器来模拟);
  • 如果发送网络请求成功了,那么告知调用者发送成功,并且将相关数据返回过去;
  • 如果发送网络请求失败了,那么告知调用者发送失败,并且告知错误信息;

比如我们将网络请求封装到一个request.js的文件中:

js 复制代码
// request.js
function requestData(url) {
  setTimeout(() => {
    if (url === "http://coderwhy.org") {
      // 发送成功了
    } else {
      // 发送失败了
    }
  }, 1000);
}

那么现在我们面临一个问题:

  • 在请求成功时,如何告知调用者我们请求成功了?
  • 在请求失败时,如果告知调用者我们请求失败了?

在传统的代码中我们有一种做法:通过回调函数。

js 复制代码
// request.js
function requestData(url, successCallback, failureCallback) {
  setTimeout(() => {
    if (url === "http://coderwhy.org") {
      // 发送成功了
      successCallback("一组成数据")
    } else {
      // 发送失败了
      successCallback("请求url错误")
    }
  }, 1000);
}

// main.js
requestData("http://coderwhy.org", (res) => {
  console.log("数据请求成功:", res)
}, (err) => {
  console.log("数据请求失败:", err)
})

1.2. 什么是Promise

在上面的解决方案中,我们确确实实可以解决请求函数得到结果之后,获取到对应的回调,但是它存在两个主要的问题:

  • 第一,我们需要自己来设计回调函数、回调函数的名称、回调函数的使用等;
  • 第二,对于不同的人、不同的框架设计出来的方案是不同的,那么我们必须耐心去看别人的源码或者文档,以便可以理解它这个函数到底怎么用;

我们来看一下Promise的API是怎么样的:

  • Promise是一个类,可以翻译成 承诺、许诺期约
  • 当我们需要给予调用者一个承诺:待会儿我会给你回调数据时,就可以创建一个Promise的对象;
  • 在通过new创建Promise对象时,我们需要传入一个回调函数,我们称之为executor
    • 这个回调函数会被立即执行,并且给传入另外两个回调函数resolve、reject;
    • 当我们调用resolve回调函数时,会执行Promise对象的then方法传入的回调函数;
    • 当我们调用reject回调函数时,会执行Promise对象的catch方法传入的回调函数;
js 复制代码
const promise = new Promise((resolve, reject) => {
  // 调用resolve, 那么then传入的回调会被执行
  resolve("哈哈哈")
  // 调用reject, 那么catch传入的回调会被执行
  reject("错误信息")
})

promise.then(res => {
  console.log(res)
}).catch(err => {
  console.log(err)
})

上面Promise使用过程,我们可以将它划分成三个状态:

  • 待定(pending) : 初始状态,既没有被兑现,也没有被拒绝;
    • 当执行executor中的代码时,处于该状态;
  • 已兑现(fulfilled) : 意味着操作成功完成;
    • 执行了resolve时,处于该状态;
  • 已拒绝(rejected) : 意味着操作失败;
    • 执行了reject时,处于该状态;

1.3. Promise重构

那么有了Promise,我们就可以将之前的代码进行重构了:

js 复制代码
// request.js
function requestData(url) {
  return new Promise((resolve, reject) => {
    setTimeout(() => {
      if (url === "http://coderwhy.org") {
        // 发送成功了
        resolve("一组成功数据")
      } else {
        // 发送失败了
        reject("请求url错误")
      }
    }, 1000);
  })
}


// main.js
const promise = requestData("http://coderwhy.org")
promise.then((res) => {
  console.log(res)
}).catch((err) => {
  console.log(err)
})

二. Promise对象方法

2.1. Executor

Executor是在创建Promise时需要传入的一个回调函数,这个回调函数会被立即执行,并且传入两个参数:

js 复制代码
new Promise((resolve, reject) => {
  console.log("executor代码")
})

通常我们会在Executor中确定我们的Promise状态:

  • 通过resolve,可以兑现(fulfilled)Promise的状态,我们也可以称之为已决议(resolved);
  • 通过reject,可以拒绝(reject)Promise的状态;

这里需要注意:一旦状态被确定下来,Promise的状态会被 锁死,该Promise的状态是不可更改的

  • 在我们调用resolve的时候,如果resolve传入的值本身不是一个Promise,那么会将该Promise的状态变成 兑现(fulfilled)
  • 在之后我们去调用reject时,已经不会有任何的响应了(并不是这行代码不会执行,而是无法改变Promise状态);
js 复制代码
new Promise((resolve, reject) => {
  resolve("已决议")
  reject("已拒绝")
}).then(res => {
  console.log("res:", res)
}).catch(err => {
  console.log("err:", err)
})

如果resolve中传入的是另外一个Promise,那么这个新Promise会决定原Promise的状态:

js 复制代码
new Promise((resolve, reject) => {
  resolve(new Promise((resolve, reject) => {
    setTimeout(() => {
      resolve("第二个Promise的resolve")
    }, 3000);
  }))
}).then(res => {
  console.log("res:", res)
}).catch(err => {
  console.log("err:", err)
})

如果resolve中传入的是一个对象,并且这个对象有实现then方法,那么会执行该then方法,并且根据then方法的结果来决定Promise的状态:

js 复制代码
new Promise((resolve, reject) => {
  resolve({
    then: function(resolve_, reject_) {
      // resolve_("222")
      resolve_("err message")
    }
  })
}).then(res => {
  console.log("res:", res)
}).catch(err => {
  console.log("err:", err)
})

2.2. then方法

then方法是Promise对象上的一个方法:它其实是放在Promise的原型上的 Promise.prototype.then

2.2.1. then方法两个参数

then方法接受两个参数:

  • fulfilled的回调函数:当状态变成fulfilled时会回调的函数;
  • reject的回调函数:当状态变成reject时会回调的函数;
js 复制代码
const promise = new Promise((resolve, reject) => {

})

promise.then(res => {
  console.log("res:", res)
}, err => {
  console.log("err:", err)
})

但是这个代码等同于:

js 复制代码
promise.then(res => {
  console.log("res:", res)
}).catch(err => {
  console.log("err:", err)
})

我们更推荐下面的写法,可以将两个状态的回调完全分开。

2.2.2. then方法多次调用

一个Promise的then方法是可以被多次调用的:

  • 每次调用我们都可以传入对应的fulfilled回调;
  • 当Promise的状态变成fulfilled的时候,这些回调函数都会被执行;
js 复制代码
promise.then(res => {
  console.log("res1:", res)
})

promise.then(res => {
  console.log("res2:", res)
})

promise.then(res => {
  console.log("res3:", res)
})

2.2.3. then方法的返回值

then方法本身是有返回值的,它的返回值是一个Promise,所以我们可以进行如下的链式调用:

js 复制代码
promise.then(res => {
  console.log("res1:", res)
}).then(res => {
  console.log("res2:", res)
}).then(res => {
  console.log("res3:", res)
})

但是then方法返回的Promise到底处于什么样的状态呢?Promise有三种状态,那么这个Promise处于什么状态呢?

  • 当then方法中的回调函数本身在执行的时候,那么它处于pending状态;
  • 当then方法中的回调函数返回一个结果时,那么它处于fulfilled状态,并且会将结果作为resolve的参数;
    • 如果返回的结果是一个Promise呢?那么这个新Promise的状态会决定then返回Promise的状态;
  • 当then方法抛出一个异常时,那么它处于reject状态;
js 复制代码
promise.then(res => {
  console.log("res1:", res)
  // 1.直接返回一个值
  return "then function fulfilled"
}).then(res => {
  console.log("res2:", res)
  // 2.返回Promise
  return new Promise((resolve, reject) => {
    setTimeout(() => {
      resolve("new promise fulfilled")
    }, 2000);
  })
}).then(res => {
  console.log("res3:", res)
  // 3.抛出一个异常
  throw new Error("error message")
}).catch(err => {
  console.log("err:", err.message)
})

2.3. catch方法

catch方法也是Promise对象上的一个方法:它也是放在Promise的原型上的 Promise.prototype.catch

2.3.1. catch方法多次调用

一个Promise的catch方法是可以被多次调用的:

  • 每次调用我们都可以传入对应的reject回调;
  • 当Promise的状态变成reject的时候,这些回调函数都会被执行;
js 复制代码
// 1.可以多次调用
promise.catch(err => {
  console.log("err:", err)
})

promise.catch(err => {
  console.log("err:", err)
})

2.3.2. catch方法的返回值

事实上catch方法也是会返回一个Promise对象的,所以catch方法后面我们可以继续调用then方法或者catch方法:

  • 下面的代码,后续是catch中的err2打印,还是then中的res打印呢?
  • 答案是res打印,这是因为catch传入的回调在执行完后,默认状态依然会是fulfilled的;
js 复制代码
promise.catch(err => {
  console.log("err1:", err)
}).catch(err => {
  console.log("err2:", err)
}).then(res => {
  console.log("res:", res)
})

那么如果我们希望后续继续执行catch,那么需要抛出一个异常:

js 复制代码
promise.catch(err => {
  console.log("err1:", err)
  throw new Error("error message")
}).then(res => {
  console.log("res:", res)
}).catch(err => {
  console.log("err2:", err)
})

当然我们依然是可以返回一个Promise的:

js 复制代码
promise.catch(err => {
  console.log("err1:", err)
  return new Promise((resolve, reject) => {
    reject("err message")
  })
}).then(res => {
  console.log("res:", res)
}).catch(err => {
  console.log("err2:", err)
})

2.4. finally方法

finally是在ES9(ES2018)中新增的一个特性:表示无论Promise对象无论变成fulfilled还是reject状态,最终都会被执行的代码。

finally方法是不接收参数的,因为无论前面是fulfilled状态,还是reject状态,它都会执行。

js 复制代码
const promise = new Promise((resolve, reject) => {
  // resolve("fulfilled")
  reject("reject")
})

promise.then(res => {
  console.log("res:", res)
}).catch(err => {
  console.log("err:", err)
}).finally(() => {
  console.log("finally action")
})

三. Promise类方法

前面我们学习的then、catch、finally方法都属于Promise的实例方法,都是存放在Promise的prototype上的。

下面我们再来学习一下Promise的类方法。

3.1. resolve方法

有时候我们已经有一个现成的内容了,希望将其转成Promise来使用,这个时候我们可以使用 Promise.resolve 方法来完成。

Promise.resolve的用法相当于new Promise:

js 复制代码
Promise.resolve("why")
// 类似于
new Promise((resolve) => resolve("why"))

我们可以看一下源码中的实现:

Promise.resolve的参数可能会有几种形态:

情况一:参数本身是Promise

  • 那么会将传入的Promise作为resolve函数的返回值;
js 复制代码
Promise.resolve(new Promise((resolve, reject) => {
  setTimeout(() => {
    resolve("promise argument")
  }, 3000);
})).then(res => {
  console.log("res:", res)
})

情况二:是一个对象,但是对象中有then方法

js 复制代码
Promise.resolve({
  then: function(resolve_, reject_) {
    // resolve_("222")
    resolve_("err message")
  }
}).then(res => {
  console.log("res:", res)
}).catch(err => {
  console.log("err:", err)
})

情况三:是一个值或者普通的对象,那么会直接作为fulfilled的结果

js 复制代码
Promise.resolve("coderwhy").then(res => {
  console.log("res:", res)
})

3.2. reject方法

reject方法类似于resolve方法,只是会将Promise对象的状态设置为reject状态。

Promise.reject的用法相当于new Promise,只是会调用reject:

js 复制代码
Promise.reject("why")
// 相当于
new Promise((resolve, reject) => reject("why"))

Promise.reject传入的参数无论是什么形态,都会直接作为reject状态的参数传递到catch的。

3.3. all方法

另外一个类方法是Promise.all:

  • 它的作用是将多个Promise包裹在一起形成一个新的Promise;
  • 新的Promise状态由包裹的所有Promise共同决定:
    • 当所有的Promise状态变成fulfilled状态时,新的Promise状态为fulfilled,并且会将所有Promise的返回值组成一个数组;
    • 当有一个Promise状态为reject时,新的Promise状态为reject,并且会将第一个reject的返回值作为参数;
js 复制代码
const p1 = new Promise((resolve, reject) => {
  setTimeout(() => {
    resolve("111")
  }, 1000);
})

const p2 = new Promise((resolve, reject) => {
  setTimeout(() => {
    resolve("222")
  }, 2000);
})

const p3 = new Promise((resolve, reject) => {
  setTimeout(() => {
    resolve("333")
  }, 3000);
})

Promise.all([p1, p2, p3]).then(res => {
  console.log(res)
}).catch(err => {
  console.log(err)
})

3.4. allSettled方法

all方法有一个缺陷:当有其中一个Promise变成reject状态时,新Promise就会立即变成对应的reject状态。

  • 那么对于resolved的,以及依然处于pending状态的Promise,我们是获取不到对应的结果的;

在ES11(ES2020)中,添加了新的API Promise.allSettled:

  • 该方法会在所有的Promise都有结果(settled),无论是fulfilled,还是reject时,才会有最终的状态;
  • 并且这个Promise的结果一定是fulfilled的;
js 复制代码
const p1 = new Promise((resolve, reject) => {
  setTimeout(() => {
    resolve("111")
  }, 1000);
})

const p2 = new Promise((resolve, reject) => {
  setTimeout(() => {
    reject("err 222")
  }, 2000);
})

const p3 = new Promise((resolve, reject) => {
  setTimeout(() => {
    resolve("333")
  }, 3000);
})

Promise.allSettled([p1, p2, p3]).then(res => {
  console.log(res)
}).catch(err => {
  console.log(err)
})

我们来看一下打印的结果:

  • allSettled的结果是一个数组,数组中存放着每一个Promise的结果,并且是对应一个对象的;
  • 这个对象中包含status状态,以及对应的value值;
js 复制代码
[
  { status: 'fulfilled', value: '111' },
  { status: 'rejected', reason: 'err 222' },
  { status: 'fulfilled', value: '333' }
]

3.5. race方法

如果有一个Promise有了结果,我们就希望决定最终新Promise的状态,那么可以使用race方法:

  • race是竞技、竞赛的意思,表示多个Promise相互竞争,谁先有结果,那么就使用谁的结果;
js 复制代码
const p1 = new Promise((resolve, reject) => {
  setTimeout(() => {
    resolve("111")
  }, 1000);
})

const p2 = new Promise((resolve, reject) => {
  setTimeout(() => {
    reject("err 222")
  }, 2000);
})

const p3 = new Promise((resolve, reject) => {
  setTimeout(() => {
    resolve("333")
  }, 3000);
})

Promise.race([p1, p2, p3]).then(res => {
  console.log(res)
}).catch(err => {
  console.log(err)
})

3.6. any方法

any方法是ES12中新增的方法,和race方法是类似的:

  • any方法会等到一个fulfilled状态,才会决定新Promise的状态;
  • 如果所有的Promise都是reject的,那么也会等到所有的Promise都变成rejected状态;
js 复制代码
const p1 = new Promise((resolve, reject) => {
  setTimeout(() => {
    reject("111")
  }, 1000);
})

const p2 = new Promise((resolve, reject) => {
  setTimeout(() => {
    reject("err 222")
  }, 2000);
})

const p3 = new Promise((resolve, reject) => {
  setTimeout(() => {
    resolve("333")
  }, 3000);
})

Promise.any([p1, p2, p3]).then(res => {
  console.log(res)
}).catch(err => {
  console.log("err:", err)
})

如果所有的Promise都是reject的,那么会报一个AggregateError的错误。

本文由mdnice多平台发布

相关推荐
喵叔哟7 分钟前
重构代码之取消临时字段
java·前端·重构
还是大剑师兰特1 小时前
D3的竞品有哪些,D3的优势,D3和echarts的对比
前端·javascript·echarts
王解1 小时前
【深度解析】CSS工程化全攻略(1)
前端·css
一只小白菜~1 小时前
web浏览器环境下使用window.open()打开PDF文件不是预览,而是下载文件?
前端·javascript·pdf·windowopen预览pdf
方才coding1 小时前
1小时构建Vue3知识体系之vue的生命周期函数
前端·javascript·vue.js
阿征学IT1 小时前
vue过滤器初步使用
前端·javascript·vue.js
王哲晓1 小时前
第四十五章 Vue之Vuex模块化创建(module)
前端·javascript·vue.js
丶21361 小时前
【WEB】深入理解 CORS(跨域资源共享):原理、配置与常见问题
前端·架构·web
发现你走远了1 小时前
『VUE』25. 组件事件与v-model(详细图文注释)
前端·javascript·vue.js
Mr.咕咕1 小时前
Django 搭建数据管理web——商品管理
前端·python·django