Post

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

Posted
By your_full_name 29 min read

46.1 제너레이터란?

  • ES6에서 도입
  • 코드 블록의 실행을 일시 중지했다가 필요한 시점에 재개할 수 있는 특수한 함수
  • 일반 함수와의 차이점
    1. 제너레이터 함수는 함수 호출자에게 함수 실행 제어권 양도 가능
      • 일반 함수: 호출 시 제어권은 함수로 넘어간 뒤 함수 코드를 일괄 실행
        ⇒ 함수 호출자는 함수 호출 이후 함수 실행을 제어할 수 없다.
      • 제너레이터 함수: 함수 호출자가 함수 실행을 일시 중지/재개시킬 수 있다.
      • 즉 함수의 제어권을 함수가 독점하는 것이 아니라, 함수 호출자에게 양도(yield)할 수 있다.
    2. 제너레이터 함수는 함수 호출자와 함수의 상태를 주고받을 수 있다.
      • 일반 함수: 호출 시 함수가 실행되고 있는 동안에는 함수 외부에서 함수 내부로 값을 전달해 함수의 상태 변경 불가
      • 제너레이터 함수: 함수 호출자와 양방향으로 함수의 상태를 주고받을 수 있다.
      • 즉 제너레이터 함수는 함수 호출자에게 상태를 전달할 수 있고 함수 호출자로부터 상태를 전달받을 수도 있다.
    3. 제너레이터 함수는 제너레이터 객체를 반환
      1. 일반 함수: 호출 시 함수 코드 일괄 실행 후 값을 반환
      2. 제너레이터 함수: 호출 시 함수 코드 블록을 실행하는 게 아니라 이터러블이면서 이터레이터인 제너레이터 객체를 반환

46.2 제너레이터 함수의 정의

  • function* 키워드로 선언 + 하나 이상의 yield 표현식을 포함

    1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

      // 제너레이터 함수 선언문
  function* genDecFunc() {
    yield 1;
  }
    
  // 제너레이터 함수 표현식
  const genExpFunc = function* () {
    yield 1;
  };
    
  // 제너레이터 메서드
  const obj = {
    * genObjMethod() {
      yield 1;
    }
  };
    
  // 제너레이터 클래스 메서드
  class MyClass {
    * genClsMethod() {
      yield 1;
    }
  }

  • *의 위치는 function 키워드와 함수 이름 사이라면 어디든 상관없지만, 일관성을 위해 function 키워드 바로 뒤에 붙이는 것을 권장

    1
2
3
4
5
6
7

      function* genFunc() { yield 1; }
    
  function * genFunc() { yield 1; }
    
  function *genFunc() { yield 1; }
    
  function*genFunc() { yield 1; }

  • 화살표 함수로 정의 불가

    1
2
3

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

  • new 연산자와 함께 생성자 함수로 호출 불가

    1
2
3
4
5

      function* genFunc() {
    yield 1;
  }
    
  new genFunc(); // TypeError: genFunc is not a constructor

46.3 제너레이터 객체

  • 제너레이터 함수 호출 시 생성되어 반환
    • value 프로퍼티: yield된 값(yield 키워드 뒤의 값) 또는 제너레이터 함수의 반환 값을 할당
    • done 프로퍼티: 제너레이터 함수가 끝까지 실행되었는지의 여부를 불리언 값으로 할당
  • 이터러블이면서 이터레이터
    • 이터러블 ⇒ Symbol.iterator 메서드를 상속받음
    • 이터레이터 ⇒ next 메서드를 소유하며 value, done 프로퍼티를 갖는 이터레이터 리절트 객체를 반환
      • next 메서드를 가지므로 Symbol.iterator 메서드를 호출해 이터레이터를 생성할 필요 없다.
    1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

      // 제너레이터 함수
  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
  • 이터레이터에 없는 return, throw 메서드를 소유
    • next 메서드 호출
      1. 제너레이터 함수의 yield 표현식까지 코드 블록 실행
      2. 이터레이터 리절트 객체 반환
        • yield된 값을 value 프로퍼티 값으로 , false를 done 프로퍼티 값으로 갖는다.
      1
