/ ↲
    Расширенный поиск
    Две руки держатся за мизинчики, давая обещание
    Иллюстрация: kirakusto

    JavaScript

    Promise

    Время чтения: 10 мин

    1. Кратко
    2. Как пишется
      1. Создание
      2. Использование
    3. Как понять
    4. На практике
      1. nlopin

    Кратко

    Промис (Promise) — специальный объект JavaScript, который используется для написания и обработки асинхронного кода.

    Асинхронные функции возвращают объект Promise в качестве значения. Внутри промиса работает асинхронная операция, которая управляет его состоянием.

    Промис может находиться в одном из трёх состояний:

    • pending — стартовое состояние, операция стартовала
    • fulfilled — получен результат
    • rejected — ошибка

    Поменять можно состояние только один раз: перейти из pending либо в fulfilled, либо в rejected:

    Схема трёх состояний промиса и переход между ними

    У промиса есть методы then и catch, которые позволяют выполнять код при изменении его состояния.

    Как пишется

    Создание

    Промис создаётся с помощью конструктора.

    В конструктор передаётся функция-исполнитель асинхронной операции (англ. executor). Она вызывается сразу после создания промиса. Задача этой функции — выполнить асинхронную операцию и перевести состояние промиса в fulfilled (успех) или rejected (ошибка).

    Изменить состояние промиса можно, вызвав колбэки, переданные аргументами в функцию:

    2 колбэка Promise функции 
            
          
          const promise = new Promise(function (resolve, reject) {  // делаем асинхронную операцию  const data = resolve(data) // запрос в БД, API, etc. // переводим промис в состояние fulfilled и отдаём наружу результат операции})const errorPromise = new Promise(function (resolve, reject) {  reject(new Error("ошибка")) // переводим промис в состояние rejected и отдаём наружу ошибку})
          const promise = new Promise(function (resolve, reject) {
  // делаем асинхронную операцию
  const data = resolve(data) // запрос в БД, API, etc. // переводим промис в состояние fulfilled и отдаём наружу результат операции
})

const errorPromise = new Promise(function (resolve, reject) {
  reject(new Error("ошибка")) // переводим промис в состояние rejected и отдаём наружу ошибку
})
    • первый параметр (в примере кода назван resolve) — колбэк для перевода промиса в состояние fulfilled, при его вызове аргументом передаётся результат операции.
    • второй параметр (в примере кода назван reject) — колбэк для перевода промиса в состояние rejected, при его вызове аргументом передаётся информация об ошибке

    Схема создания асинхронной функции с промисом

    1. Создать функцию, которая будет выполнять асинхронную операцию
            
          
          function earnAllMoney() {}
          function earnAllMoney() {}
    1. Вернуть из функции созданный промис
            
          
          function earnAllMoney() {  return new Promise()}
          function earnAllMoney() {
  return new Promise()
}
    1. Аргументом в конструктор передать анонимную функцию, которая выполняет асинхронную операцию и переводит промис в состояние успех/ошибка в зависимости от результата.
            
          
          function earnAllMoney() {  return new Promise(function (resolve, reject) {    const result = tryEarnAllMoney() // асинхронная операция    if (result.ok) {      resolve(result) // успех → переводим промис в fulfilled и передаём результат    } else {      reject(new Error(result)) // ошибка → переводим промис в rejected    }  })}
          function earnAllMoney() {
  return new Promise(function (resolve, reject) {
    const result = tryEarnAllMoney() // асинхронная операция
    if (result.ok) {
      resolve(result) // успех → переводим промис в fulfilled и передаём результат
    } else {
      reject(new Error(result)) // ошибка → переводим промис в rejected
    }
  })
}

    💡 Если асинхронная операция работает через колбэки, то её стоит обернуть в промис, чтобы писать более читаемый код.

    Функция getData принимает два аргумента — колбэк при успехе и колбэк при ошибке. Завернём эту функцию в промис:

            
          
          function promisifiedGetData() {  return new Promise(function (resolve, reject) {    const result = getData(      function (result) {        resolve(result)      },      function (error) {        reject(error)      }    )  })}
          function promisifiedGetData() {
  return new Promise(function (resolve, reject) {
    const result = getData(
      function (result) {
        resolve(result)
      },
      function (error) {
        reject(error)
      }
    )
  })
}

    Теперь можно писать:

            
          
          promisifiedGetData()  .then(function () {    console.log("success")  })  .catch(function (err) {    console.error(err.message)  })
          promisifiedGetData()
  .then(function () {
    console.log("success")
  })
  .catch(function (err) {
    console.error(err.message)
  })

    Использование

    В работе мы чаще используем промисы, чем создаём. Использовать промис — значит выполнять код при изменении состояния промиса.

    Существует три метода, которые позволяют реагировать на изменение промиса: then, catch и finally.

    then

    Детальное описание работы then описано в статье Promise. Метод then

    Метод then используют, чтобы выполнить код после успешного выполнения асинхронной операции.

    Например, мы запросили у сервера список фильмов и хотим отобразить их на экране, когда сервер получит результат. В этом случае:

    • асинхронная операция — запрос данных у сервера
    • код, который мы хотим выполнить после её завершения — отрисовка списка

    Метод then принимает в качестве аргумента функцию-колбэк, которая выполняется сразу после того, как промис поменял состояние на fulfilled. Параметр колбэка содержит результат выполнения операции:

            
          
          fetch(`https://swapi.dev/api/films/${id}/`).then(function (movies) {  renderList(movies)})
          fetch(`https://swapi.dev/api/films/${id}/`).then(function (movies) {
  renderList(movies)
})

    В коде выше, асинхронная функция fetch возвращает промис, к которому применяется метод then. При его выполнении в переменной movies будет ответ сервера.

    catch

    Детальное описание работы catch описано в статье Promise. Метод catch

    Метод catch используют, чтобы выполнить код в случае ошибки при выполнении асинхронной операции.

    Например, мы запросили у сервера список фильмов и хотим показать экран обрыва соединения, если произошла ошибка. В этом случае:

    • асинхронная операция — запрос данных у сервера
    • код, который мы хотим выполнить при ошибке — экран обрыва соединения

    Метод catch принимает в качестве аргумента функцию-колбэк, которая выполняется сразу после того, как промис поменял состояние на rejected. Параметр колбэка содержит экземпляр ошибки:

            
          
          fetch(`https://swapi.dev/api/films/${id}/`).catch(function (error) {  renderErrorMessage(error)})
          fetch(`https://swapi.dev/api/films/${id}/`).catch(function (error) {
  renderErrorMessage(error)
})

    В коде выше, асинхронная функция fetch возвращает промис, к которому применяется метод catch. При его выполнении в переменной error будет экземпляр ошибки.

    finally

    Детальное описание работы finally описано в Promise. Метод finally

    Метод finally используют, чтобы выполнить код при завершении асинхронной операции. Он будет выполнен вне зависимости от того, была ли операция успешной или завершилась ошибкой.

    Самый частый сценарий использования finally — работа с индикаторами загрузки. Перед началом асинхронной операции разработчик включает индикатор загрузки. Индикатор нужно убрать вне зависимости от того, как завершилась операция. Если этого не сделать, то пользователь не сможет взаимодействовать с интерфейсом.

    Метод finally принимает в качестве аргумента функцию-колбэк, которая выполняется сразу после того, как промис поменял состояние на rejected, или fulfilled:

            
          
          let isLoading = truefetch(`https://swapi.dev/api/films/${id}/`).finally(function () {  isLoading = false})
          let isLoading = true
fetch(`https://swapi.dev/api/films/${id}/`).finally(function () {
  isLoading = false
})

    Цепочки методов

    Методы then, catch и finally часто объединяют в цепочки вызовов для того, чтобы обработать и успешный, и ошибочный сценарий:

            
          
          let isLoading = truefetch(`https://swapi.dev/api/films/${id}/`)  .then(function (movies) {    renderList(movies)  })  .catch(function (err) {    renderErrorMessage(err)  })  .finally(function () {    isLoading = false  })
          let isLoading = true

fetch(`https://swapi.dev/api/films/${id}/`)
  .then(function (movies) {
    renderList(movies)
  })
  .catch(function (err) {
    renderErrorMessage(err)
  })
  .finally(function () {
    isLoading = false
  })

    В этом случае при успешном завершении операции мы выполним код из then, при ошибке — код из catch. Затем выполнится код из finally.

    Цепочки методов — очень гибкий подход. Он позволяет создавать зависимые асинхронные операции.

    Например, нужно отобразить информацию о фильме и главном герое. Мы не знаем, кто главный герой, не получив эту информацию из данных о фильме. Запрос данных о герое зависит от результата запроса данных о фильме.

    Промисы делают решение такой задачи простым и читаемым. Мы можем начинать следующее асинхронное действие внутри колбэка метода then. Все, что возвращается из колбэка, оборачивается в промис, поэтому в цепочку можно добавить новый then:

            
          
          fetch(`https://swapi.dev/api/films/${id}/`)  .then(function (response) {    // этот then сработает, когда разрешится промис с запросом данных о фильме    return response.json() // нужно распарсить ответ сервера, это асинхронная операция  })  .then(function (movie) {    // этот then сработает, когда данные о фильме распарсятся    const characterUrl = movie.characters[0]    return fetch(characterUrl) // вызов fetch вернет промис, возвращаем его из колбэка, чтобы продолжить цепочку  })  .then(function (response) {    // этот then сработает, когда разрешится промис с результатами запроса персонажа    return response.json()  })  .then(function (character) {    renderCharacterProfile(character)  })  .catch(function (err) {    // catch сработает, когда любая из операций выше завершится ошибкой    renderErrorMessage(err)  })
          fetch(`https://swapi.dev/api/films/${id}/`)
  .then(function (response) {
    // этот then сработает, когда разрешится промис с запросом данных о фильме
    return response.json() // нужно распарсить ответ сервера, это асинхронная операция
  })
  .then(function (movie) {
    // этот then сработает, когда данные о фильме распарсятся
    const characterUrl = movie.characters[0]
    return fetch(characterUrl) // вызов fetch вернет промис, возвращаем его из колбэка, чтобы продолжить цепочку
  })
  .then(function (response) {
    // этот then сработает, когда разрешится промис с результатами запроса персонажа
    return response.json()
  })
  .then(function (character) {
    renderCharacterProfile(character)
  })
  .catch(function (err) {
    // catch сработает, когда любая из операций выше завершится ошибкой
    renderErrorMessage(err)
  })

    Обработка ошибок в цепочках методов

    Открыть демо в новой вкладке

    Цепочки then при обработке промисов могут быть очень большими. В примере выше цепочка состоит из 4 then и одного catch. Как в этом случае отработает catch?

    ☝️ catch обрабатывает ошибки от всех then между ним и предыдущим catch.

    Один метод catch, поставленный в конце цепочки

    В примере выше наш catch — последний, а предыдущего нет, поэтому он будет обрабатывать все ошибки

    Несколько методов catch, поставленных в середине и конце цепочки

    Если в цепочке несколько catch, то каждый ловит ошибки от then, находящихся выше.

    Один метод catch, поставленный в середине цепочки

    Возможен вариант, когда финального catch нет. Тогда ошибки от последних then не будут обрабатываться.

    💔 Такой код — плохой. Если в одном из последних then произойдёт ошибка, то вся дальнейшая цепочка не отработает, при этом, из-за асинхронной природы промиса, прочий код вне промиса продолжит работать и приложение не упадёт.

    Как понять

    Промис решает задачу выполнения кода, который зависит от результата асинхронной операции.

    Промис устроен таким образом, что рычаги управления его состоянием остаются у асинхронной функции. После создания, промис находится в состоянии ожидания pending. Когда асинхронная операция завершается, функция переводит промис в состояние успеха fulfilled или ошибки rejected.

    С помощью методов then, catch и finally мы можем реагировать на изменение состояния промиса и выполнять код.

    Пример ниже показывает состояние промиса, который создаётся при нажатии на кнопку купить. Промис случайным образом завершается успехом или ошибкой:

    Открыть демо в новой вкладке

    На практике

    nlopin

    🛠 Промис становится «разрешённым» или «завершённым», когда он переходит из состояние pending в fulfilled или rejected. Состояние завершённого промиса нельзя поменять.

            
          
          const promise = new Promise(function (resolve, reject) {  resolve() // в этот момент промис переходит в состояние fulfilled  reject() // этот вызов игнорируется, потому что промис разрешился})
          const promise = new Promise(function (resolve, reject) {
  resolve() // в этот момент промис переходит в состояние fulfilled
  reject() // этот вызов игнорируется, потому что промис разрешился
})

    🛠 Всегда завершай использование промиса методом catch. Если этого не сделать, то следующие промисы в цепочке перестанут работать, и такую ошибку получится поймать только через специальный обработчик – unhandledrejection.

    🛠 Время от времени нужно выполнить несколько асинхронных функций и дождаться, пока все выполнятся или одна из них завершится ошибкой. Для этого существует метод Promise.all (она возвращает промис).

    🛠 Если нужно дождаться пока несколько асинхронных функций завершатся (без разницы, успешно или ошибкой), используй метод Promise.allSettled (вернёт промис).