C# - Task.Yield 사용법
Task.Yield가 기존의 스레드에서 제공하던 Yield와,
Thread.Yield 메서드
; https://learn.microsoft.com/ko-kr/dotnet/api/system.threading.thread.yield
유사하다고 생각해서 그동안 별 신경을 안 썼는데 우연히 아래의 글을 읽고,
When would I use Task.Yield()?
; https://stackoverflow.com/questions/22645024/when-would-i-use-task-yield
새롭게 봤습니다. ^^
제가 쓴 책을 보면 "10.2.4 Async 메서드가 아닌 경우의 비동기 처리" 절에서 "동기" 호출만 지원하는 메서드를 비동기로 제공하는 방법을 설명한 부분이 있습니다. 그게 Task.Yield의 기능을 설명하기 딱 좋은 사례일 듯합니다.
그러니까, File.ReadAllText와 같은 메서드의 경우 다음과 같이 동기 호출만 지원합니다.
static void OutputHOSTS()
{
string text = File.ReadAllText(@"C:\Windows\system32\drivers\etc\HOSTS");
WriteLog(text);
}
이 메서드를 비동기 호출로 변경하려면, 쉽게는 Task.Factory.StartNew의 힘을 빌려 다음과 같이 작성할 수 있습니다.
static async Task OutputHOSTSAsync()
{
string text = await ReadAllTextAsync();
WriteLog(text);
}
static Task<string> ReadAllTextAsync()
{
return Task.Factory.StartNew(
() => File.ReadAllText(@"C:\Windows\system32\drivers\etc\HOSTS")
);
}
그런데, 이것보다 더 쉬운 방법이 바로 Task.Yield를 쓰는 것입니다.
static async Task OutputHOSTSAsync()
{
string text = await ReadAllTextAsync2();
WriteLog(text);
}
static async Task<string> ReadAllTextAsync2()
{
await Task.Yield();
return File.ReadAllText(@"C:\Windows\system32\drivers\etc\HOSTS");
}
어차피 중요한 것은, 스레드 풀의 스레드로 작업 실행을 넘기는 것이므로, 마이크로소프트는 그 역할을 Task.Yield 메서드에 구현해 두었고 우리는 저런 상황에서 사용해 주면 되는 것입니다.
하지만, Task.Yield를 이용한 비동기 처리 방법은 SynchronizationContext가 마련된 환경에서는 효과가 없습니다. 왜냐하면 그 메서드가 SynchronizationContext를 고려하기 때문인데, "
When would I use Task.Yield()?" 글의 덧글을 보면 이에 대해 Task.Yield의 내부 동작은 다음과 동일하다는 설명이 나옵니다.
var tcs = new TaskCompletionSource<bool>();
var sc = SynchronizationContext.Current;
if (sc != null)
sc.Post(_ => tcs.SetResult(true), null);
else
ThreadPool.QueueUserWorkItem(_ => tcs.SetResult(true));
await tcs.Task;
따라서, Windows Forms/WPF 등의 UI 스레드 환경에서 Task.Yield를 호출하게 되면 이후의 코드는 UI 스레드에서 작업하게 되고, 대부분의 경우 그것은 Task.Yield의 호출 유무에 영향을 받지 않게 됩니다. 일례로, 해당 글의 덧글에서 Task.Yield가 SynchronizationContext를 인식함으로 차이가 있다는 예제 코드를 자세히 보면,
// 개인적으로, 해당 질문/답변 글의 문맥에서 봤을 때 이 예제는 잘못된 답변이라고 봅니다.
private async void button_Click(object sender, EventArgs e)
{
await Task.Yield(); // Make us async right away
var data = ExecuteFooOnUIThread(); // This will run on the UI thread at some point later
await UseDataAsync();
}
Task UseDataAsync()
{
return Task.Factory.StartNew(() => {
Debug.WriteLine("TEST"); });
}
어차피 Task.Yield가 없어도 - button_Click 이벤트의 실행 자체가 UI 스레드에서 실행되므로 ExecuteFooOnUIThread 메서드에 대해 Task.Yield의 호출이 있을 필요가 없습니다. 반면, 다음과 같이 스레드 풀의 스레드가 await 이후의 코드를 실행하는 환경에서는,
private async void button_Click(object sender, EventArgs e)
{
await UseDataAsync().ConfigureAwait(false); // 이후의 코드는 SynchronizationContext.Current == null인 스레드 풀의 스레드에서 실행되므로,
await Task.Yield(); // Task.Yield 내부에서는 어차피 UI 스레드로 되돌릴 수도 없어,
var data = ExecuteFooOnUIThread(); // 이 코드는 스레드 풀의 스레드에서 실행
}
Task.Yield는 이후의 코드를 UI 스레드에서 실행할 수 없으므로 마찬가지로 호출 여부가 크게 의미가 없습니다. 결국 SynchronizationContext.Current가 설정된 환경에서는 Task.Yield를 사용할 이유가 없는 것입니다. 실제로, 이 글의 처음 예제에서 만들어 둔 ReadAllTextAsync2 코드를 button_Click 이벤트에서 실행해 보면,
private async void button_Click(object sender, EventArgs e)
{
string text = await ReadAllTextAsync2();
}
static async Task ReadAllTextAsync2()
{
await Task.Yield();
return File.ReadAllText(@"C:\Windows\system32\drivers\etc\HOSTS");
}
button_Click 및 ReadAllTextAsync2의 호출은 UI 스레드에서 진행되고, Task.Yield는 SynchronizationContext.Current를 고려하므로 마찬가지로 그 이후의 File.ReadAllText 역시 UI 스레드에서 진행되어 비동기 호출이라는 장점이 없어집니다.
개발자가 이런 사실을 적절히 잘 이해한다면, 특정 환경의 경우 Task.Yield는 기존 코드에서 스레드를 사용하던 부분에 대한 코드를 간단하게 만드는 용도라고 이해하는 것도 나쁘진 않습니다.
예를 들어 볼까요? 간혹 TCP 서버를 만들면서 접속한 클라이언트에 대해 하나의 스레드를 할당해 처리를 하는 경우가 있습니다.
using System;
using System.Net;
using System.Net.Sockets;
using System.Threading;
namespace TCPServer
{
class Program
{
static void Main(string[] args)
{
using (Socket srvSocket = new Socket(AddressFamily.InterNetwork,
SocketType.Stream, ProtocolType.Tcp))
{
IPEndPoint endPoint = new IPEndPoint(IPAddress.Any, 11200);
srvSocket.Bind(endPoint);
srvSocket.Listen(10);
while (true)
{
Socket clntSocket = srvSocket.Accept();
Thread t = new Thread(processClientSocket);
t.IsBackground = true;
t.Start(clntSocket);
}
}
}
private static void processClientSocket(object objSock)
{
Socket clntSocket = objSock as Socket;
// ... 다른 스레드에서 실행 ...
Console.WriteLine("new client");
clntSocket.Close();
}
}
}
이럴 때, Task.Yield를 사용해 기존 코드를 대체할 수 있습니다.
using System;
using System.Net;
using System.Net.Sockets;
using System.Threading;
using System.Threading.Tasks;
namespace TCPServer
{
class Program
{
static async Task Main(string[] args)
{
using (Socket srvSocket = new Socket(AddressFamily.InterNetwork,
SocketType.Stream, ProtocolType.Tcp))
{
IPEndPoint endPoint = new IPEndPoint(IPAddress.Any, 11200);
srvSocket.Bind(endPoint);
srvSocket.Listen(10);
while (true)
{
Socket clntSocket = srvSocket.Accept();
/* await */ processClientSocketAsync(clntSocket);
}
}
}
static async Task processClientSocketAsync(Socket clntSocket)
{
await Task.Yield();
// ... 다른 스레드에서 실행 ...
Console.WriteLine("new client");
clntSocket.Close();
}
}
}
그러니까, 일정 부분 이후의 기존 코드를 별도의 스레드에서 실행하기를 원한다면 Task.Yield로 간단하게 대체해 줄 수 있는 것입니다. (물론, SynchronizationContext가 구성된 환경에서는 단일 스레드로 동작하게 됩니다.)
이 정도면, Task.Yield에 대한 느낌이 대충 오시나요? ^^
(
첨부 파일은 이 글의 예제 코드를 포함합니다.)
[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]