Promise 对象

作者: 了凡和纤风 | 来源:发表于2019-10-12 19:25 被阅读0次

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

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

Promise 对象有以下两个特点：

对象的状态不受外界影响。Promise对象代表一个异步操作，有 3 中状态
- Pending(进行中)
- Fulfilled(已成功)
- Rejected(已失败)
  只有异步操作的结果可以决定当前是哪一种状态，任何其他操作都无法改变这个状态。(这也是 "promise" 这个名字的由来，它在英语中意思是“承诺”，表示其它手段无法改变)
一旦状态改变就不会再变，任何时候都可以得到这个结果。Promise 对象的状态改变只有两种可能：
- 从 Pending 变为 Fulfilled
- 从 Pending 变为 Rejected
  只要这两种情况发生，状态就凝固了，不会再变，而是一直保持这个结果，这时就称为 Resolved(已定性)

Promise 也有一些缺点：

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

如果某些事件不断地反复发生，一般来说，使用 Stream 模式(nodejs.org/api/stream.html)

二、基本用法

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

创建一个Promise 实例

var promise = new Promise(function(resolve, reject) {
  // ... some code

  if (/* 异步操作成功 */) {
    resolve()
  } else {
    // 操作失败
    reject()
  }
})

Promise 构造函数接受一个函数作为参数，该函数的两个参数分别是：

resolve：将 Promise 对象的状态从 “未完成” 变成 “成功”(即从 Pending 变为 Resolved)，并将异步操作的结果作为参数传递出去
reject：将Promise 对象的状态从 “未完成” 变为 “失败” (即从 Pending 变为 Rejected)，并将异步操作报出的错误作为参数传递出去

Promise 实例生成以后，可以用 then 方法分别制定 Resolved 状态和 Rejected 状态的回调函数。

promise.then(function(value) {
  // resolve
}, function(error) {
  // reject
})

第一个回调函数是 Promise 对象的状态变为 Resolved 时调用，第二个回调函数是 Promise 对象的状态变为 Rejected 调用。

下面是一个 Promise 对象的简单例子。

function timeout(ms) {
  return new Promise((resolve, reject) => {
    setTimeout(resolve, ms, 'done')
  })
}

timeout(100).then((value) => {
  console.log(value)
})

Promise 新建后就会立即执行

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

promise.then(function() {
  console.log('Resolved.')
})

console.log('Hi!')

// Promise
// Hi
// Resolved

下面是异步加载图片的例子

function loadImageAsync(url) {
  return new Promise((resolve, reject) => {
    var image = new Image()

    image.onload = function() {
      resolve(image)
    }

    image.onerror = function() {
      reject(new Error('Could not load image at' + url))
    }

    image.src = url
  })
}

用 Promise 对象实现 AJAX 操作

var getJSON = function(url) {
  var promise = new Promise((resolve, reject) => {
    var client = new XMLHttpRequest()
    client.open('GET', url)
    client.onreadystatechange = handler
    client.responseType = 'json'
    client.setRequestHeader("Accept", "application/json")
    client.send()

    function handler() {
      if (this.readyState !== 4) {
        return
      }
      if (this.status === 200) {
        resolve(this.response)
      } else {
        reject(new Error(this.statusText))
      }
    }
  })
  return promise
}

getJSON("/posts.json").then(json => {
  console.log('Contents：' + json)
}, error => {
  console.error('出错了'，error)
})

如果调用 resolve 函数和 reject 函数时带有参数，那么这些参会会被传递给回调函数 reject 函数的参数通常是 Error 对象的实例，表示抛出的错误，resolve 函数的参数处理正常的值外，还可能是另外一个 Promise 实例。

var p1 = new Promise((resolve, reject) => {
  // ...
})

var p2 = new Promise((resolve, reject) => {
  // ...
  resolve(p1)
})

p2 的 resolve方法将 p1 作为参数，即一个异步操作的结果是返回另一个异步操作

此时 p1 的状态就会传递给p2。也就是说，p1的状态决定了 p2 的状态。如果 p1 的状态时 pending，那么 p2 的回调函数就会等待 p1 的状态改变；如果 p1 的状态已经是 Resolved 或 Rejected，那么 p2 的回调函数将会立即执行

