You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

19 KiB

19 | Promise使用Promise告别回调函数

在[上一篇文章](https://time.geekbang.org/column/article/135624)中我们聊到了微任务是如何工作的并介绍了MutationObserver是如何利用微任务来权衡性能和效率的。今天我们就接着来聊聊微任务的另外一个应用**Promise**DOM/BOM API中新加入的API大多数都是建立在Promise上的而且新的前端框架也使用了大量的Promise。可以这么说Promise已经成为现代前端的“水”和“电”很是关键所以深入学习Promise势在必行。

不过Promise的知识点有那么多而我们只有一篇文章来介绍那应该怎么讲解呢具体讲解思路是怎样的呢

如果你想要学习一门新技术最好的方式是先了解这门技术是如何诞生的以及它所解决的问题是什么。了解了这些后你才能抓住这门技术的本质。所以本文我们就来重点聊聊JavaScript引入Promise的动机以及解决问题的几个核心关键点。

要谈动机我们一般都是先从问题切入那么Promise到底解决了什么问题呢在正式开始介绍之前我想有必要明确下Promise解决的是异步编码风格的问题而不是一些其他的问题所以接下来我们聊的话题都是围绕编码风格展开的。

异步编程的问题:代码逻辑不连续

首先我们来回顾下JavaScript的异步编程模型你应该已经非常熟悉页面的事件循环系统了也知道页面中任务都是执行在主线程之上的相对于页面来说主线程就是它整个的世界所以在执行一项耗时的任务时比如下载网络文件任务、获取摄像头等设备信息任务这些任务都会放到页面主线程之外的进程或者线程中去执行这样就避免了耗时任务“霸占”页面主线程的情况。你可以结合下图来看看这个处理过程

Web应用的异步编程模型

上图展示的是一个标准的异步编程模型,页面主线程发起了一个耗时的任务,并将任务交给另外一个进程去处理,这时页面主线程会继续执行消息队列中的任务。等该进程处理完这个任务后,会将该任务添加到渲染进程的消息队列中,并排队等待循环系统的处理。排队结束之后,循环系统会取出消息队列中的任务进行处理,并触发相关的回调操作。

这就是页面编程的一大特点:异步回调

Web页面的单线程架构决定了异步回调而异步回调影响到了我们的编码方式到底是如何影响的呢

假设有一个下载的需求使用XMLHttpRequest来实现具体的实现方式你可以参考下面这段代码

//执行状态
function onResolve(response){console.log(response) }
function onReject(error){console.log(error) }

let xhr = new XMLHttpRequest()
xhr.ontimeout = function(e) { onReject(e)}
xhr.onerror = function(e) { onReject(e) }
xhr.onreadystatechange = function () { onResolve(xhr.response) }

//设置请求类型请求URL是否同步信息
let URL = 'https://time.geekbang.com'
xhr.open('Get', URL, true);

//设置参数
xhr.timeout = 3000 //设置xhr请求的超时时间
xhr.responseType = "text" //设置响应返回的数据格式
xhr.setRequestHeader("X_TEST","time.geekbang")

//发出请求
xhr.send();

我们执行上面这段代码,可以正常输出结果的。但是,这短短的一段代码里面竟然出现了五次回调,这么多的回调会导致代码的逻辑不连贯、不线性,非常不符合人的直觉,这就是异步回调影响到我们的编码方式。

那有什么方法可以解决这个问题吗?当然有,我们可以封装这堆凌乱的代码,降低处理异步回调的次数。

封装异步代码,让处理流程变得线性

由于我们重点关注的是输入内容(请求信息)输出内容(回复信息),至于中间的异步请求过程,我们不想在代码里面体现太多,因为这会干扰核心的代码逻辑。整体思路如下图所示:

封装请求过程

从图中你可以看到我们将XMLHttpRequest请求过程的代码封装起来了重点关注输入数据和输出结果。

那我们就按照这个思路来改造代码。首先我们把输入的HTTP请求信息全部保存到一个request的结构中包括请求地址、请求头、请求方式、引用地址、同步请求还是异步请求、安全设置等信息。request结构如下所示

//makeRequest用来构造request对象
function makeRequest(request_url) {
    let request = {
        method: 'Get',
        url: request_url,
        headers: '',
        body: '',
        credentials: false,
        sync: true,
        responseType: 'text',
        referrer: ''
    }
    return request
}

然后就可以封装请求过程了这里我们将所有的请求细节封装进XFetch函数XFetch代码如下所示

//[in] request请求信息请求头延时值返回类型等
//[out] resolve, 执行成功,回调该函数
//[out] reject  执行失败,回调该函数
function XFetch(request, resolve, reject) {
    let xhr = new XMLHttpRequest()
    xhr.ontimeout = function (e) { reject(e) }
    xhr.onerror = function (e) { reject(e) }
    xhr.onreadystatechange = function () {
        if (xhr.status = 200)
            resolve(xhr.response)
    }
    xhr.open(request.method, URL, request.sync);
    xhr.timeout = request.timeout;
    xhr.responseType = request.responseType;
    //补充其他请求信息
    //...
    xhr.send();
}

这个XFetch函数需要一个request作为输入然后还需要两个回调函数resolve和reject当请求成功时回调resolve函数当请求出现问题时回调reject函数。

有了这些后,我们就可以来实现业务代码了,具体的实现方式如下所示:

XFetch(makeRequest('https://time.geekbang.org'),
    function resolve(data) {
        console.log(data)
    }, function reject(e) {
        console.log(e)
    })

新的问题:回调地狱

上面的示例代码已经比较符合人的线性思维了,在一些简单的场景下运行效果也是非常好的,不过一旦接触到稍微复杂点的项目时,你就会发现,如果嵌套了太多的回调函数就很容易使得自己陷入了回调地狱,不能自拔。你可以参考下面这段让人凌乱的代码:

XFetch(makeRequest('https://time.geekbang.org/?category'),
      function resolve(response) {
          console.log(response)
          XFetch(makeRequest('https://time.geekbang.org/column'),
              function resolve(response) {
                  console.log(response)
                  XFetch(makeRequest('https://time.geekbang.org')
                      function resolve(response) {
                          console.log(response)
                      }, function reject(e) {
                          console.log(e)
                      })
              }, function reject(e) {
                  console.log(e)
              })
      }, function reject(e) {
          console.log(e)
      })

这段代码是先请求time.geekbang.org/?category,如果请求成功的话,那么再请求time.geekbang.org/column,如果再次请求成功的话,就继续请求time.geekbang.org。也就是说这段代码用了三层嵌套请求,就已经让代码变得混乱不堪,所以,我们还需要解决这种嵌套调用后混乱的代码结构。

这段代码之所以看上去很乱,归结其原因有两点:

  • 第一是嵌套调用,下面的任务依赖上个任务的请求结果,并在上个任务的回调函数内部执行新的业务逻辑,这样当嵌套层次多了之后,代码的可读性就变得非常差了。
  • 第二是任务的不确定性,执行每个任务都有两种可能的结果(成功或者失败),所以体现在代码中就需要对每个任务的执行结果做两次判断,这种对每个任务都要进行一次额外的错误处理的方式,明显增加了代码的混乱程度。

原因分析出来后,那么问题的解决思路就很清晰了:

  • 第一是消灭嵌套调用
  • 第二是合并多个任务的错误处理

这么讲可能有点抽象不过Promise已经帮助我们解决了这两个问题。那么接下来我们就来看看Promise是怎么消灭嵌套调用和合并多个任务的错误处理的。

Promise消灭嵌套调用和多次错误处理

首先我们使用Promise来重构XFetch的代码示例代码如下所示

function XFetch(request) {
  function executor(resolve, reject) {
      let xhr = new XMLHttpRequest()
      xhr.open('GET', request.url, true)
      xhr.ontimeout = function (e) { reject(e) }
      xhr.onerror = function (e) { reject(e) }
      xhr.onreadystatechange = function () {
          if (this.readyState === 4) {
              if (this.status === 200) {
                  resolve(this.responseText, this)
              } else {
                  let error = {
                      code: this.status,
                      response: this.response
                  }
                  reject(error, this)
              }
          }
      }
      xhr.send()
  }
  return new Promise(executor)
}

接下来我们再利用XFetch来构造请求流程代码如下

var x1 = XFetch(makeRequest('https://time.geekbang.org/?category'))
var x2 = x1.then(value => {
    console.log(value)
    return XFetch(makeRequest('https://www.geekbang.org/column'))
})
var x3 = x2.then(value => {
    console.log(value)
    return XFetch(makeRequest('https://time.geekbang.org'))
})
x3.catch(error => {
    console.log(error)
})

你可以观察上面这两段代码重点关注下Promise的使用方式。

  • 首先我们引入了Promise在调用XFetch时会返回一个Promise对象。
  • 构建Promise对象时需要传入一个executor函数XFetch的主要业务流程都在executor函数中执行。
  • 如果运行在excutor函数中的业务执行成功了会调用resolve函数如果执行失败了则调用reject函数。
  • 在excutor函数中调用resolve函数时会触发promise.then设置的回调函数而调用reject函数时会触发promise.catch设置的回调函数。

以上简单介绍了Promise一些主要的使用方法通过引入Promise上面这段代码看起来就非常线性了也非常符合人的直觉是不是很酷基于这段代码我们就可以来分析Promise是如何消灭嵌套回调和合并多个错误处理了。

我们先来看看Promise是怎么消灭嵌套回调的。产生嵌套函数的一个主要原因是在发起任务请求时会带上回调函数这样当任务处理结束之后下个任务就只能在回调函数中来处理了。

Promise主要通过下面两步解决嵌套回调问题的。

首先Promise实现了回调函数的延时绑定。回调函数的延时绑定在代码上体现就是先创建Promise对象x1通过Promise的构造函数executor来执行业务逻辑创建好Promise对象x1之后再使用x1.then来设置回调函数。示范代码如下

//创建Promise对象x1并在executor函数中执行业务逻辑
function executor(resolve, reject){
    resolve(100)
}
let x1 = new Promise(executor)


//x1延迟绑定回调函数onResolve
function onResolve(value){
    console.log(value)
}
x1.then(onResolve)

其次需要将回调函数onResolve的返回值穿透到最外层。因为我们会根据onResolve函数的传入值来决定创建什么类型的Promise任务创建好的Promise对象需要返回到最外层这样就可以摆脱嵌套循环了。你可以先看下面的代码

回调函数返回值穿透到最外层

现在我们知道了Promise通过回调函数延迟绑定和回调函数返回值穿透的技术解决了循环嵌套。

那接下来我们再来看看Promise是怎么处理异常的你可以回顾上篇文章思考题留的那段代码,我把这段代码也贴在文中了,如下所示:

function executor(resolve, reject) {
    let rand = Math.random();
    console.log(1)
    console.log(rand)
    if (rand > 0.5)
        resolve()
    else
        reject()
}
var p0 = new Promise(executor);

var p1 = p0.then((value) => {
    console.log("succeed-1")
    return new Promise(executor)
})

var p3 = p1.then((value) => {
    console.log("succeed-2")
    return new Promise(executor)
})

var p4 = p3.then((value) => {
    console.log("succeed-3")
    return new Promise(executor)
})

p4.catch((error) => {
    console.log("error")
})
console.log(2)

这段代码有四个Promise对象p0p4。无论哪个对象里面抛出异常都可以通过最后一个对象p4.catch来捕获异常通过这种方式可以将所有Promise对象的错误合并到一个函数来处理这样就解决了每个任务都需要单独处理异常的问题。

之所以可以使用最后一个对象来捕获所有异常是因为Promise对象的错误具有“冒泡”性质会一直向后传递直到被onReject函数处理或catch语句捕获为止。具备了这样“冒泡”的特性后就不需要在每个Promise对象中单独捕获异常了。至于Promise错误的“冒泡”性质是怎么实现的就留给你课后思考了。

通过这种方式,我们就消灭了嵌套调用和频繁的错误处理,这样使得我们写出来的代码更加优雅,更加符合人的线性思维。

Promise与微任务

讲了这么多我们似乎还没有将微任务和Promise关联起来那么Promise和微任务的关系到底体现哪里呢

我们可以结合下面这个简单的Promise代码来回答这个问题

function executor(resolve, reject) {
    resolve(100)
}
let demo = new Promise(executor)

function onResolve(value){
    console.log(value)
}
demo.then(onResolve)

对于上面这段代码,我们需要重点关注下它的执行顺序。

首先执行new Promise时Promise的构造函数会被执行不过由于Promise是V8引擎提供的所以暂时看不到Promise构造函数的细节。

接下来Promise的构造函数会调用Promise的参数executor函数。然后在executor中执行了resolveresolve函数也是在V8内部实现的那么resolve函数到底做了什么呢我们知道执行resolve函数会触发demo.then设置的回调函数onResolve所以可以推测resolve函数内部调用了通过demo.then设置的onResolve函数。

不过这里需要注意一下由于Promise采用了回调函数延迟绑定技术所以在执行resolve函数的时候回调函数还没有绑定那么只能推迟回调函数的执行。

这样按顺序陈述可能把你绕晕了下面来模拟实现一个Promise我们会实现它的构造函数、resolve方法以及then方法以方便你能看清楚Promise的背后都发生了什么。这里我们就把这个对象称为Bromise下面就是Bromise的实现代码

function Bromise(executor) {
    var onResolve_ = null
    var onReject_ = null
     //模拟实现resolve和then暂不支持rejcet
    this.then = function (onResolve, onReject) {
        onResolve_ = onResolve
    };
    function resolve(value) {
          //setTimeout(()=>{
            onResolve_(value)
           // },0)
    }
    executor(resolve, null);
}

观察上面这段代码我们实现了自己的构造函数、resolve、then方法。接下来我们使用Bromise来实现我们的业务代码实现后的代码如下所示

function executor(resolve, reject) {
    resolve(100)
}
//将Promise改成我们自己的Bromsie
let demo = new Bromise(executor)

function onResolve(value){
    console.log(value)
}
demo.then(onResolve)

执行这段代码,我们发现执行出错,输出的内容是:

Uncaught TypeError: onResolve_ is not a function
    at resolve (<anonymous>:10:13)
    at executor (<anonymous>:17:5)
    at new Bromise (<anonymous>:13:5)
    at <anonymous>:19:12

之所以出现这个错误是由于Bromise的延迟绑定导致的在调用到onResolve_函数的时候Bromise.then还没有执行所以执行上述代码的时候当然会报“onResolve_ is not a function“的错误了。

也正是因为此我们要改造Bromise中的resolve方法让resolve延迟调用onResolve_。

要让resolve中的onResolve_函数延后执行可以在resolve函数里面加上一个定时器让其延时执行onResolve_函数你可以参考下面改造后的代码

function resolve(value) {
          setTimeout(()=>{
              onResolve_(value)
            },0)
    }

上面采用了定时器来推迟onResolve的执行不过使用定时器的效率并不是太高好在我们有微任务所以Promise又把这个定时器改造成了微任务了这样既可以让onResolve_延时被调用又提升了代码的执行效率。这就是Promise中使用微任务的原由了。

总结

好了,今天我们就聊到这里,下面我来总结下今天所讲的内容。

首先我们回顾了Web页面是单线程架构模型这种模型决定了我们编写代码的形式——异步编程。基于异步编程模型写出来的代码会把一些关键的逻辑点打乱所以这种风格的代码不符合人的线性思维方式。接下来我们试着把一些不必要的回调接口封装起来简单封装取得了一定的效果不过在稍微复制点的场景下依然存在着回调地狱的问题。然后我们分析了产生回调地狱的原因

  1. 多层嵌套的问题;
  2. 每种任务的处理结果存在两种可能性(成功或失败),那么需要在每种任务执行结束后分别处理这两种可能性。

Promise通过回调函数延迟绑定、回调函数返回值穿透和错误“冒泡”技术解决了上面的两个问题。

最后我们还分析了Promise之所以要使用微任务是由Promise回调函数延迟绑定技术导致的。

思考时间

终于把Promise讲完了这一篇文章非常有难度所以需要你课后慢慢消消化再次提醒Promise非常重要。那么今天我给你留三个思考题

  1. Promise中为什么要引入微任务
  2. Promise中是如何实现回调函数返回值穿透的
  3. Promise出错后是怎么通过“冒泡”传递给最后那个捕获异常的函数

这三个问题你不用急着完成可以先花一段时间查阅材料然后再来一道一道解释。搞清楚了这三道题目你也就搞清楚了Promise。

欢迎在留言区与我分享你的想法,也欢迎你在留言区记录你的思考过程。感谢阅读,如果你觉得这篇文章对你有帮助的话,也欢迎把它分享给更多的朋友。