2
3
4
5
6
7
8
9
10
11
12
13

        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}
    • return 메서드 호출
      1. 이터레이터 리절트 객체 반환
        • 인수로 전달받은 값을 value 프로퍼티 값으로 , true를 done 프로퍼티 값으로 갖는다.
      1
2
3
4
5
6
7
8
9
10
11
12
13

        function* genFunc() {
    try {
      yield 1;
      yield 2;
      yield 3;
    } catch (e) {
      console.error(e);
    }
  }
        
  const generator = genFunc();
        
  console.log(generator.return('End!')); // {value: "End!", done: true}
    • throw 메서드 호출
      1. 인수로 전달받은 에러 발생
      2. 이터레이터 리절트 객체 반환
        • undefined를 value 프로퍼티 값으로 , true를 done 프로퍼티 값으로 갖는다.
      1
2
3
4
5
6
7
8
9
10
11
12
13
14

        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('Error!')); // {value: undefined, done: true}

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

제너레이터는 yield 키워드와 next 메서드를 통해 실행을 일시 중지하고, 필요한 시점에 재개할 수 있다.

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

    1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

      // 제너레이터 함수
  function* genFunc() {
    yield 1;
    yield 2;
    yield 3;
  }
    
  // 제너레이터 함수를 호출하면 제너레이터 객체를 반환한다.
  // 이터러블이면서 동시에 이터레이터인 제너레이터 객체는 next 메서드를 갖는다.
  const generator = genFunc();
    
  // 처음 next 메서드를 호출하면 첫 번째 yield 표현식까지 실행되고 일시 중지된다.
  // next 메서드는 이터레이터 리절트 객체({value, done})를 반환한다.
  // value 프로퍼티에는 첫 번째 yield 표현식에서 yield된 값 1이 할당된다.
  // done 프로퍼티에는 제너레이터 함수가 끝까지 실행되었는지를 나타내는 false가 할당된다.
  console.log(generator.next()); // {value: 1, done: false}
    
  // 다시 next 메서드를 호출하면 두 번째 yield 표현식까지 실행되고 일시 중지된다.
  // next 메서드는 이터레이터 리절트 객체({value, done})를 반환한다.
  // value 프로퍼티에는 두 번째 yield 표현식에서 yield된 값 2가 할당된다.
  // done 프로퍼티에는 제너레이터 함수가 끝까지 실행되었는지를 나타내는 false가 할당된다.
  console.log(generator.next()); // {value: 2, done: false}
    
  // 다시 next 메서드를 호출하면 세 번째 yield 표현식까지 실행되고 일시 중지된다.
  // next 메서드는 이터레이터 리절트 객체({value, done})를 반환한다.
  // value 프로퍼티에는 세 번째 yield 표현식에서 yield된 값 3이 할당된다.
  // done 프로퍼티에는 제너레이터 함수가 끝까지 실행되었는지를 나타내는 false가 할당된다.
  console.log(generator.next()); // {value: 3, done: false}
    
  // 다시 next 메서드를 호출하면 남은 yield 표현식이 없으므로 
  // 제너레이터 함수의 마지막까지 실행한다.
  // next 메서드는 이터레이터 리절트 객체({value, done})를 반환한다.
  // value 프로퍼티에는 제너레이터 함수의 반환값 undefined가 할당된다.
  // done 프로퍼티에는 제너레이터 함수가 끝까지 실행되었음을 나타내는 true가 할당된다.
  console.log(generator.next()); // {value: undefined, done: true}
    1. next 메서드 호출
      1. yield 표현식까지 코드 블록 실행
      2. 일시 중지(suspend)
      3. 함수의 제어권을 호출자로 양도(yield)
    2. 필요한 시점에 함수 호출자가 다시 next 메서드 호출
      1. 일시 중지된 코드부터 실행을 재개(resume)
      2. 다음 yield 표현식까지 코드 블록 실행
      3. 일시 중지(suspend)
      4. 반복

  • 제너레이터 객체의 next 메서드에는 인수를 전달할 수 있다.

    • 인수는 yield 표현식을 할당받는 변수에 할당된다.
    1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

      function* genFunc() {
    // 처음 next 메서드를 호출하면 첫 번째 yield 표현식까지 실행되고 일시 중지된다.
    // 이때 yield된 값 1은 next 메서드가 반환한 이터레이터 리절트 객체의 
  	// value 프로퍼티에 할당된다. x 변수에는 아직 아무것도 할당되지 않았다. 
  	// x 변수의 값은 next 메서드가 두 번째 호출될 때 결정된다.
    const x = yield 1;
    
    // 두 번째 next 메서드를 호출할 때 전달한 인수 10은 
  	// 첫 번째 yield 표현식을 할당받는 x 변수에 할당된다.
    // 즉, const x = yield 1;은 두 번째 next 메서드를 호출했을 때 완료된다.
    // 두 번째 next 메서드를 호출하면 두 번째 yield 표현식까지 실행되고 일시 중지된다.
    // 이때 yield된 값 x + 10은 next 메서드가 반환한 이터레이터 리절트 객체의 
  	// value 프로퍼티에 할당된다.
    const y = yield (x + 10);
    
    // 세 번째 next 메서드를 호출할 때 전달한 인수 20은 
  	// 두 번째 yield 표현식을 할당받는 y 변수에 할당된다.
    // 즉, const y = yield (x + 10);는 세 번째 next 메서드를 호출했을 때 완료된다.
    // 세 번째 next 메서드를 호출하면 함수 끝까지 실행된다.
    // 이때 제너레이터 함수의 반환값 x + y는 next 메서드가 반환한 
  	// 이터레이터 리절트 객체의 value 프로퍼티에 할당된다.
    // 일반적으로 제너레이터의 반환값은 의미가 없다.
    // 따라서 제너레이터에서는 값을 반환할 필요가 없고 
  	// return은 종료의 의미로만 사용해야 한다.
    return x + y;
  }
    
  // 제너레이터 함수를 호출하면 제너레이터 객체를 반환한다.
  // 이터러블이며 동시에 이터레이터인 제너레이터 객체는 next 메서드를 갖는다.
  const generator = genFunc(0);
    
  // 처음 호출하는 next 메서드에는 인수를 전달하지 않는다.
  // 만약 처음 호출하는 next 메서드에 인수를 전달하면 무시된다.
  // next 메서드가 반환한 이터레이터 리절트 객체의 value 프로퍼티에는 
  // 첫 번째 yield된 값 1이 할당된다.
  let res = generator.next();
  console.log(res); // {value: 1, done: false}
    
  // next 메서드에 인수로 전달한 10은 genFunc 함수의 x 변수에 할당된다.
  // next 메서드가 반환한 이터레이터 리절트 객체의 value 프로퍼티에는 
  // 두 번째 yield된 값 20이 할당된다.
  res = generator.next(10);
  console.log(res); // {value: 20, done: false}
    
  // next 메서드에 인수로 전달한 20은 genFunc 함수의 y 변수에 할당된다.
  // next 메서드가 반환한 이터레이터 리절트 객체의 value 프로퍼티에는 
  // 제너레이터 함수의 반환값 30이 할당된다.
  res = generator.next(20);
  console.log(res); // {value: 30, done: true}
    • 함수 호출자와 함수 상태를 주고받을 수 있는 특성을 활용해 비동기 처리를 동기 처리처럼 구현할 수 있다.