var p1 = new Promise((resolve, reject) => {
  setTimeout(() => reject(new Error('fail')), 3000)
})

var p2 = new Promise((resolve, reject) => {
  setTimeout(() => resolve(p1), 1000)
})

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

上面的代码中，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 的 Promise 是在本轮事件循环的末尾执行，总是晚于本轮循环的同步任务

一般来说，调用 resolve 或 reject 之后，Promise 的使命就完成了。所以，最好在他们前面加上 return 语句，这样就不会产生意外了。

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

三、Promise.prototype.then()

Promise 实例具有 then 方法，即 then 方法是定义在原型对象 Promise.prototype 上的。它的作用是为 Promise 实例添加状态改变时的回调函数。
第一个参数是 Resolved 状态的回调函数
第二个参数(可选) 是 Rejected 状态的回调函数

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

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

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

getJSON('/post/1.json').then(
  post => getJSON(post.commentURL)
).then(
  comments => console.log('Resolved：', comments),
  err => console.log('Rejected：', err)
)

四、Promise.prototype.catch()

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

getJSON('/posts.json').then(posts => {
  // ...
}).catch(error => {
  // 处理 getJSON 和前一个回调函数运行时发生的错误
  console.log('err', error)
})

此外，then 方法指定的回调函数如果在运行中抛出错误，也会被 catch 方法捕获

Promise 爬出一个错误也会被 catch 方法指定的回调函数所捕获

var promise = new Promise((resolve, reject) => {
  throw new Error('test')
})

promise.catch(error => {
  console.log(error)
})
// Error: test

/* 上面的写法等同于下面的两种写法 */
// 写法一
var promise = new Promise((resolve, reject) => {
  try {
    throw new Error('test')
  } catch(e) {
    reject(e)
  }
})

promise.catch(error => {
  console.log(error)
})


// 写法二
var promise = new Promise((resolve, reject) => {
  reject(new Error('test'))
})

promise.catch(error => {
  console.log(error)
})

如果 Promise 状态已经变成 Resolved，再抛出错误是无效的

var promise = new Promise((resolve, reject) => {
  resolve('ok')
  throw new Error('test')
})
promise
  .then(value => { console.log(value) })
  .catch(error => { console.log(error) })

// ok

因为 Promise 的状态一旦改变，就会永久保存该状态，不会再改变

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

getJSON('/post/1.json')
  .then(post => getJSON(post.commentURL))
  .then(comments => {  /*some code */  })
  .catch(error => {
    // 处理前面 3 个Promise 产生的错误
   })

上面的代码中，一共3个 Promise 对象：一个由 getJSON 产生，两个由 then 产生。其中任何一个抛出的错误都会被最后一个 catch 捕获。

一般来说，不要再 then 方法中定义 Rejected 状态的回调函数 (即 then 的第二个参数)，而应总是使用 catch 方法

如果没有使用 catch 方法指定错误处理的回调函数，Promise 对象抛出的错误不会传递到外层代码，即不会有任何反应

var someAsyncThing = function() {
  return new Promise((resolve, reject) => {
    // 下面一行会报错，因为 x 没有声明
    resolve(x + 2)
  })
}

someAsyncThing()
  .then(() => {
    console.log('everything is great')
  })

浏览器此时会打印出错误 “ReferenceError：x is not defined”，不过不会总之脚本执行

需要注意的是，catch 方法返回的还是一个 Promise 对象，因此后面还可以调用 then 方法。

var someAsyncThing = function() {
  return new Promise((resolbe, reject) => {
    // 下面一行会报错，因为 x 没有声明
    resolve(x + 2)
  })
}

someAsyncThing()
  .catch(error => {
    console.log('oh on', error)
  })
  .then(() => {
    console.log('carry on')
  })
// oh on ReferenceError: resolve is not defined
// carry on

如果没有报错，则会跳过 catch 方法

Promise.resolve()
  .catch(error => {
    console.log('oh on', error)
  })
  .then(() => {
    console.log('carry on')
  })
// carry on

如果上面代码中，then 方法里面报错，就与前面的 catch 无关了

