Microsoft MVP성태의 닷넷 이야기
글쓴 사람
정성태 (techsharer at outlook.com)
홈페이지
첨부 파일

비동기 메서드 내에서 await 시 ConfigureAwait 호출 의미

async/await에 대한 내용(1, 2, 3)도 거의 정리가 되었으니 ^^ 이제 지난 글에서 소개한,

Async/Await - Best Practices in Asynchronous Programming
; https://docs.microsoft.com/en-us/archive/msdn-magazine/2013/march/async-await-best-practices-in-asynchronous-programming

async 메서드의 void 반환 타입 사용에 대하여
; https://www.sysnet.pe.kr/2/0/11414

다음의 의미를 파헤쳐 보겠습니다.

Use ConfigureAwait(false) when you can (예외인 경우: Methods that require con­text)

여기서 말하는 context란, SynchronizationContext를 의미합니다. 따라서 SynchronizationContext가 제공되지 않는 Console 응용 프로그램의 경우에는 ConfigureAwait 사용 유무에 따른 차이가 없습니다. 가령 다음의 프로그램은 ConfigureAwait에 true/false를 주는 것에 상관없이 출력이 동일합니다.

using System;
using System.Threading;
using System.Threading.Tasks;

namespace ConsoleApp1
{
    class Program
    {
        static bool captureContext = true;

        // C# 7.1 async Main
        static async Task Main(string[] args)
        {
            // 이 코드는 닷넷 프레임워크 환경에서 테스트한 것입니다. (참고: 닷넷 런타임에 따라 달라지는 AppDomain.GetCurrentThreadId의 반환값)
            Console.WriteLine(AppDomain.GetCurrentThreadId() + " Main start");
            await AsyncMethod1().ConfigureAwait(captureContext);
            Console.WriteLine(AppDomain.GetCurrentThreadId() + " Main end");
        }

        private static async Task AsyncMethod1()
        {
            Console.WriteLine(AppDomain.GetCurrentThreadId() + " AsyncMethod1 start");
            await AsyncMethod2().ConfigureAwait(captureContext);
            Console.WriteLine(AppDomain.GetCurrentThreadId() + " AsyncMethod1 end");
        }

        private static async Task AsyncMethod2()
        {
            Console.WriteLine(AppDomain.GetCurrentThreadId() + " AsyncMethod2 start");
            await Task.Factory.StartNew(() => { Console.WriteLine("Task Thread: " + AppDomain.GetCurrentThreadId());   Thread.Sleep(5000); }).ConfigureAwait(captureContext);
            Console.WriteLine(AppDomain.GetCurrentThreadId() + " AsyncMethod2 end");
        }
    }
}

/*
출력 결과:

20704 Main start
20704 AsyncMethod1 start
20704 AsyncMethod2 start
Task Thread: 27852
27852 AsyncMethod2 end
27852 AsyncMethod1 end
27852 Main end
*/

그런데, 정작 ConfigureAwait이 어떤 의미인지 말하지 않았군요. ^^ 이 메서드는 인자 값을 true로 실행하면 현재 스레드의 SynchronizationContext를 인지해 이후 실행해야 할 코드를 ThreadPool이 아닌, SynchronizationContext의 스레드에 태워 실행합니다. 따라서 이 차이점을 체험하려면 윈도우 폼/WPF/ASP.NET과 같은 응용 프로그램에서 테스트해야 합니다.

이를 위해 다음과 같이 간단하게 Windows Form로 코드 작성을 한 후,

using System;
using System.Diagnostics;
using System.Threading;
using System.Threading.Tasks;
using System.Windows.Forms;

namespace WindowsFormsApp1
{
    public partial class Form1 : Form
    {
        public Form1()
        {
            InitializeComponent();
        }

        bool captureContext = true;

        private async void Form1_Load(object sender, EventArgs e)
        {
            Console.WriteLine(AppDomain.GetCurrentThreadId() + " Main start");
            await AsyncMethod1().ConfigureAwait(captureContext);
            Trace.WriteLine(AppDomain.GetCurrentThreadId() + " Main end");
        }

