24. yield 키워드

• Enumerator(Iterator) : 집합적인 데이터셋으로부터 데이터를 하나씩 호출자에게 보내주게 하는 기능 => 반복자

• yield 키워드는 호출자에게 컬렉션 데이터를 하나씩 리턴할 때 사용하는 키워드

• yield 사용방식

  • yield return : 컬렉션 데이터를 하나씩 리턴하는데 사용
  • yield break : 리턴을 중지하고 Iteration 루프를 빠져나올때 사용

IEnumerator == 데이터를 리턴(Getter)하는 열거자

public interface IEnumerator
{
    object Current { get; }
    bool MoveNext();
    void Reset();
}

• Current
  • 읽기 전용 프로퍼티로 현재 위치의 데이터를 object 타입으로 리턴한다.
  • object는 System.Object와 같다.
• MoveNext (=> Java의 hasNext()와 유사)
  • 다음 위치로 이동하는데 다음 위치에 데이터가 있으면 true, 없으면 false.
  • 그래서 보통 컬렉션 인덱스를 1씩 증가 시켜 컬렉션의 끝에 도달 했는지 여부를 나타내는 bool을 반환하는 식으로 구현함.
• Reset
  • 인덱스를 초기 위치로 초기화
  • 보통 컬렉션의 인덱스를 -1로 설정하는식으로 구현
  • IEnumerator 를 리턴하는 모든 함수는 ref,out 매개변수가 허용되지 않는다. 또한 람다 함수에 사용할 수도 없다.

IEnumerable == IEnumerator(열거자)를 Get하는데 필요한 인터페이스

public interface IEnumerable
{
    IEnumerator GetEnumerator();
}

• 객체로 foreach문을 돌리기 위해서는 그 객체 타입이 IEnumerable을 상속받은 클래스여야 한다.

• IEnumerable을 상속받아 GetEnumerator()을 구현한 클래스이어야 foreach로 내부 데이터를 열거할 수 있다.

• 마찬가지로 IEnumerable 를 리턴하는 모든 함수는 ref, out 매개변수가 허용되지 않는다. 또한 람다 함수에 사용할 수 도 없다.

namespace yieldEx
{
    class Program
    {

        static IEnumerable<int> GetNumber()
        {
            yield return 1;
            yield return 2;
            yield return 3;
        }

        static void Main(string[] args)
        {
            foreach (int i in GetNumber())
            {
                Console.WriteLine(i);
            }
        }
    }
}

Output

1
2
3

IEnumerator 실습

using System.Collections;

namespace yieldEx2
{
    class MyList
    {
        private int[] data = { 1, 2, 3, 4, 5 };
        //배열은 이미 IEnumerator와 IEnumerable을 구현하고 있다.
        public IEnumerator GetEnumerator()
        {
            int i = 0;
            while (i < data.Length)
            {
                yield return data[i]; // 2. yield를  만나면 호출된 곳에 먼저 return을 해주고 다시 호출될 때까지 대기. 

                //IEnumator를 리턴값으로 뒀을때에는 yield 문법을 사용하여 리턴을 해야한다.
                // yield를 만나면 호출된 곳으로 다시 돌아가 값을 return 한 뒤 다시 돌아와 비동기적으로 동작을 한다.

                i++;// 4. 복귀후 해당코드 실행하고 while문 동작 실행하며 일련의 반복과정을 진행.
            }
        }
        // IEnumerable 인터페이스는 GetEnumerator()메소드 하나를 가지고 있다. 
        // 이때 GetEnumerator()메소드는 IEnumerator를 구현한 객체를 리턴해준다.

    }
    class Program
    {
        static void Main(string[] args)
        {
            var list = new MyList();

            foreach(var item in list) 
            // 1. var item in list의 in에서 MyList 클래스내 GetEnumerator로 진입
            // 3. 선언된 하단 코드 실행 후 다시 foreach 제어부로 올라가 in을 만나면 이전 yield return문 다음으로 복귀.
            {
                Console.WriteLine(item);
            }
        }
    }
}

Output

1
2
3
4
5

• yield를 사용하면 IEnumerable, IEnumerator를 상속받는 클래스를 작성해 줄 필요 없다.
• IEnumerable 클래스에서 GetEnumerator() 메서드를 구현하는 한 방법으로 yield 를 사용할 수 있다. 즉, GetEnumerator() 메서드에서 yield return를 사용하여 컬렉션 데이타를 순차적으로 하나씩 넘겨주는 코드를 구현하고, 리턴타입으로 IEnumerator 인터페이스를 리턴할 수 있다.
• C#에서 Iterator 방식으로 yield 를 사용하면, 명시적으로 별도의 Enumerator 클래스를 작성할 필요가 없다. 컴파일러가 알아서 만들어주기 때문이다.

비동기적 실행이 가능

• yield return문을 만나면 함수를 호출한 곳에 리턴을 해준 후 다시 돌아와서 다음 yield return문을 실행한다. 즉, 하나의 함수를 모두 실행할 때까지 기다리는 것이 아니라 yield를 만나면 잠시 함수 중간에 빠져나와 호출한 곳에 리턴 값을 전달해주고 다시 돌아와 마저 함수를 진행하는 식으로 왔다 갔다 하며 실행되는 것이다.