46.5 제너레이터의 활용

46.5.1 이터러블의 구현

  • 이터레이션 프로토콜을 준수해 이터러블을 생성하는 방식보다 간단히 이터러블을 구현 가능

    • 이터레이션 프로토콜을 준수하는 무한 피보나치 수열 생성 함수

      1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

        // 무한 이터러블을 생성하는 함수
  const infiniteFibonacci = (function () {
    let [pre, cur] = [0, 1];
        
    return {
      [Symbol.iterator]() { return this; },
      next() {
        [pre, cur] = [cur, pre + cur];
        // 무한 이터러블이므로 done 프로퍼티를 생략한다.
        return { value: cur };
      }
    };
  }());
        
  // infiniteFibonacci는 무한 이터러블이다.
  for (const num of infiniteFibonacci) {
    if (num > 10000) break;
    console.log(num); // 1 2 3 5 8...2584 4181 6765
  }

    • 제너레이터를 활용한 무한 피보나치 수열 생성 함수

      1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

        // 무한 이터러블을 생성하는 제너레이터 함수
  const 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
  }

46.5.2 비동기 처리

프로미스의 후속 처리 메서드 없이 비동기 처리 결과를 반환하도록 구현할 수 있다.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

// node-fetch는 node.js 환경에서 window.fetch 함수를 사용하기 위한 패키지다.
// 브라우저 환경에서 이 예제를 실행한다면 아래 코드는 필요 없다.
// https://github.com/node-fetch/node-fetch
const fetch = require('node-fetch');

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

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

    return result.done
      ? result.value // ⑨
      : result.value.then(res => onResolved(res)); // ⑦
  };

  return onResolved; // ③
};

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

  const response = yield fetch(url); // ⑥
  const todo = yield response.json(); // ⑧
  console.log(todo);
  // {userId: 1, id: 1, title: 'delectus aut autem', completed: false}
})()); // ④
  1. async 함수 호출
    1. 인수로 전달받은 제너레이터 함수 fetchTodo 호출
  2. 제너레이터 객체 생성
  3. onResolved 함수 반환
    1. onResolved 함수: 상위 스코프의 generator 변수를 기억하는 클로저
  4. 반환된 onResolved 함수를 즉시 호출
  5. 제너레이트 객체의 next 메서드를 처음 호출
  6. 제너레이트 함수 fetchTodo의 첫 번째 yield문까지 실행
    1. next 메서드가 이터레이터 리절트 객체를 반환하며 이때 done 프로퍼티 값은 false
  7. yield된 fetch 함수가 반환한 프로미스가 resolve한 Response 객체를 onResolved 함수에 res 인수로 전달하며 재귀 호출
    1. Response 객체를 next 메서드의 arg 인수로 전달하며 두 번쨰로 next 메서드 호출(⑤)
    2. 이때 arg 인수로 전달한 Response 객체는 fetchTodo의 response 변수에 할당(⑥)
  8. 제너레이트 함수 fetchTodo의 두 번째 yield문까지 실행
    1. next 메서드가 이터레이터 리절트 객체를 반환하며 이때 done 프로퍼티 값은 false
    2. yield된 response.json() 메서드가 반환한 프로미스가 resolve한 todo 객체를 onResolved 함수에 res 인수로 전달하며 재귀 호출(⑦)
    3. todo 객체를 next 메서드의 arg 인수로 전달하며 세 번쨰로 next 메서드 호출(⑤)
    4. 이때 arg 인수로 전달한 todo 객체는 fetchTodo의 todo 변수에 할당(⑧)
    5. 제너레이터 함수를 끝까지 실행
    6. next 메서드가 이터레이터 리절트 객체를 반환하며 이때 done 프로퍼티 값은 true
  9. 이터레이터 리절트 객체의 value 프로퍼티 값(fetchTodo의 반환값 undefined)을 그대로 반환
    • 위 예제는 완전하지 않으며 제너레이터 실행기가 필요하다면 co 라이브러리 사용을 권장한다.
    1
