在UI线程上调用异步方法

时间:2018-11-27 21:08:52

标签: c# async-await .net-4.7

我正在尝试使用 IdentityServer 身份验证创建WPF客户端。我正在使用他们的OidcClient进行登录。当我的应用程序同步时,它是完全异步的,如果不付出巨大的努力就无法进行重构。打电话

var result = await _oidcClient.LoginAsync();

不等待结果。调用Wait().Result会导致死锁。将其包装到其他Task.Run时,抱怨该方法未在UI线程上运行(它会打开带有登录对话框的浏览器)。

您有什么想法,如何解决?我需要编写自定义同步OidcClient吗?

1 个答案:

答案 0 :(得分:4)

与其他需要在不进行大量重构的情况下将旧版应用引入异步的类似情况一样,我建议使用简单的“请稍候...”模式对话框。对话框启动一个异步操作,并在操作完成后自行关闭。

Window.ShowDialog是一种同步API,其阻塞主UI的方式仅在关闭模式对话框后才返回给调用者。但是,它仍然运行嵌套的消息循环并泵送消息。因此,与使用容易发生死锁的Task.Wait()相比,异步任务继续回调仍会被执行。

这是一个基本但完整的WPF示例,使用_oidcClient.LoginAsync()模拟Task.Delay()并在UI线程上执行它,有关详细信息,请参考WpfTaskExt.Execute

取消支持是可选的;如果无法取消实际的LoginAsync,则可以防止该对话框过早关闭。

using System;
using System.Threading;
using System.Threading.Tasks;
using System.Windows;
using System.Windows.Controls;

namespace WpfApp1
{
    public partial class MainWindow : Window
    {
        public MainWindow()
        {
            var button = new Button() { Content = "Login", Width = 100, Height = 20 };
            button.Click += HandleLogin;
            this.Content = button;
        }

        // simulate _oidcClient.LoginAsync
        static async Task<bool> LoginAsync(CancellationToken token)
        {
            await Task.Delay(5000, token);
            return true;
        }

        void HandleLogin(object sender, RoutedEventArgs e)
        {
            try
            {
                var result = WpfTaskExt.Execute(
                    taskFunc: token => LoginAsync(token),
                    createDialog: () =>
                        new Window
                        {
                            Owner = this,
                            Width = 320,
                            Height = 200,
                            WindowStartupLocation = WindowStartupLocation.CenterOwner,
                            Content = new TextBox
                            {
                                Text = "Loggin in, please wait... ",
                                HorizontalContentAlignment = HorizontalAlignment.Center,
                                VerticalContentAlignment = VerticalAlignment.Center
                            },
                            WindowStyle = WindowStyle.ToolWindow
                        },
                    token: CancellationToken.None);

                MessageBox.Show($"Success: {result}");
            }
            catch (Exception ex)
            {
                MessageBox.Show(ex.Message);
            }
        }
    }

    public static class WpfTaskExt
    {
        /// <summary>
        /// Execute an async func synchronously on a UI thread,
        /// on a modal dialog's nested message loop
        /// </summary>
        public static TResult Execute<TResult>(
            Func<CancellationToken, Task<TResult>> taskFunc,
            Func<Window> createDialog,
            CancellationToken token = default(CancellationToken))
        {
            var cts = CancellationTokenSource.CreateLinkedTokenSource(token);

            var dialog = createDialog();
            var canClose = false;
            Task<TResult> task = null;

            async Task<TResult> taskRunner()
            {
                try
                {
                    return await taskFunc(cts.Token);
                }
                finally
                {
                    canClose = true;
                    if (dialog.IsLoaded)
                    {
                        dialog.Close();
                    }
                }
            }

            dialog.Closing += (_, args) =>
            {
                if (!canClose)
                {
                    args.Cancel = true; // must stay open for now
                    cts.Cancel();
                }
            };

            dialog.Loaded += (_, __) =>
            {
                task = taskRunner();
            };

            dialog.ShowDialog();

            return task.GetAwaiter().GetResult();
        }
    }
}