• Enumerator : 데이터 요소를 하나씩 리턴하는 기능을 하는 것.

  • 위의 기능을 구현하기 위해서 C# 또는 .Net에서는 IEnumerator라는 인터페이스를 구현해야 한다.

• IEnumerator는 Current(속성), MoveNext()(메소드), Reset()(메소드) 3개의 멤버로 이루어져있다.

  • 따라서, Enumerator가 되기위해서는 Current(속성), MoveNext()(메소드)를 반드시 구현해줘야 한다.

• 컬렉션 클래스는 Enumeration이 가능한 클래스인데, 이러한 클래스들을 Enumerable클래스라고 한다.

  • 이 Enumerable 클래스는 IEnumerable 인터페이스를 구현해야한다.

• IEnumerable 인터페이스는 GetEnumerator()메소드 하나를 가지고 있다.

  • 이때 GetEnumerator()메소드는 IEnumerator를 구현한 객체를 리턴해준다.

• 컬렉션 타입이나 또는 Enumerable 클래스에서 GetEnumerator()메소드를 구현하는 방법으로 yield 키워드를 사용할 수 있다.

• GetEnumerator() 메소드에서 yield return을 사용하면 컬렉션 데이터를 순차적으로 하나씩 넘겨주는 코드를 구현할 수 있고, 리턴타입은 IEnumerator 인터페이스를 리턴할 수 있다.

yield를 사용하면 좋은 경우.

• 만약 데이타의 양이 커서 모든 데이터를 한번에 리턴하기 보다 조금씩 리턴하는 것이 더 효율적일 경우.
  • 예를 들어, 어떤 검색에서 1만 개의 자료가 존재하는데, UI에서 10개씩만 On Demand로 표시해 주는게 좋을 수도 있다. 즉, 사용자가 20개를 원할 지, 1000개를 원할 지 모르기 때문에, 일종의 지연 실행(Lazy Operation)을 수행하는 것이 나을 수 있다.

• 어떤 메서드가 무제한의 데이타를 리턴할 경우.
  • 예를 들어, 랜덤 숫자를 무제한 계속 리턴하는 함수는 결국 전체 리스트를 리턴할 수 없기 때문에 yield 를 사용해서 구현하게 된다.

• 모든 데이타를 미리 계산하면 속도가 느려서 그때 그때 On Demand로 처리하는 것이 좋은 경우.
  • 예를 들어 소수(Prime Number)를 계속 리턴하는 함수의 경우, 소수 전체를 구하면 (물론 무제한의 데이타를 리턴하는 경우이기도 하지만) 시간상 많은 계산 시간이 소요되므로 다음 소수만 리턴하는 함수를 만들어 소요 시간을 분산하는 지연 계산(Lazy Calculation)을 구현할 수 있다.

yield와 예외

yield return문은 try-catch 문 안에서 쓸 수 없다.
yield break문은 try-catch 문 안에선 쓸 수 있지만 finally 에선 쓸 수 없다.

최종 정리

• foreach문을 통해 순회하고 싶다면 해당 자료구조 타입(여기선 클래스?)이 GetEnumerator() 메소드를 포함해야한다.
  • 이때 GetEnumerator의 반환 타입은 IEnumerator()인데 이는 Current 와 MoveNext()를 포함하기 때문이다.
  • 즉, 사용자가 별도로 Current와 MoveNext()를 선언한 클래스가 있다면 해당 클래스타입을 사용하여 반환해도 된다.

Ex : 

public class Computer
{
    List<Device> _parts;

    public Computer()
    {
        _parts = new List<Device>()
        {
            new Device() { Name = "CPU"},
            new Device() { Name = "MotherBoard"},
        };
    }

    public Device[] GetDevices()
    {
        return _parts.ToArray();
    }

    public IEnumerator<Device> GetEnumerator()
    {
        foreach (var device in GetDevices())
        {
            yield return device;
        }
    }
}

//////////////////IEnumerator 타입 반환예시

public class Computer
{
    List<Device> _parts;

    public Computer()
    {
        _parts = new List<Device>()
        {
            new Device() { Name = "CPU"},
            new Device() { Name = "MotherBoard"},
        };
    }

    public Device[] GetDevices()
    {
        return _parts.ToArray();
    }

    public PartList GetEnumerator()
    {
        return new PartList(this);
    }

    public class PartList
    {
        Device [] _devices;
        public PartList(Computer computer) { _devices = computer.GetDevices(); }

        int _current = -1;

        public Device Current
        {
            get { return _devices[_current]; }
        }

        public bool MoveNext() 
        { 
            if (_current >= _devices.Length - 1)
            {
                return false;
            }

            _current++;
            return true;
        }
    }
}

////////////////////////사용자 정의 클래스 타입 반환예시

• 추가적으로 기존 정의된 IEnumerator 클래스와 IEnumerable 클래스를 상속받아도 된다!

[Reference] : https://www.sysnet.pe.kr/2/0/12403

=> IEnumerable, IEnumerator 내용 참고

[Reference] : https://ansohxxn.github.io/c%20sharp/enumerate/

=> yield & IEnumerable, IEnumerator 내용 참고