WinForm과 WPF MessageBox.Show 메서드의 동작 차이

rkttu · 7월 18, 2023, 8:43오전

사소하지만, 큰 차이를 우연히 하나 발견하게 되었습니다.

최근에 릴리즈한 식탁보 0.5.7 버전에서 이런 버그 제보가 이슈로 등록되었었는데요,

github.com/yourtablecloth/TableCloth

[버그] 응용프로그램 실행 불가

열림 08:22AM - 15 Jul 23 UTC

닫힘 01:38PM - 17 Jul 23 UTC

yottacho

bug

**버그에 대한 설명** 0.5.5에서 0.5.7로 업데이트 이후 프로그램 실행이 안 됩니다. - 시작 메뉴의 식탁보 아이콘을 클릭하면 …마우스 커서가 잠시 모래시계로 변경되었다가 원래 커서로 돌아오며 프로그램 메인 화면이 열리지 않습니다. - 작업관리자의 프로세스 및 자세히 탭에서 식탁보 또는 TableCloth.exe 를 찾을 수 없습니다. **재현 방법** 1. 시작 메뉴의 모든 앱 항목에서 식탁보 아이콘을 클릭합니다. **기대하는 동작** 응용 프로그램이 실행되면서 메인 화면이 표시되어야 합니다. **동영상 또는 스크린샷** N/A - 응용 프로그램의 메인 화면이 표시되지 않고 종료됩니다. **시스템 사양** - OS: Windows 11 Pro 22H2 (22621.1992) - CPU 아키텍처: amd64 - 브라우저: Edge - 소프트웨어 릴리스 버전: 0.5.7 **참고 사항** 이벤트 뷰어에서 아래와 같은 로그를 발견했습니다. 윈도우 프로그램에 대해 알지는 못하지만, 아마도 App.xaml.cs 의 Application_Startup에서 messageBox.DisplayError 를 호출하는데 해당 시점에 App.Current.MainWindow 가 생성되지 않아서 null 을 넘겨서 발생하는 것으로 생각됩니다. (Null 은 다른 언어에서도 언제나 골치 아픈 이슈지요! ) ``` Application: TableCloth.exe CoreCLR Version: 6.0.2023.32017 .NET Version: 6.0.20 Description: The process was terminated due to an unhandled exception. Exception Info: System.Reflection.TargetInvocationException: Exception has been thrown by the target of an invocation. ---> System.ArgumentNullException: Value cannot be null. (Parameter 'window') at System.Windows.Interop.WindowInteropHelper..ctor(Window window) at System.Windows.MessageBox.Show(Window owner, String messageBoxText, String caption, MessageBoxButton button, MessageBoxImage icon, MessageBoxResult defaultResult) at TableCloth.Components.AppMessageBox.<>c.<DisplayError>b__2_0(String message, Boolean isCritical) in D:\a\TableCloth\TableCloth\src\TableCloth\Components\AppMessageBox.cs:line 61 --- End of inner exception stack trace --- at System.RuntimeMethodHandle.InvokeMethod(Object target, Span`1& arguments, Signature sig, Boolean constructor, Boolean wrapExceptions) at System.Reflection.RuntimeMethodInfo.Invoke(Object obj, BindingFlags invokeAttr, Binder binder, Object[] parameters, CultureInfo culture) at System.Delegate.DynamicInvokeImpl(Object[] args) at System.Delegate.DynamicInvoke(Object[] args) at System.Windows.Threading.ExceptionWrapper.InternalRealCall(Delegate callback, Object args, Int32 numArgs) at System.Windows.Threading.ExceptionWrapper.TryCatchWhen(Object source, Delegate callback, Object args, Int32 numArgs, Delegate catchHandler) at System.Windows.Threading.DispatcherOperation.InvokeImpl() at System.Windows.Threading.DispatcherOperation.InvokeInSecurityContext(Object state) at MS.Internal.CulturePreservingExecutionContext.CallbackWrapper(Object obj) at System.Threading.ExecutionContext.RunInternal(ExecutionContext executionContext, ContextCallback callback, Object state) --- End of stack trace from previous location --- at System.Threading.ExecutionContext.RunInternal(ExecutionContext executionContext, ContextCallback callback, Object state) at System.Threading.ExecutionContext.Run(ExecutionContext executionContext, ContextCallback callback, Object state) at MS.Internal.CulturePreservingExecutionContext.Run(CulturePreservingExecutionContext executionContext, ContextCallback callback, Object state) at System.Windows.Threading.DispatcherOperation.Invoke() at System.Windows.Threading.Dispatcher.ProcessQueue() at System.Windows.Threading.Dispatcher.WndProcHook(IntPtr hwnd, Int32 msg, IntPtr wParam, IntPtr lParam, Boolean& handled) at MS.Win32.HwndWrapper.WndProc(IntPtr hwnd, Int32 msg, IntPtr wParam, IntPtr lParam, Boolean& handled) at MS.Win32.HwndSubclass.DispatcherCallbackOperation(Object o) at System.Windows.Threading.ExceptionWrapper.InternalRealCall(Delegate callback, Object args, Int32 numArgs) at System.Windows.Threading.ExceptionWrapper.TryCatchWhen(Object source, Delegate callback, Object args, Int32 numArgs, Delegate catchHandler) at System.Windows.Threading.Dispatcher.LegacyInvokeImpl(DispatcherPriority priority, TimeSpan timeout, Delegate method, Object args, Int32 numArgs) at MS.Win32.HwndSubclass.SubclassWndProc(IntPtr hwnd, Int32 msg, IntPtr wParam, IntPtr lParam) at MS.Win32.UnsafeNativeMethods.DispatchMessage(MSG& msg) at System.Windows.Threading.Dispatcher.PushFrameImpl(DispatcherFrame frame) at System.Windows.Threading.Dispatcher.PushFrame(DispatcherFrame frame) at System.Windows.Threading.DispatcherOperation.Wait(TimeSpan timeout) at System.Windows.Threading.Dispatcher.InvokeImpl(DispatcherOperation operation, CancellationToken cancellationToken, TimeSpan timeout) at System.Windows.Threading.Dispatcher.LegacyInvokeImpl(DispatcherPriority priority, TimeSpan timeout, Delegate method, Object args, Int32 numArgs) at System.Windows.Threading.Dispatcher.Invoke(Delegate method, Object[] args) at TableCloth.Components.AppMessageBox.DisplayError(String message, Boolean isCritical) in D:\a\TableCloth\TableCloth\src\TableCloth\Components\AppMessageBox.cs:line 58 at TableCloth.App.Application_Startup(Object sender, StartupEventArgs e) in D:\a\TableCloth\TableCloth\src\TableCloth\App.xaml.cs:line 56 at System.Windows.Application.OnStartup(StartupEventArgs e) at System.Windows.Application.<.ctor>b__1_0(Object unused) at System.Windows.Threading.ExceptionWrapper.InternalRealCall(Delegate callback, Object args, Int32 numArgs) at System.Windows.Threading.ExceptionWrapper.TryCatchWhen(Object source, Delegate callback, Object args, Int32 numArgs, Delegate catchHandler) at System.Windows.Threading.DispatcherOperation.InvokeImpl() at System.Windows.Threading.DispatcherOperation.InvokeInSecurityContext(Object state) at MS.Internal.CulturePreservingExecutionContext.CallbackWrapper(Object obj) at System.Threading.ExecutionContext.RunInternal(ExecutionContext executionContext, ContextCallback callback, Object state) --- End of stack trace from previous location --- at System.Threading.ExecutionContext.RunInternal(ExecutionContext executionContext, ContextCallback callback, Object state) at System.Threading.ExecutionContext.Run(ExecutionContext executionContext, ContextCallback callback, Object state) at MS.Internal.CulturePreservingExecutionContext.Run(CulturePreservingExecutionContext executionContext, ContextCallback callback, Object state) at System.Windows.Threading.DispatcherOperation.Invoke() at System.Windows.Threading.Dispatcher.ProcessQueue() at System.Windows.Threading.Dispatcher.WndProcHook(IntPtr hwnd, Int32 msg, IntPtr wParam, IntPtr lParam, Boolean& handled) at MS.Win32.HwndWrapper.WndProc(IntPtr hwnd, Int32 msg, IntPtr wParam, IntPtr lParam, Boolean& handled) at MS.Win32.HwndSubclass.DispatcherCallbackOperation(Object o) at System.Windows.Threading.ExceptionWrapper.InternalRealCall(Delegate callback, Object args, Int32 numArgs) at System.Windows.Threading.ExceptionWrapper.TryCatchWhen(Object source, Delegate callback, Object args, Int32 numArgs, Delegate catchHandler) at System.Windows.Threading.Dispatcher.LegacyInvokeImpl(DispatcherPriority priority, TimeSpan timeout, Delegate method, Object args, Int32 numArgs) at MS.Win32.HwndSubclass.SubclassWndProc(IntPtr hwnd, Int32 msg, IntPtr wParam, IntPtr lParam) at MS.Win32.UnsafeNativeMethods.DispatchMessage(MSG& msg) at System.Windows.Threading.Dispatcher.PushFrameImpl(DispatcherFrame frame) at System.Windows.Threading.Dispatcher.PushFrame(DispatcherFrame frame) at System.Windows.Threading.Dispatcher.Run() at System.Windows.Application.RunDispatcher(Object ignore) at System.Windows.Application.RunInternal(Window window) at System.Windows.Application.Run() at TableCloth.App.Main() ```

자세히 살펴보니 MessageBox.Show 메서드의 동작이 WinForm과 WPF가 서로 달랐습니다. 구체적으로, 양쪽 모두 부모 윈도우 핸들을 지정하는 파라미터가 있는데, WinForm의 경우 여기에 null 레퍼런스를 지정하더라도 연결된 부모 윈도우 핸들이 없는 메시지 박스를 띄우도록 동작하지만, WPF의 경우는 그렇지 않았습니다.

내부 코드 구현을 살펴보니 그 이유가 잘 보였습니다.

https://referencesource.microsoft.com/#PresentationFramework/src/Framework/System/Windows/MessageBox.cs,b0b05e2016dddf55

부모 윈도우를 지정하는 부분에서 null 참조를 대입하면,

https://referencesource.microsoft.com/#PresentationFramework/src/Framework/System/Windows/Interop/WindowInteropHelper.cs,fdbf322c4b24b279

위의 코드와 같이 예외를 발생시킵니다.

https://referencesource.microsoft.com/#PresentationFramework/src/Framework/System/Windows/MessageBox.cs,61ad43de2de82769,references

반면에 부모 윈도우 핸들 파라미터를 지정하지 않는 부분에서는 처음부터 IntPtr.Zero 핸들을 지정하도록 되어있어서 NPE를 만나지 않습니다.

https://referencesource.microsoft.com/#System.Windows.Forms/winforms/Managed/System/WinForms/MessageBox.cs,456

Windows Forms의 경우 부모 윈도우가 null 참조나 IntPtr.Zero로 지정되더라도, 위의 코드와 같이 GetActiveWindow API를 이용하여 대체 핸들을 찾는 동작이 있었습니다.

혹시나 싶어서 찾아봤는데, 이 부분에 대한 Exception 발생이 될 수 있다는 내용은 찾지 못했습니다.

이와 같이 잘 동작할 것이라고 믿었던 코드가 안될 때 당황할 수 있고, 그 떄문에 불필요하게 방어적인 코드를 넣게 될수도 있습니다. 이런 경우 레퍼런스 소스 코드를 둘러보면서 정확한 차이점을 파악하여 문제를 진단하고 해결할 수 있습니다.

평소에 동작하지 않는 코드 때문에 씨름하고 계시다면, 이와 같이 분석을 시도해보면서 방법을 찾아보시면 어떨까 싶습니다!

kevin13 · 7월 19, 2023, 1:55오전

예전에 oldnewthing의 대화창 관련한 글이 생각나는데요, ^^

Windows: 238. Win32 - Modal UI 창에 올바른 Owner(HWND)를 설정해야 하는 이유 (sysnet.pe.kr)

그 글의 원문 2개(Modality, part 4: The importance of setting the correct owner for modal UI - The Old New Thing, Modality, part 5: Setting the correct owner for modal UI - The Old New Thing)을 보면 Modal 대화창의 owner를 null로 설정하면 의도치 않은 버그가 발생할 수 있다는 글이 나옵니다.

아마도 (순전히 가정입니다.) Windows Forms의 경우에는 fallback 차원에서 그런 코드를 작성한 듯하고, WPF의 경우에는 (당시) 새로 나온 프레임워크이니 아예 그것을 막은 것이 아닌가 추측만 해봅니다.

어쨌든, (MessageBox와 같은) modal 대화창에 null 부모를 지정하는 것은 권장하지 않는다고 합니다.

rkttu · 7월 19, 2023, 2:10오전

그렇군요. WinForm의 경우 부모 지정을 안하고 불렀거나, 부모 지정을 null로 불러도 결국은 GetActiveWindow() API를 불러서 결손된 부분을 메웠더군요.

WPF는 깊이 들어가보진 않았지만, 부모 지정을 안하고 부르는 API는 정작 IntPtr.Zero 포인터를 던졌고, 부모 지정을 하는 파라미터에서는 null check를 직접 하지 않고 뒤늦게 내부 코드에서 NPE를 던지는 식이었는데, 심지어 이 마저도 docs에는 그런 예외가 생길 수 있다는 내용이 보이지 않아서 관성대로 썼다가 예상하지 못한 곳에서 만난 오류가 된 것 같습니다. ㅎㅎ

말씀해주신대로 이제는 그렇게 코드 동작이 굳어버리기도 했고, 또 부모를 null 참조로 지정하지 않도록 맞추는게 best practice긴 하지만, 문서화 부재가 조금 아쉽다는 생각이 들었습니다.