모던 자바스크립트 Deep Dive : 46장 제너레이터와 async/await

EdLee·2022년 12월 3일

javascript

목록 보기

36/37

46장 제너레이터와 async/await

1. 제너레이터란?

제너레이터

ES6에서 도입

코드 블록의 실행을 일시 중지했다가 필요한 시점에 재개할 수 있는 특수한 함수

제터레이터와 일반 함수의 차이
1. 제너레이터 함수는 함수 호출자에게 함수 실행의 제어권을 양도할 수 있다
  일반 함수 : 호출하면 제어권이 함수에게 넘어가고 함수 코드를 실행
  => 즉, 함수 호출자는 함수를 호출한 이후 함수 실행을 제어할 수 없다
  제너레이터 함수 : 함수 호출자가 함수 실행을 일시 중지시키거나 재개시킬 수 있도록 제어권을 가진다
2. 제너레이터 함수는 함수 호출자와 함수의 상태를 주고받을 수 있다
  일반 함수 : 호출하면 매개변수를 통해 값을 받고 함수 코드를 실행하여 결과값을 반환
  즉, 함수가 실행되고 있는 동안에는 함수 외부에서 함수 내부로 값을 전달하여 함수의 상태를 변경할 수 없다
  제너레이터 함수 : 함수 호출자와 양방향으로 상태를 서로 주고 받을 수 있다
3. 제너레이터 함수를 호출하면 제너레이터 객체를 반환한다
  일반 함수 : 호출하면 함수 코드를 실행하고 값을 반환
  제너레이터 함수 : 호출하면 함수 코드를 실행하는 것이 아니라 이터러블이면서 동시에 이터레이터인 제너레이터 객체를 반환

2. 제너레이터 함수의 정의

// 제너레이터 함수 선언문
function* genDecFunc() {
  yield 1;
}

// 제너레이터 함수 표현식
const genExpFunc = function* () {
  yield 1;
};

// 제너레이터 메서드
const obj = {
  * genObjMethod() {
    yield 1;
  }
};

// 제너레이터 클래스 메서드
class MyClass {
  * genClsMethod() {
    yield 1;
  }
}

제너레이터 함수는 function* 키워드로 선언
하나 이상의 yield 표현식을 포함한다

function* genFunc() { yield 1; } // 추천!
function * genFunc() { yield 1; }
function *genFunc() { yield 1; }
function*genFunc() { yield 1; }

아스타리스크(*) 위치는 위처럼 키워드와 함수 이름 사이라면 어디든 상관없지만, 되도록 function 바로 뒤에 붙이자

const genArrowFunc = * () => {
  yield 1;
}; // SyntaxError: Unexpected token '*'

화살표 함수로 정의할 수 없다😁

function* genFunc() {
  yield 1;
}

new genFunc(); // TypeError: genFunc is not a constructor

제너레이터 함수는 new 연산자와 함께 생성자 함수로 호출할 수 없다

3. 제너레이터 객체

제너레이터 함수를 호출하면 일반 함수처럼 함수 코드 블록을 실행하는 것이 아니라 제너레이터 객체를 생성해 반환한다
제너레이터 함수가 반환한 제너레이터 객체는 이터러블이면서 동시에 이터레이터
=> iterator 생성/호출 없이 next 쓸 수 있다

// 제너레이터 함수
function* genFunc() {
  yield 1;
  yield 2;
  yield 3;
}

// 제너레이터 함수를 호출하면 제너레이터 객체를 반환한다.
const generator = genFunc();

// 제너레이터 객체는 이터러블이면서 동시에 이터레이터다.
// 이터러블은 Symbol.iterator 메서드를 직접 구현하거나 프로토타입 체인을 통해 상속받은 객체다.
console.log(Symbol.iterator in generator); // true
// 이터레이터는 next 메서드를 갖는다.
console.log('next' in generator); // true

3.1 return, throw 메서드

제너레이터 객체는 이터레이터이지만, 동시에 return, throw 메서드도 갖는다

function* genFunc() {
  try {
    yield 1;
    yield 2;
    yield 3;
  } catch(e) {
    console.error(e);
  }
}
const generator = genFunc();
console.log(generator.next()); // {value: 1, done: false}
console.log(generator.return('End!')); // {value: "End!", done: true}

