안녕하세요. 이번 글에서는 C#의 yield return과 yield break에 대해 알아보겠습니다.
컬렉션을 돌려주는 메서드를 만들 때 보통은 List를 하나 만들어 값을 모두 채운 뒤 반환합니다. 그런데 데이터가 아주 많거나, 앞부분 몇 개만 쓰고 끝나는 경우라면 전부 만들어 두는 것은 낭비입니다. yield return을 쓰면 값을 필요할 때 하나씩 만들어 돌려주는 반복기(iterator) 메서드를 간단히 작성할 수 있습니다.
기본 사용법
반환 타입을 IEnumerable<T>(또는 IEnumerator<T>)로 선언하고, 값을 돌려줄 자리에 yield return 값;을 씁니다. 컬렉션을 따로 만들지 않아도 foreach로 순회할 수 있습니다.
using System;
using System.Collections.Generic;
class Program
{
// List를 만들어 반환하는 방식
static List<int> GetEvenList(int max)
{
var list = new List<int>();
for (int i = 0; i <= max; i += 2)
list.Add(i);
return list;
}
// yield return을 쓰는 방식
static IEnumerable<int> GetEven(int max)
{
for (int i = 0; i <= max; i += 2)
yield return i;
}
static void Main()
{
foreach (int n in GetEven(10))
Console.Write($"{n} "); // 0 2 4 6 8 10
}
}
두 메서드의 결과는 같지만, yield return 방식은 List를 만들지 않고 foreach가 다음 값을 요청할 때마다 하나씩 값을 만들어 냅니다. 컴파일러가 메서드를 상태를 기억하는 반복기 클래스로 바꿔 주기 때문에, 직접 IEnumerator를 구현할 필요가 없습니다.
실행 순서 : 지연 실행
반복기 메서드는 호출하는 순간 실행되지 않습니다. 실제로 값을 꺼낼 때(MoveNext 호출 시) 다음 yield return까지만 실행되고 멈춥니다. 이를 지연 실행(deferred execution)이라고 합니다.
static IEnumerable<string> GetItems()
{
Console.WriteLine(" [A 생성]");
yield return "A";
Console.WriteLine(" [B 생성]");
yield return "B";
Console.WriteLine(" [끝]");
}
static void Main()
{
var items = GetItems(); // 여기서는 아무것도 출력되지 않음
Console.WriteLine("순회 시작");
foreach (var item in items)
Console.WriteLine($"사용: {item}");
}
// 출력
// 순회 시작
// [A 생성]
// 사용: A
// [B 생성]
// 사용: B
// [끝]
값을 만드는 코드와 사용하는 코드가 번갈아 실행되는 것을 볼 수 있습니다. LINQ의 Where, Select가 지연 실행되는 것도 같은 원리입니다.
yield break : 순회 끝내기
yield break는 반복기를 그 자리에서 끝냅니다. 일반 메서드의 return과 비슷한 역할이며, 조건에 따라 더 이상 값을 내보내지 않을 때 사용합니다.
static IEnumerable<string> ReadUntilEnd(string[] lines)
{
foreach (var line in lines)
{
if (line == "END")
yield break; // 여기서 순회 종료
yield return line;
}
}
static void Main()
{
string[] lines = { "first", "second", "END", "ignored" };
foreach (var line in ReadUntilEnd(lines))
Console.WriteLine(line); // first, second
}
무한 시퀀스와 Take
값을 하나씩 만들기 때문에 끝이 없는 시퀀스도 표현할 수 있습니다. 사용하는 쪽에서 Take 등으로 필요한 만큼만 꺼내면 됩니다.
using System;
using System.Collections.Generic;
using System.Linq;
class Program
{
static IEnumerable<long> Fibonacci()
{
long a = 0, b = 1;
while (true)
{
yield return a;
(a, b) = (b, a + b);
}
}
static void Main()
{
foreach (var n in Fibonacci().Take(10))
Console.Write($"{n} "); // 0 1 1 2 3 5 8 13 21 34
}
}
while (true)이지만 Take(10)이 10개를 받은 뒤 순회를 멈추므로 무한 루프에 빠지지 않습니다. 단, Take 없이 ToList()나 Count()를 호출하면 끝나지 않으니 주의해야 합니다.
주의할 점
- 여러 번 순회하면 매번 처음부터 다시 실행됩니다. 계산 비용이 크거나 파일·DB를 읽는 반복기라면 ToList()로 한 번 받아 두고 재사용하는 편이 좋습니다.
- 인자 검사도 지연됩니다. 반복기 메서드 안에서 throw하는 ArgumentNullException은 호출 시점이 아니라 첫 순회 시점에 발생합니다. 즉시 검사가 필요하면 일반 메서드에서 인자를 검사한 뒤 내부의 반복기(로컬 함수 등)를 반환하는 형태로 나눕니다.
- 반복기 메서드에는 ref, out 매개변수를 쓸 수 없습니다.
- catch 절이 있는 try 블록 안이나 finally 블록 안에서는 yield return을 쓸 수 없습니다. (try-finally의 try 블록 안에서는 가능하며, foreach가 중간에 끝나도 Dispose 시점에 finally가 실행됩니다.)
- 비동기로 값을 하나씩 돌려주려면 IAsyncEnumerable<T>와 await foreach(C# 8.0 이상)를 사용합니다.
참고
이상으로 C# yield return과 yield break에 대해 간단히 알아보았습니다.