2
3
4
5
6
7
8
9
10
11
12

     const fetch = require('node-fetch');
 // https://github.com/tj/co
 const co = require('co');
    
 co(function* fetchTodo() {
   const url = 'https://jsonplaceholder.typicode.com/todos/1';
    
   const response = yield fetch(url);
   const todo = yield response.json();
   console.log(todo);
   // { userId: 1, id: 1, title: 'delectus aut autem', completed: false }
 });

46.6 async/await

  • ES8(ECMAScript 2017)에서 도입
  • 제너레이터보다 간단하고 높은 가독성으로 비동기 처리를 동기 처리처럼 동작하도록 구현 가능
  • 프로미스를 기반으로 동작
    • 후속 처리 메서드가 필요 없어 동기 처리처럼 프로미스 사용 가능
    1
2
3
4
5
6
7
8
9
10
11
12

      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();

46.6.1 async 함수

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

// 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
  • async 키워드를 사용해 정의
    • await 키워드는 반드시 async 함수 내부에서 사용
  • 언제나 프로미스 반환
    • 명시적으로 프로미스를 반환하지 않아도 암묵적으로 반환값을 resolve하는 프로미스 반환
  • 클래스의 constructor 메서드는 async 메서드가 될 수 없다.
    • async 함수는 언제나 프로미스를 반환해야 하지만 클래스의 constructor 메서드는 인스턴스를 반환해야 한다.
    1