next 메서드 호출 : 제너레이터 함수의 yield 표현식까지 코드 블록을 실행하고 yield된 값을 vlaue 프로퍼티 값으로, false를 done 프로퍼티 값으로 갖는 이터레이터 result 객체를 반환한다.
return 메서드 호출 : 인수로 전달받은 값을 value 프로퍼티 값으로, true를 done 프로퍼티 값으로 갖는 이터레이터 result 객체를 반환

function* genFunc() {
  try {
    yield 1;
    yield 2;
    yield 3;
  } catch(e) {
  console.error(e);
  }
}
const generator = genFunc();
console.log(generator.next()); // {value: 1, done: false}
console.log(generator.throw()); // {value: undefined, done: treu}

throw 메서드를 호출 : 인수로 전달받은 에러를 발생시키고 undefined를 value 프로퍼티 값으로, true를 done 프로퍼티 값으
는 이터레이터 result 객체를 반환

4. 제너레이터의 일시 중지와 재개

제너레이터 함수는 함수 호출자에게 제어권을 양도하기 때문에 yield 키워드와 next 메서드를 통해 함수 실행을 일시 중지했다가 필요한 시점에 다시 재개 가능!
제너레이터 함수를 호출하면 제너레이터 객체를 반환하는데, next를 사용해 제너레이터 함수의 코드 블록 실행 가능
yield 키워드 : 제너레이터 함수의 실행을 일시 중지시키거나 키워드 뒤에 오는 표현식의 평가 결과를 제너레이터 함수 호출자에 반환

// 제너레이터 함수
function* genFunc() {
  yield 1;
  yield 2;
  yield 3;
}

// 제너레이터 함수를 호출하면 제너레이터 객체를 반환한다.
// 이터러블이면서 동시에 이터레이터인 제너레이터 객체는 next 메서드를 갖는다.
const generator = genFunc();

// 처음 next 메서드를 호출하면 첫 번째 yield 표현식까지 실행되고 일시 중지된다.
// next 메서드는 이터레이터 result 객체({value, done})를 반환한다.
// value 프로퍼티에는 첫 번째 yield 표현식에서 yield된 값 1이 할당된다.
// done 프로퍼티에는 제너레이터 함수가 끝까지 실행되었는지를 나타내는 false가 할당된다.
console.log(generator.next()); // {value: 1, done: false}

// 다시 next 메서드를 호출하면 두 번째 yield 표현식까지 실행되고 일시 중지된다.
// next 메서드는 이터레이터 result 객체({value, done})를 반환한다.
// value 프로퍼티에는 두 번째 yield 표현식에서 yield된 값 2가 할당된다.
// done 프로퍼티에는 제너레이터 함수가 끝까지 실행되었는지를 나타내는 false가 할당된다.
console.log(generator.next()); // {value: 2, done: false}

// 다시 next 메서드를 호출하면 세 번째 yield 표현식까지 실행되고 일시 중지된다.
// next 메서드는 이터레이터 result 객체({value, done})를 반환한다.
// value 프로퍼티에는 세 번째 yield 표현식에서 yield된 값 3이 할당된다.
// done 프로퍼티에는 제너레이터 함수가 끝까지 실행되었는지를 나타내는 false가 할당된다.
console.log(generator.next()); // {value: 3, done: false}

// 다시 next 메서드를 호출하면 남은 yield 표현식이 없으므로 제너레이터 함수의 마지막까지 실행한다.
// next 메서드는 이터레이터 result 객체({value, done})를 반환한다.
// value 프로퍼티에는 제너레이터 함수의 반환값 undefined가 할당된다.
// done 프로퍼티에는 제너레이터 함수가 끝까지 실행되었음을 나타내는 true가 할당된다.
console.log(generator.next()); // {value: undefined, done: true}

generator.next() → yield → generator.next() → yield → ... → generator.next() → return

즉, next() 할 때마다 다음 함수를 실행한다
이터레이터의 next 메서드와 달리 제너레이터 객체의 next 메서드에는 인수를 전달할 수 있다😯
제너레이터 객체의 next 메서드에 전달한 인수는 제너레이터 함수의 yield 표현식을 할당받는 변수에 할당된다

