[JS] DeepDive (45) 프로미스

728x90

자바스크립트는 비동기 처리를 위한 하나의 패턴으로 콜백함수를 사용한다. 이러한 콜백 패턴은 가동성이 나쁘고 에러처리가 곤란하다는 문제가 있다.

콜백 헬

GET요청에 의한 함수의 예시를 하나 보자

// GET 요청을 위한 비동기 함수
const get = url => {
  const xhr = new XMLHttpRequest();
  xhr.open('GET', url);
  xhr.send();

  xhr.onload = () => {
    if (xhr.status === 200) {
      // 서버의 응답을 콘솔에 출력한다.
      console.log(JSON.parse(xhr.response));
    } else {
      console.error(`${xhr.status} ${xhr.statusText}`);
    }
  };
};

// id가 1인 post를 취득
get('https://jsonplaceholder.typicode.com/posts/1');
/*
{
  "userId": 1,
  "id": 1,
  "title": "sunt aut facere ...",
  "body": "quia et suscipit ..."
}
*/

get 함수는 비동기 함수이기때문에 코드가 완료되지 않아도 즉시 종료된다. 즉 비동기로 동작하는 코드에서 처리결과를 외부로 반환하거나 상위 스코프의 변수에 할당하면 우리가 생각한대로 동작하지 않는다.

setTimeout 함수를 생각해보자. 해당함수도 비동기함수이므로 콜백함수에서 값을 반환하는것은 무의미하다.

let g = 0;

// 비동기 함수인 setTimeout 함수는 콜백 함수의 처리 결과를 외부로 반환하거나
// 상위 스코프의 변수에 할당하지 못한다.
setTimeout(() => { g = 100; }, 0);
console.log(g); // 0

GET 요청을 전송하고 서버의 응답을 받는 get 함수또한 비동기 함수이다. get함수가 비동기인 이유는 onload 이벤트 핸들러가 비동기이기 때문이다.

만약 get 함수가 응답결과를 반환하도록 해보자.

// GET 요청을 위한 비동기 함수
const get = url => {
  const xhr = new XMLHttpRequest();
  xhr.open('GET', url);
  xhr.send();

  xhr.onload = () => {
    if (xhr.status === 200) {
      // ① 서버의 응답을 반환한다.
      return JSON.parse(xhr.response);
    }
    console.error(`${xhr.status} ${xhr.statusText}`);
  };
};

// ② id가 1인 post를 취득
const response = get('https://jsonplaceholder.typicode.com/posts/1');
console.log(response); // undefined

놀랍게도 get함수에 명시적인 반환문이 없기 때문에 get함수는 undefined를 반환하게 된다.

즉 xhr.onload 이벤트 핸들러 프로퍼티에 바인딩한 이벤트 핸들러의 반환문은 get 함수의 반환문이 아니다. get 함수는 반환문이 생략되었다고 생각한다.

<!DOCTYPE html>
<html>
<body>
  <input type="text">
  <script>
    document.querySelector('input').oninput = function () {
      console.log(this.value);
      // 이벤트 핸들러에서의 반환은 의미가 없다.
      return this.value;
    };
  </script>
</body>
</html>

서버응답을 상위 스코프의 변수에 할당해도 마찬가지로 우리가 생각한대로 동작하지 않는다.

let todos;

// GET 요청을 위한 비동기 함수
const get = url => {
  const xhr = new XMLHttpRequest();
  xhr.open('GET', url);
  xhr.send();

  xhr.onload = () => {
    if (xhr.status === 200) {
      // ① 서버의 응답을 상위 스코프의 변수에 할당한다.
      todos = JSON.parse(xhr.response);
    } else {
      console.error(`${xhr.status} ${xhr.statusText}`);
    }
  };
};

// id가 1인 post를 취득
get('https://jsonplaceholder.typicode.com/posts/1');
console.log(todos); // ② undefined

xhr.onload핸들러는 서버로부터 응답이 도착하면 실행되지만 바로 실행되는 것은 아니다 .load이벤트가 발생하면 우선 태스크 큐에 저장되어 대기하다가 콜 스택이 비면 그제서야 콜 스택으로 푸쉬되어 실행된다.

따라서 비동기 처리에 대한 후속 결과를 처리하기 위해서는 콜백함수를 사용해야 한다.