catch 中还能再抛出错误，如果后面没有别的 catch 方法，导致这个错误不会被捕获，也不会传递到外层。

someAsyncThing()
  .then(() => someOtherAsyncThing())
  .catch(error => {
    console.log('oh on', error)
    // 下面操作会报错，因为 y 没有声明
    y + 2
  })
  .catch(error => {
    console.log('carry on', error)
  })

// oh no [ReferenceError: x is not defined]
// carry on [ReferenceError：y is not defined]

五、Promise.all()

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

var p = Promise.all([p1, p2, p3])

Promise.all 方法接受一个数组作为参数，p1、p2、p3 都是 Promise 对象的实例(Promise.all 方法的参数不一定是数组，但是必须具有 Iterator 接口，且返回的每个成员都是 Promise 实例)

p 的状态由 p1、p2、p3决定，分成两种情况：

只有 p1、p2、p3 的状态都变成 Fulfilled，p 的状态才会变成 Fulfilled，此时 p1、p2、p3的返回值组成一个数组，传递给 P 的回调函数。
只要 p1、p2、p3 中有一个被 Rejected，p 的状态就变成Rejected，此时第一个被 Rejected 的实例的返回值会传递给 p 的回调函数

// 生成一个 Promise 对象的数组
var promise = [2, 3,  5, 7, 1,, 13].map(id => {
  return getJSON('/post/' + id + '.json')
})

Promise.all(promise).then(posts => {
  // ...
}).catch(reason => {
  // ...
})

如上，即是包含6个 Promise 实例的数组

下面是另一个例子

const databasePromise = connectDatabase()

const booksPromise = databasePromise
  .then(findAllBooks)

const userPromise = databasePromise
  .then(getCurrentUser)

Promise.all([
  booksPromise,
  userPromise
])
  .then(([books, user]) => pickTopRecommentations(books, user))

booksPromise 和 userPromise 是两个异步操作，只有他们的结果都返回，才会触发 PickTopRecmmentations 回调函数

如果作为参数的 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: 报错了]

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

如果 p2 没有自己的 catch 方法，就会调用 Promise.all() 的 catch 方法

六、Promise.race()

Promise.race 方法同样是将多个 Promise 实例包装成一个新的 Promise 实例。Promise.race 方法的参数与 Promise.all 方法一样