2
3
4
5
6

      class MyClass {
    async constructor() { }
    // SyntaxError: Class constructor may not be an async method
  }
    
  const myClass = new MyClass();

46.6.2 await 키워드

1
2
3
4
5
6
7
8
9

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');
  • 프로미스가 settled 상태가 될 때까지 대기 → settled 상태가 되면 프로미스가 resolve한 처리 결과 반환
  • 반드시 프로미스 앞에서 사용
  • 다음 실행을 일시 중지시켰다가 프로미스가 settled 상태가 되면 재개

    • 모든 프로미스에 await 키워드를 사용하는 것은 주의해야 한다.

      1
2
3
4
5
6
7
8
9

        async function foo() {
    const a = await new Promise(resolve => setTimeout(() => resolve(1), 3000));
    const b = await new Promise(resolve => setTimeout(() => resolve(2), 2000));
    const c = await new Promise(resolve => setTimeout(() => resolve(3), 1000));
        
    console.log([a, b, c]); // [1, 2, 3]
  }
        
  foo(); // 약 6초 소요된다.

      1
2
3
4
5
6
7
8
9
10
11

        async function foo() {
    const res = await Promise.all([
      new Promise(resolve => setTimeout(() => resolve(1), 3000)),
      new Promise(resolve => setTimeout(() => resolve(2), 2000)),
      new Promise(resolve => setTimeout(() => resolve(3), 1000))
    ]);
        
    console.log(res); // [1, 2, 3]
  }
        
  foo(); // 약 3초 소요된다.

  • 비동기 처리 순서가 보장되어야 하는 경우 await 키워드를 써서 순차적으로 처리 가능

    1
2
3
4
5
6
7
8
9
10
11

      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초 소요된다.

46.6.3 에러 처리

  • 에러는 호출자 방향으로 전파된다.
    • 즉 콜 스택의 아래 방향으로 전파된다.
    • 하지만 비동기 함수가 비동기 함수의 호출자가 아니므로 try...catch문으로 에러 캐치 불가
    1
2
3
4
5
6

      try {
    setTimeout(() => { throw new Error('Error!'); }, 1000);
  } catch (e) {
    // 에러를 캐치하지 못한다
    console.error('캐치한 에러', e);
  }
  • async/await에서는 try...catch문으로 에러 캐치 가능
    • 프로미스를 반환하는 비동기 함수는 명시적으로 호출할 수 있어 호출자가 명확
    1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

      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();
  • catch문으로 에러 처리를 하지 않으면 async 함수는 에러를 reject하는 프로미스 반환

    • Promise.prototype.catch 후속 처리 메서드를 사용해 에러 캐치 가능

      1
2
3
4
5
6
7
8
9
10
11
12
13

        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
book_notes
모던 자바스크립트 Deep Dive
This post is licensed under CC BY 4.0 by the author.