// GET 요청을 위한 비동기 함수
const get = (url, successCallback, failureCallback) => {
  const xhr = new XMLHttpRequest();
  xhr.open('GET', url);
  xhr.send();

  xhr.onload = () => {
    if (xhr.status === 200) {
      // 서버의 응답을 콜백 함수에 인수로 전달하면서 호출하여 응답에 대한 후속 처리를 한다.
      successCallback(JSON.parse(xhr.response));
    } else {
      // 에러 정보를 콜백 함수에 인수로 전달하면서 호출하여 에러 처리를 한다.
      failureCallback(xhr.status);
    }
  };
};

// id가 1인 post를 취득
// 서버의 응답에 대한 후속 처리를 위한 콜백 함수를 비동기 함수인 get에 전달해야 한다.
get('https://jsonplaceholder.typicode.com/posts/1', console.log, console.error);
/*
{
  "userId": 1,
  "id": 1,
  "title": "sunt aut facere ...",
  "body": "quia et suscipit ..."
}
*/

이처럼 콜백함수를 통해서 비동기 처리 결과를 처리할 수 있는데 이러한 비동기함수들이 중첩된다면 함수 호출이 중첩되는 이른바 콜백헬 현상이 나타난다.

// GET 요청을 위한 비동기 함수
const get = (url, callback) => {
  const xhr = new XMLHttpRequest();
  xhr.open('GET', url);
  xhr.send();

  xhr.onload = () => {
    if (xhr.status === 200) {
      // 서버의 응답을 콜백 함수에 전달하면서 호출하여 응답에 대한 후속 처리를 한다.
      callback(JSON.parse(xhr.response));
    } else {
      console.error(`${xhr.status} ${xhr.statusText}`);
    }
  };
};

const url = 'https://jsonplaceholder.typicode.com';

// id가 1인 post의 userId를 취득
get(`${url}/posts/1`, ({ userId }) => {
  console.log(userId); // 1
  // post의 userId를 사용하여 user 정보를 취득
  get(`${url}/users/${userId}`, userInfo => {
    console.log(userInfo); // {id: 1, name: "Leanne Graham", username: "Bret",...}
  });
});

에러 처리의 한계

비동기 처리의 가장 큰 문제는 에러 처리가 곤란하다는 점이다.

try {
  setTimeout(() => { throw new Error('Error!'); }, 1000);
} catch (e) {
  // 에러를 캐치하지 못한다
  console.error('캐치한 에러', e);
}

setTimeout 안의 함수는 1초 후에 실행되기때문에 try catch 문법으로 잡을 수 없다.

이러한 문제를 극복하기 위해서 eS6에서는 프로미스가 도입되었다.

프로미스의 생성

Promise 생성자 함수를 new 연산자와 함께 호출하면 프로미스 객체를 생성한다. 이 객체는 ECMAScript 사양에 정의된 표준 빌트인 객체이다.

// 프로미스 생성
const promise = new Promise((resolve, reject) => {
  // Promise 함수의 콜백 함수 내부에서 비동기 처리를 수행한다.
  if (/* 비동기 처리 성공 */) {
    resolve('result');
  } else { /* 비동기 처리 실패 */
    reject('failure reason');
  }
});

Promise 생성자 함수가 인수로 전달받은 함수 내부에서 비동기 처리를 수행한다. 앞에서 살펴본 get 함수를 프로미스로 구현해보자.

// GET 요청을 위한 비동기 함수
const promiseGet = url => {
  return new Promise((resolve, reject) => {
    const xhr = new XMLHttpRequest();
    xhr.open('GET', url);
    xhr.send();

    xhr.onload = () => {
      if (xhr.status === 200) {
        // 성공적으로 응답을 전달받으면 resolve 함수를 호출한다.
        resolve(JSON.parse(xhr.response));
      } else {
        // 에러 처리를 위해 reject 함수를 호출한다.
        reject(new Error(xhr.status));
      }
    };
  });
};

// promiseGet 함수는 프로미스를 반환한다.
promiseGet('https://jsonplaceholder.typicode.com/posts/1');

비동기 처리가 성공하면 비동기 처리 결과를 resolve함수에 인자로 전달하며 호출하고 비동기 처리가 실패하면 에러를 reject 함수에 인자로 전달하며 호출한다.