function* genFunc() {
  // 처음 next 메서드를 호출하면 첫 번째 yield 표현식까지 실행되고 일시 중지된다.
  // 이때 yield된 값 1은 next 메서드가 반환한 이터레이터 result 객체의 value 프로퍼티에 할당된다.
  // x 변수에는 아직 아무것도 할당되지 않았다. x 변수의 값은 next 메서드가 두 번째 호출될 때 결정된다.
  const x = yield 1;

  // 두 번째 next 메서드를 호출할 때 전달한 인수 10은 첫 번째 yield 표현식을 할당받는 x 변수에 할당된다.
  // 즉, const x = yield 1;은 두 번째 next 메서드를 호출했을 때 완료된다.
  // 두 번째 next 메서드를 호출하면 두 번째 yield 표현식까지 실행되고 일시 중지된다.
  // 이때 yield된 값 x + 10은 next 메서드가 반환한 이터레이터 result 객체의 value 프로퍼티에 할당된다.
  const y = yield (x + 10);

  // 세 번째 next 메서드를 호출할 때 전달한 인수 20은 두 번째 yield 표현식을 할당받는 y 변수에 할당된다.
  // 즉, const y = yield (x + 10);는 세 번째 next 메서드를 호출했을 때 완료된다.
  // 세 번째 next 메서드를 호출하면 함수 끝까지 실행된다.
  // 이때 제너레이터 함수의 반환값 x + y는 next 메서드가 반환한 이터레이터 result 객체의 value 프로퍼티에 할당된다.
  // 일반적으로 제너레이터의 반환값은 의미가 없다.
  // 따라서 제너레이터에서는 값을 반환할 필요가 없고 return은 종료의 의미로만 사용해야 한다.
  return x + y;
}

// 제너레이터 함수를 호출하면 제너레이터 객체를 반환한다.
// 이터러블이며 동시에 이터레이터인 제너레이터 객체는 next 메서드를 갖는다.
const generator = genFunc(0);

// 처음 호출하는 next 메서드에는 인수를 전달하지 않는다.
// 만약 처음 호출하는 next 메서드에 인수를 전달하면 무시된다.
// next 메서드가 반환한 이터레이터 result 객체의 value 프로퍼티에는 첫 번째 yield된 값 1이 할당된다.
let res = generator.next();
console.log(res); // {value: 1, done: false}

// next 메서드에 인수로 전달한 10은 genFunc 함수의 x 변수에 할당된다.
// next 메서드가 반환한 이터레이터 result 객체의 value 프로퍼티에는 두 번째 yield된 값 20이 할당된다.
res = generator.next(10);
console.log(res); // {value: 20, done: false}

// next 메서드에 인수로 전달한 20은 genFunc 함수의 y 변수에 할당된다.
// next 메서드가 반환한 이터레이터 result 객체의 value 프로퍼티에는 제너레이터 함수의 반환값 30이 할당된다.
res = generator.next(20);
console.log(res); // {value: 30, done: true}

이와 같이 제너레이터 함수는 next와 yield 표현식을 통해 함수 호출자와 함수의 상태를 주고받을 수 있다!
이를 이용해 비동기 처리를 동기 처리처럼 구현할 수 있다

5. 제너레이터의 활용

5.1 이터러블의 구현

예시 1, 이터레이션 프로토콜을 준수해 무한 파보나치 수열 생성

// 무한 이터러블을 생성하는 함수
cosnt infiniteFibonacci = (function () {
  let [pre, cur] = [0, 1];

  return {
    [Symbol.iterator]() { return this; },
    next() {
      [pre, cur] = [cur, pre + cur];
      // 무한 이터러블이므로 done 프로퍼티를 생략한다.
      return { value: cur};
    }
  };
}());

// infiniteFibonacci는 무한 이터러블이다.
for(cosnt num of infiniteFibonacci) {
  if(num > 10000) break;
  console.log(num); // 1 2 3 5 8 ... 2584 4181 6765
}

위를 제너레이터를 사용해 구현해보자. 훨씬 간단해진다

예시2, 제너레이터 함수를 사용해 무한 파보나치 수열 생성

// 무한 이터러블을 생성하는 제너레이터 함수
cosnt infiniteFibonacci = (function* () {
  let [pre, cur] = [0, 1];

  while(true) {
    [pre, cur] = [cur, pre + cur];
    yield cur;
  }
}());