var p = Promise.race([p1, p2, p3)

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

const p = Promise.race([
  fetch('/resource-that-may-take-a-while'),
  new Promise(function (resolve, reject) {
    setTimeout(() => reject(new Error('request timeout')), 5000)
  })
])

p.then(response => console.log(response))
p.catch(error => console.log(error))

上面的代码中，如果 5秒之内 fetch 方法无法返回结果，变量 p 的状态就会变为 Rejected，从而触发 catch 方法指定的回调函数

七、Promise.resolve()

有时候需要将现有对象转为 Promise 对象，Promise.resolve 方法就起到这个作用

var jsPromise = Promise.resolve($.ajax('/whatever.json'))

Promise.resolve 等价于下面的写法

Promise.resolve('foo')
// 等价于
new Promise( resolve => resolve('foo'))

Promise.resolve 方法的参数分成以下4种情况：

1. 参数是一个 Promise 实例
如果参数是 Promise 实例，那么 Promise.resolve 将不做任何修改，原封不动地返回这个实例

2. 参数是一个 thenable 对象
thenable 对象值的是具体 then 方法的对象，比如下面这个对象

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

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

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

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

thenable 对象 then 方法执行后，对象 p1 的状态就变为 resolved 从而立即执行最后的 then 方法指定的回调函数，输出 42。

3. 参数不是具有 then 方法的对象或根本不是对象
如果参数是一个原始值，或者是一个不具有 then 方法的对象，那么 Promise.resolve 方法返回一个新的 Promise 对象，状态为 Resolved

var p = Promise.resolve('Hello')

p.then(s => {
  console.log(s)
})
// Hello

上面生成了一个新的 Promise 对象的实例p。由于字符串 Hello 不属于异步操作(判断方法是字符串对象不具有 then 方法)，返回 Promise 实例的状态从生成起就是 Resolved，所以回调函数会立即执行。Promise.resolve 方法的参数会同时传给回调函数。
4. 不带有任何参数
Promise.resolve 方法允许在调用时不带有参数，而直接返回一个 Resolved 状态的 Promise 对象。

var p = Promise.resolve()

p.then(() => {
  // ....
})

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

setTimeout(() => {
  console.log('three')
}, 0)

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

console.log('one')

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

八、Promise.reject()

Promise.reject(reason) 方法也会返回一个新的 Promise 实例，状态为 Rejected

var p = Promise.reject('出错了')
// 等同于
var p = new Promise((resolve, reject) => reject('出错了'))

p.then(null, s => {
  console.log(s)
})
// 出错了

Promise.reject() 方法的参数会原封不动地作为 reject 的理由变成后续方法的参数。这一点与 Promise.resolve() 方法不一致。

const thenable = {
  then(resolve, reject) {
    reject('出错了')
  }
}

Promise.reject(thenable)
.catch(e => {
  console.log(e === thenable)
})
// true

上面的代码中，Promise.reject 方法的参数是一个 thenable 对象，执行以后，后面 catch 方法的参数不是 reject 抛出的 “出错了” 这个字符串，而是 thenable 对象

九、两个有用的附加方法

ES6 的 Promise API 提供的方法不是很多，可以自己部署一些有用的方法。下面部署两个不在 ES6 中但很有用的方法。

9.1、done()

无论 Promise 对象的回调链以 then 方法还是 catch 方法结尾，只要最后一个方法抛出错误，都有可能无法捕捉到(因为 Promise 内部的错误不会冒泡到全局)。为此，我们可以提供一个 done 方法，它总是处于回调链的尾端，保证抛出任何可能出现的错误。

asyncFunc()
  .then(f1)
  .catch(r1)
  .then(f2)
  .done()

它的实现代码相当简单

Promise.prototype.done = function(onFulfilled, onRejected) {
  this.then(onFulfilled, onRejected)
    .catch(reason => {
      // 抛出一个全局错误
      setTimeout(() => { throw reason }, 0)
    })
}

done 方法可以像 then 方法那样使用，提供 Fulfilled 和 Rejected 状态的回调函数，也可以不停任何参数。但不管怎么样，done 方法都会捕捉到任何可能出现的错误，并向全局抛出

9.2、finally()

finally 方法用于指定不管 Promise 对象最后状态如何都会执行的操作。它与 done 方法的最大区别在于，他接受一个普通的回调函数作为参数，该函数不管怎样都必须执行。

server.listen(0)
  .then(() => {
    // run test
  })
  .finally(server.stop)

上面的例子，服务器使用 Promise 处理请求，然后使用 finally 方法关掉服务器

它的实现也很简单

Promise.prototype.finally = function(callback) {
  let p = this.constructor
  return this.then(
    value => p.resolve(callback()).then(() => value),
    reason => p.resolve(callback()).then(() => { throw reason })
  )
}

不管前面的 Promise 是 fulfilled 还是 rejected，都会执行回调函数 callback

十、应用

10.1、加载图片

const prelpadImage = function(path) {
  return new Promise(function (resolve, reject) {
    var image = new Image()
    image.onload = resolve
    image.onerror = reject
    image.src = path
  })
}

10.2 Generator 函数与 Promise 的结合

使用 Generator 函数管理流程，遇到异步操作时通常返回一个 Promise 对象

function getFoo() {
  return new Promise(function (resolve, reject) {
    resolve('foo')
  })
}

var g = function* () {
  try {
    var foo = yield getFoo()
    console.log(foo)
  } catch(e) {
    console.log(e)
  }
}

function run(generator) {
  var it = generator()
  
  function go(result) {
    if (result.done) return result.value

    return result.value.then( function(value) {
      return go(it.next(value))
    }, function (error) {
      return go(it.throw(error))
    })
  }
  go(it.next())
}

run(g)

Generator 函数g 中有一个异步操作getFoo，它返回的就是一个 Promise 对象。函数 run 用来处理这个 Promise 对象，并调用下一个 next 方法。