비동기 처리가 성공한 상태를 fulfilled , 실패한 상태를 rejected 상태로 생각한다.

// fulfilled된 프로미스
const fulfilled = new Promise(resolve => resolve(1));

비동기 처리가 성공하면 프로미스는 fulfilled 상태로 변화하며 비동기 처리 결과인 1을 값으로 갖게 된다.

// rejected된 프로미스
const rejected = new Promise((_, reject) => reject(new Error('error occurred')));

비동기 처리가 실패하면 pending 상태에서 rejected 상태로 변화하며 Error 객체를 값으로 갖는다.

프로미스의 후속 처리 메서드

프로미스의 비동기 처리 상태가 변화하면 후속 처리 메서드에 인수로 전달한 콜백함수가 선택적으로 호출된다.

Promise.prototype.then

// fulfilled
new Promise(resolve => resolve('fulfilled'))
  .then(v => console.log(v), e => console.error(e)); // fulfilled

// rejected
new Promise((_, reject) => reject(new Error('rejected')))
  .then(v => console.log(v), e => console.error(e)); // Error: rejected

첫번재 콜백함수는 fulfilled 상태인 경우의 콜백함수를, 두번째 콜백함수는 rejected 상태의 콜백함수를 인자로 받는다.

Promise.prototype.catch

프로미스가 rejected상태인경우 호출된다.

// rejected
new Promise((_, reject) => reject(new Error('rejected')))
  .catch(e => console.log(e)); // Error: rejected

catch 메서드는 then과 동일하게 동작한다.

Promise.prototype.finally

프로미스의 성공 실패 여부와 상관없이 무조건 한 번 실행된다.

new Promise(() => {})
  .finally(() => console.log('finally')); // finally

만약 위 함수들을 사용해서 비동기 함수 get을 구현한다면 아래와 같이 될 것이다.

const promiseGet = url => {
  return new Promise((resolve, reject) => {
    const xhr = new XMLHttpRequest();
    xhr.open('GET', url);
    xhr.send();

    xhr.onload = () => {
      if (xhr.status === 200) {
        // 성공적으로 응답을 전달받으면 resolve 함수를 호출한다.
        resolve(JSON.parse(xhr.response));
      } else {
        // 에러 처리를 위해 reject 함수를 호출한다.
        reject(new Error(xhr.status));
      }
    };
  });
};

// promiseGet 함수는 프로미스를 반환한다.
promiseGet('https://jsonplaceholder.typicode.com/posts/1')
  .then(res => console.log(res))
  .catch(err => console.error(err))
  .finally(() => console.log('Bye!'));

프로미스의 에러 처리

프로미스를 활용하면 에러를 문제없이 해결할 수 있다.

비동기 처리의 에러를 then 메서드의 두번째 콜백함수나 catch를 활용하면 쉽게 해결할 수 있기 때문이다.

const wrongUrl = 'https://jsonplaceholder.typicode.com/XXX/1';

// 부적절한 URL이 지정되었기 때문에 에러가 발생한다.
promiseGet(wrongUrl).then(
  res => console.log(res),
  err => console.error(err)
); // Error: 404

const wrongUrl = 'https://jsonplaceholder.typicode.com/XXX/1';

// 부적절한 URL이 지정되었기 때문에 에러가 발생한다.
promiseGet(wrongUrl)
  .then(res => console.log(res))
  .catch(err => console.error(err)); // Error: 404

사실 catch 메서드를 호출하면 내부적으로 then(undefined, onRejected)를 호출하는 것이기 때문에 둘은 같다.

단 then 메서드의 두번째 콜백함수를 사용하는 것은 첫번째 콜백함수의 에러는 잡지 못하므로 catch를 사용하는 것이 좋다.

promiseGet('https://jsonplaceholder.typicode.com/todos/1').then(
  res => console.xxx(res),
  err => console.error(err)
); // 두 번째 콜백 함수는 첫 번째 콜백 함수에서 발생한 에러를 캐치하지 못한다.

promiseGet('https://jsonplaceholder.typicode.com/todos/1')
  .then(res => console.xxx(res))
  .catch(err => console.error(err)); // TypeError: console.xxx is not a function