// infiniteFibonacci는 무한 이터러블
for(const num of infiniteFibonacci) {
  if(num > 10000) break;
  console.log(num); // 1 2 3 5 8 .... 2584 4181 6765
}

5.2 비동기 처리

제너레이터 함수는 next 메서드와 yield 표현식을 통해 함수 호출자와 함수의 상태를 주고받을 수 있다
이러한 특성을 활용하면 프로미스를 사용한 비동기 처리를 동기 처리처럼 구현할 수 있다!
=> 즉, 프로미스의 후속 처리 메서드 then/catch/finally 없이 비동기 처리 결과를 반환하도록 구현 가능

// node-fetch는 Node.js 환경에서 window.fetch 함수를 사용하기 위한 패키지다.
const fetch = require('node-fetch');

// 제너레이터 실행기
cosnt async = generatorFunc => {
  const generator = generatorFucn(); // (2)

  const onResolved = arg = > {
    const result = generator.next(arg); // (5)

    return result.done
      ? result.value // (9)
      : result.value.then(res = > onresolved(res)); // (7)
  };
  return onResolved; // (3)
};

(async(function* fetchTodo() { // (1)
  const url = 'https://jsonplaceholder.typicode.com/todos/1';
  const response = yield fetch(url); // (6)
  const todo = yield response.json(); // (8)
  console.log(todo);
  // {userId: 1, id: 1, title: 'deletus aut autem', completed: false}
})());

위 예제의 동작 순서는 다음과 같다

async 함수가 호출(1)되면 인수로 전달받은 제너레이터 함수 getchTodo를 호출하여 제너레이터 객체를 생성(2)하고 onResolved 함수를 반환(3)한다. onResolved 함수는 상위 스코프의 generator 변수를 기억하는 클로저이므로 async 함수가 반환한
onResolved 함수를 즉시 호출(4)하여 (2)에서 생성한 제너레이터 객체의 next 메서드를 처음 호출(5)한다.
next 메서드가 처음 호출(5)되면 제너레이터 함수 fetchTodo의 첫 번째 yield문(6)까지 실행된다.
이때 next 메서드가 반환한 이터레이터 리절트 객체의 done 프로퍼티 값이 false이면 이터레이터 result 객체의 value 프로퍼티
첫 번째 yield된 fetch 함수가 반환한 프로미스가 resolve한 Response 객체를 onResolved 함수에 인수로 전달하면서 재귀 호출
한다.
onResolved 함수에 인수로 전달된 Response 객체를 next 메서드에 인수로 전달하면서 next 메서드를 두 번째로 호출(5)한다. 이 next 메서드에 인수로 전달한 Response 객체는 제너레이터 함수 fetchTodo의 response 변수(6)에 할당되고 제너레이터 함수
fetchTodo의 두 번째 yield 문(8)까지 실행된다.
next 메서드가 반환한 done 프로퍼티 값이 false라면 이터레이터 리절트 객체의 value 프로퍼티 값, 즉 두번째 yield된 response 메서드가 반환한 프로미스가 resove한 todo 객체를 onResolved 함수에 인수로 전달하면서 재귀 호출(7)한다.
onResolve 함수에 인수로 전달된 todo 객체를 next 메서드에 인수로 전달하면서 next 메서드를 세 번째로 호출(5)한다. 이때 ne 메서드에 인수로 전달한 todo 객체는 제너레이터 함수 fetchTodo의 todo 변수(8)에 할당되고 제너레이터 함수 fetchTodo가 끝까지 실행된다.
6.next 메서드가 반환한 이터레이터 리절트 객체의 done 프로퍼티 값이 true라면 이터레이터 리절트 객체의 value 프로퍼티 값, 즉
레이터 함수 fetchTodo의 반환값이 undefined를 그대로 반환(9)하고 처리를 종료한다.

6. async/await

ES8(ECMAScript 2017)에서 async/await가 도입됐다
async/await는 프로미스를 기반으로 동작
async/await를 사용하면 프로미스의 then/catch/finally 후속 처리 메서드에 콜백 함수를 전달해서 비동기 처리 결과를 후속 처리할 필요 없이 마치 동기 처럼 프로미스를 사용할 수 있다

const fetch = require('node-fetch');

