在UI线程上调用异步方法

Question

我正在尝试使用IdentityServer身份验证创建WPF客户端。我正在使用他们的OidcClient登录。当我的应用程序处于同步状态时，它是完全异步的，不付出巨大的努力就无法重构。调用

var result = await _oidcClient.LoginAsync();

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

你知道怎么解决这个问题吗？我需要编写自定义同步OidcClient吗？

Answer 1

与其他类似的情况一样，您需要在不进行太多重构的情况下将异步引入遗留应用程序，我建议使用简单的"请等待…"模式对话框。该对话框启动一个异步操作，并在操作完成后自行关闭。

Window.ShowDialog是一个同步的API，它阻止主UI，并且只有在模式对话框关闭时才返回给调用方。但是，它仍然运行嵌套的消息循环并泵送消息。因此，异步任务连续回调仍然会被泵送和执行，而不是使用容易死锁的Task.Wait()。

这里有一个基本但完整的WPF示例，用Task.Delay()模拟_oidcClient.LoginAsync()，并在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();
}
}
}