프로미스 체이닝

앞에서 잠깐 봤던 콜백 헬을 프로미스를 사용해 구현해 보자.

const url = 'https://jsonplaceholder.typicode.com';

// id가 1인 post의 userId를 취득
promiseGet(`${url}/posts/1`)
  // 취득한 post의 userId로 user 정보를 취득
  .then(({ userId }) => promiseGet(`${url}/users/${userId}`))
  .then(userInfo => console.log(userInfo))
  .catch(err => console.error(err));

프로미스는 프로미스 체이닝을 통해 후속처리를 하므로 콜백 헬은 발생하지 않지만 콜백 패턴을 사용하기에 콜백함수를 사용하지 않는건 아니게 된다. 이를 해결하려면 ES8에서 도입된 async/await을 통해 해결할 수 있으며 비동기 처리를 동기 처리처럼 처리할 수 있다.

const url = 'https://jsonplaceholder.typicode.com';

(async () => {
  // id가 1인 post의 userId를 취득
  const { userId } = await promiseGet(`${url}/posts/1`);

  // 취득한 post의 userId로 user 정보를 취득
  const userInfo = await promiseGet(`${url}/users/${userId}`);

  console.log(userInfo);
})();

이에 대해선 다음 글에서 자세히 알아보자.

프로미스의 정적 메서드

Promise.resolve / Promise.reject

이미 존재하는 값을 래핑하여 프로미스를 생성하기 위해서 사용된다.

resolve 메서드는 전달받은 값을 resolve하는 프로미스를 생성한다.

// 배열을 resolve하는 프로미스를 생성
const resolvedPromise = Promise.resolve([1, 2, 3]);
resolvedPromise.then(console.log); // [1, 2, 3]

위 예제는 아래와 동일하다.

const resolvedPromise = new Promise(resolve => resolve([1, 2, 3]));
resolvedPromise.tconst resolvedPromise = new Promise(resolve => resolve([1, 2, 3]));
resolvedPromise.then(console.log); // [1, 2, 3]hen(console.log); // [1, 2, 3]

reject 메서드는 전달받은 값을 reject하는 프로미스를 생성한다.

// 에러 객체를 reject하는 프로미스를 생성
const rejectedPromise = Promise.reject(new Error('Error!'));
rejectedPromise.catch(console.log); // Error: Error!

Promise.all

여러개의 비동기 처리를 모두 병렬처리할 때 사용한다.

const requestData1 = () => new Promise(resolve => setTimeout(() => resolve(1), 3000));
const requestData2 = () => new Promise(resolve => setTimeout(() => resolve(2), 2000));
const requestData3 = () => new Promise(resolve => setTimeout(() => resolve(3), 1000));

// 세 개의 비동기 처리를 순차적으로 처리
const res = [];
requestData1()
  .then(data => {
    res.push(data);
    return requestData2();
  })
  .then(data => {
    res.push(data);
    return requestData3();
  })
  .then(data => {
    res.push(data);
    console.log(res); // [1, 2, 3] ⇒ 약 6초 소요
  })
  .catch(console.error);

위 예제는 비동기 처리들을 순차적으로 실행한다. 즉, 위 코드를 실행시키기 위해서는 총 6초 이상이 필요하다.

Promise.all 메서드를 활용하면 해당 메서드들을 병렬처리할 수 있다.

const requestData1 = () => new Promise(resolve => setTimeout(() => resolve(1), 3000));
const requestData2 = () => new Promise(resolve => setTimeout(() => resolve(2), 2000));
const requestData3 = () => new Promise(resolve => setTimeout(() => resolve(3), 1000));

Promise.all([requestData1(), requestData2(), requestData3()])
  .then(console.log) // [ 1, 2, 3 ] ⇒ 약 3초 소요
  .catch(console.error);

위 메서드를 활용하면 인수로 전달받은 배열의 모든 프로미스가 모두 fulfilled 상태가 되면 종료하며 Promise.all 메서드가 종료하는데 걸리는 시간은 가장 늦게 fulfilled 상태가 되는 프로미스의 처리 시간보다 조금 길게 된다. 즉 3초 조금 넘는 시간이 소요된다.