        async Task AsyncMethod1()
        {
            Console.WriteLine(AppDomain.GetCurrentThreadId() + " AsyncMethod1 start");
            await AsyncMethod2().ConfigureAwait(captureContext);
            Trace.WriteLine(AppDomain.GetCurrentThreadId() + " AsyncMethod1 end");
        }

        async Task AsyncMethod2()
        {
            Console.WriteLine(AppDomain.GetCurrentThreadId() + " AsyncMethod2 start");
            await Task.Factory.StartNew(() => { Trace.WriteLine("Task Thread: " + AppDomain.GetCurrentThreadId()); Thread.Sleep(5000); }).ConfigureAwait(captureContext);
            Trace.WriteLine(AppDomain.GetCurrentThreadId() + " AsyncMethod2 end");
        }
    }
}

실행하면, await 이후의 비동기 코드들이 모두 UI 스레드에서 실행된 것을 확인할 수 있습니다.

30040 Main start
30040 AsyncMethod1 start
30040 AsyncMethod2 start
Task Thread: 45800
30040 AsyncMethod2 end
30040 AsyncMethod1 end
30040 Main end

하지만 굳이 ConfigureAwait(true)를 지정할 필요는 없습니다. 왜냐하면 await의 기본 동작이 SynchronizationContext를 인지하도록 되어 있기 때문입니다.

반면, ConfigureAwait에 false를 설정하면 await 이후의 코드를 SynchronizationContext에 태우지 않고 Task.StartNew로 생성되었던 그 Task의 스레드를 이용해 실행하므로 결과가 다음과 같이 나옵니다. (콘솔 응용 프로그램에서의 동작과 같습니다.)

26892 Main start
26892 AsyncMethod1 start
26892 AsyncMethod2 start
Task Thread: 4176
4176 AsyncMethod2 end
4176 AsyncMethod1 end
4176 Main end

따라서, SynchronizationContext가 있는 상황에서 await 호출을 하는 경우, UI 객체를 건드리는 작업이 없다면 굳이 SynchronizationContext에 태울 필요가 없으므로 그런 경우에는 가능한 개발자가 ConfigureAwait(false)를 설정해 주는 것이 성능상 더 유리합니다. 이를 염두에 두고 "Async/Await - Best Practices in Asynchronous Programming" 글의 권고 사항이었던 다음의 문장을 다시 읽어 보면 의미가 파악될 것입니다.

Use ConfigureAwait(false) when you can (예외 조항: Methods that require con­text)

참고로, ConfigureAwait은 Task 타입과 TaskAwaiter 타입에서 구현된 기능이므로 엄밀히 async/await과는 독립적으로 바라봐야 합니다.

(첨부 파일은 이 글의 예제 코드를 포함합니다.)




그런데, 이상하군요. 예전에 제가 쓴 글을 보면,

async/await 사용 시 hang 문제가 발생하는 경우
; https://www.sysnet.pe.kr/2/0/1541


ConfigureAwait을 false로 했는데도 hang 현상이 발생하는 경우가 있습니다. 그 이유는, 다음번 글에서 밝힙니다. ^^




[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]

[연관 글]






[최초 등록일: ]
[최종 수정일: 4/7/2022]

Creative Commons License
이 저작물은 크리에이티브 커먼즈 코리아 저작자표시-비영리-변경금지 2.0 대한민국 라이센스에 따라 이용하실 수 있습니다.
by SeongTae Jeong, mailto:techsharer at outlook.com

비밀번호

댓글 작성자
 



2021-01-20 12시58분
[저예요~~] 글 잘봤습니다. (이제야... ^^;)
[손님]
2022-07-29 08시01분
[gwise] 한줄 정리하면 await가 UI를 건드리지 않는다면 ConfigureAwait(false) 이렇게 하는게 좋다." 감사합니다.
[손님]