async function fetchTodo() {
  const url = 'https://jsonplaceholder.typicode.com/todos/1';

  const response = await fetch(url);
  const todo = await response.json();
  console.log(todo);
  // {userId: 1, id: 1, title: 'delectus aut autem', completed: false}
}

fetchTodo();

6.1 async 함수

// async 함수 선언문
async function foo(n) { return n; }
foo(1).then(v => console.log(v)); // 1

// async 함수 표현식
const bar = async function (n) { return n; };
bar(2).then(v => console.log(v)); // 2

// async 화살표 함수
const baz = async n => n;
baz(3).then(v => console.log(v)); // 3

// async 메서드
const obj = {
  async foo(n) { return n; }
};
obj.foo(4).then(v => console.log(v)); // 4

// async 클래스 메서드
class MyClass {
  async bar(n) { return n; }
}
const myClass = new MyClass();
myClass.bar(5).then(v => console.log(v)); // 5

await 키워드는 반드시 async 함수 내부에서 사용해야 한다
async 함수는 언제나 프로미스를 반환

class MyClass {
  async constructor() { }
  // SyntaxError: Class constructor may not be an async method
}

const myClass = new MyClass();

클래스의 constructor 메서드에서는 async 사용 불가능
클래스의 constructor 메서드는 인스턴스를 반환해야하지만 async 함수는 프로미스를 반환하기 때문

6.2 await 키워드

await 키워드는 프로미스가 settled 상태(비동기 처리가 수행된 상태)가 될 때까지 대기하다가 settled 상태가 되면 프로미스가 resolve한 처리 결과를 반환

const fetch = require('node-fetch');

const getGithubUserName = async id => {
  const res = await fetch(`https://api.github.com/users/${id}`); // ①
  const { name } = await res.json(); // ②
  console.log(name); // Ungmo Lee
};

getGithubUserName('ungmo2');

①의 fetch 함수가 수행한 HTTP 요청이 끝나 반환하는 fetch의 프로미스가 settled 상태가 될 때까지 ①은 대기한다. 이후 프로미스가 settled 상태가 되면 프로미스가 resolve한 처리 결과가 res 변수에 할당된다
이후 ②의 코드가 실행된다.

=> 이처럼 await 키워드는 다음 실행을 일시 중지시켰다가 프로미스가 settled 상태가 되면 다시 재개한다

async function bar(n) {
  const a = await new Promise(resolve => setTimeout(() => resolve(n), 3000));
  // 두 번째 비동기 처리를 수행하려면 첫 번째 비동기 처리 결과가 필요하다.
  const b = await new Promise(resolve => setTimeout(() => resolve(a + 1), 2000));
  // 세 번째 비동기 처리를 수행하려면 두 번째 비동기 처리 결과가 필요하다.
  const c = await new Promise(resolve => setTimeout(() => resolve(b + 1), 1000));

  console.log([a, b, c]); // [1, 2, 3]
}

bar(1); // 약 6초 소요된다.

두 번째, 세 번째 프로미스는 이전의 상태값을 이용해 비동기 처리를 한다
따라서 비동기 처리의 처리 순서가 보장되어야 하므로 모든 프로미스에 await 키워드를 써서 순차적으로 처리한다

6.3 에러 처리

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

비동기 처리를 위한 콜백 패턴의 단점 중 가장 심각한 것은 에러 처리가 곤란하다는 점

const fetch = require('node-fetch');

const foo = async () => {
  try {
    const wrongUrl = 'https://wrong.url';

    const response = await fetch(wrongUrl);
    const data = await response.json();
    console.log(data);
  } catch (err) {
    console.error(err); // TypeError: Failed to fetch
  }
};

foo();

async/await는 try ...catch 문을 사용해도 예상한 대로 동작한다
프로미스를 반환하는 비동기 함수는 명시적으로 호출할 수 있어서, 호출자가 명확하기 때문이다.
위 예제에서 호출자는? foo()의 호출자는 window이고, async()의 호출자는 foo 이다. async가 완료되어 프로미스를 반환할 때까지 foo()는 죽지 않고 살아있다

const fetch = require('node-fetch');

const foo = async () => {
  const wrongUrl = 'https://wrong.url';

  const response = await fetch(wrongUrl);
  const data = await response.json();
  return data;
};

foo()
  .then(console.log)
  .catch(console.error); // TypeError: Failed to fetch