Promise.all 메서드는 인수로 전달받은 배열의 프로미스가 하나라도 reject상태가 되면 나머지 프로미스가 fulfilled 상태가 되는 것을 기다리지 않고 즉시 종료한다.

Promise.all([
  new Promise((_, reject) => setTimeout(() => reject(new Error('Error 1')), 3000)),
  new Promise((_, reject) => setTimeout(() => reject(new Error('Error 2')), 2000)),
  new Promise((_, reject) => setTimeout(() => reject(new Error('Error 3')), 1000))
])
  .then(console.log)
  .catch(console.log); // Error: Error 3

Promise.all 메서드는 인수로 전달받은 이터러블의 요소가 프로미스가 아닌 경우 Promise.resolve 메서드를 통해 프로미스로 래핑한다.

Promise.all([
  1, // => Promise.resolve(1)
  2, // => Promise.resolve(2)
  3  // => Promise.resolve(3)
])
  .then(console.log) // [1, 2, 3]
  .catch(console.log);

이를 활용해 깃허브 아이디로 깃허브 사용자 이름을 취득하는 3개의 비동기 처리를 모두 병렬로 처리할수 있는 예제를 보자.

// GET 요청을 위한 비동기 함수
const promiseGet = url => {
  return new Promise((resolve, reject) => {
    const xhr = new XMLHttpRequest();
    xhr.open('GET', url);
    xhr.send();

    xhr.onload = () => {
      if (xhr.status === 200) {
        // 성공적으로 응답을 전달받으면 resolve 함수를 호출한다.
        resolve(JSON.parse(xhr.response));
      } else {
        // 에러 처리를 위해 reject 함수를 호출한다.
        reject(new Error(xhr.status));
      }
    };
  });
};

const githubIds = ['jeresig', 'ahejlsberg', 'ungmo2'];

Promise.all(githubIds.map(id => promiseGet(`https://api.github.com/users/${id}`)))
  // [Promise, Promise, Promise] => Promise [userInfo, userInfo, userInfo]
  .then(users => users.map(user => user.name))
  // [userInfo, userInfo, userInfo] => Promise ['John Resig', 'Anders Hejlsberg', 'Ungmo Lee']
  .then(console.log)
  .catch(console.error);

Promise.race

Promise.race 메서드는 Promise.all 메서드와 동일하게 프로미스를 요소로 갖는 배열 등의 이터러블을 인수로 전달받는다. Promise.race 메서드는 Promise.all 메서드처럼 모든 프로미스가 fulfilled 상태가 되는 것을 기다리느 ㄴ것이 아니라 가장 먼저 fulfilled 상태가 된 프로미스의 처리 결과를 resolve하는 새로운 프로미스를 반환한다.

Promise.race([
  new Promise(resolve => setTimeout(() => resolve(1), 3000)), // 1
  new Promise(resolve => setTimeout(() => resolve(2), 2000)), // 2
  new Promise(resolve => setTimeout(() => resolve(3), 1000)) // 3
])
  .then(console.log) // 3
  .catch(console.log);

Promise.allSettled

프로미스 요소를 갖는 배열 등의 이터러블을 인수로 전달받아 프로미스가 모두 settled상태가 되면 처리결과를 배열을 반환한다.

Promise.allSettled([
  new Promise(resolve => setTimeout(() => resolve(1), 2000)),
  new Promise((_, reject) => setTimeout(() => reject(new Error('Error!')), 1000))
]).then(console.log);
/*
[
  {status: "fulfilled", value: 1},
  {status: "rejected", reason: Error: Error! at <anonymous>:3:54}
]
*/

마이크로태스크 큐

아래 예제의 결과를 생각해보자!

setTimeout(() => console.log(1), 0);

Promise.resolve()
  .then(() => console.log(2))
  .then(() => console.log(3));

위 예제는 2 -> 3 -> 1의 순으로 출력된다.

프로미스의 후속 처리 메서드의 콜백 함수는 태스크 큐가 아니라 마이크로태스크 큐에 저장된다. 마이크로 태스크 큐는 태스크큐와는 별도의 큐로 프로미스의 후속 처리 메서드의 콜백함수가 일시 저장된다.

마이크로태스크 큐는 태스크 큐보다 우선순위가 높기 때문에 위 예제의 결과는 2->3->1 로 실행되게 되는 것이다.