[1]  2  3  4  5  6  7  8  9  10  11  12  13  14  15  ...
NoWriterDateCnt.TitleFile(s)
13129정성태9/27/202225.NET Framework: 2050. .NET Core를 IIS에서 호스팅하는 경우 .NET Framework CLR이 함께 로드되는 환경
13128정성태9/23/202285C/C++: 158. Visual C++ - IDL 구문 중 "unsigned long"을 인식하지 못하는 #import파일 다운로드1
13127정성태9/22/2022118Windows: 210. WSL에 systemd 도입
13126정성태9/15/2022453.NET Framework: 2049. C# 11 - 정적 메서드에 대한 delegate 처리 시 cache 적용
13125정성태9/14/2022515.NET Framework: 2048. C# 11 - 구조체 필드의 자동 초기화(auto-default structs)
13124정성태9/13/2022351.NET Framework: 2047. Golang, Python, C#에서의 CRC32 사용
13123정성태9/8/2022573.NET Framework: 2046. C# 11 - 멤버(속성/필드)에 지정할 수 있는 required 예약어 추가
13122정성태8/26/2022694.NET Framework: 2045. C# 11 - 메서드 매개 변수에 대한 nameof 지원
13121정성태8/23/2022532C/C++: 157. Golang - 구조체의 slice 필드를 Reflection을 이용해 변경하는 방법
13120정성태8/19/2022564Windows: 209. Windows NT Service에서 UI를 다루는 방법
13119정성태8/18/2022613.NET Framework: 2044. .NET Core/5+ 프로젝트에서 참조 DLL이 보관된 공통 디렉터리를 지정하는 방법
13118정성태8/18/2022595.NET Framework: 2043. WPF Color의 기본 색 영역은 (sRGB가 아닌) scRGB [2]
13117정성태8/17/2022696.NET Framework: 2042. C# 11 - 파일 범위 내에서 유효한 타입 정의 (File-local types)파일 다운로드1
13116정성태8/4/2022752.NET Framework: 2041. C# - Socket.Close 시 Socket.Receive 메서드에서 예외가 발생하는 문제파일 다운로드1
13115정성태8/3/20221000.NET Framework: 2040. C# - ValueTask와 Task의 성능 비교 [1]파일 다운로드1
13114정성태8/2/2022884.NET Framework: 2039. C# - Task와 비교해 본 ValueTask 사용법파일 다운로드1
13113정성태7/31/2022814.NET Framework: 2038. C# 11 - Span 타입에 대한 패턴 매칭 (Pattern matching on ReadOnlySpan<char>)
13112정성태7/30/2022903.NET Framework: 2037. C# 11 - 목록 패턴(List patterns) [1]파일 다운로드1
13111정성태7/29/2022835.NET Framework: 2036. C# 11 - IntPtr/UIntPtr과 nint/nuint의 통합파일 다운로드1
13110정성태7/27/2022948.NET Framework: 2035. C# 11 - 새로운 연산자 ">>>" (Unsigned Right Shift)파일 다운로드1
13109정성태7/27/2022760VS.NET IDE: 177. 비주얼 스튜디오 2022를 이용한 (소스 코드가 없는) 닷넷 모듈 디버깅 - "외부 원본(External Sources)"
13108정성태7/26/2022693Linux: 53. container에 실행 중인 Golang 프로세스를 디버깅하는 방법
13107정성태7/25/2022682Linux: 52. Debian/Ubuntu 계열의 docker container에서 자주 설치하게 되는 명령어
13106정성태7/24/2022573오류 유형: 819. 닷넷 6 프로젝트의 "Conditional compilation symbols" 기본값 오류
13105정성태7/23/2022789.NET Framework: 2034. .NET Core/5+ 환경에서 (프로젝트가 아닌) C# 코드 파일을 입력으로 컴파일하는 방법 - 두 번째 이야기 [1]
[1]  2  3  4  5  6  7  8  9  10  11  12  13  14  15  ...