后台等待用户选择

Question

我正在编写软件的后端部分，有时我需要用户选择一些东西，这可能是一个复杂的过程，用户甚至可以随时取消选择。

从后端我想做一些类似的事情：

private async void StartAction()
{
    //some code
    var SelectedItem = await UI.RequestUserToChooseItem();
    // some final code using the selected item
}

这里我不知道如何处理取消，但我可以发送 null 并假设如果 SelectedItem 为 null 它被取消。

但是它的 UI 部分呢？当用户选择该事物时，如何处理以返回呼叫？

我需要在这里执行一些步骤：（这是伪代码，我什至不知道从哪里开始）

public List<Item> RequestUserToChooseItem()
{
    PrepareItemsInList();
    ShowSelectionPanel();
    List<Items> SelectedItemsFromPanel = WaitForUserToChose(); //???????
    return SelectedItemsFromPanel;

}

然后我们有取消按钮：

private void CancelButtonClicked(object sender, EventArgs e)
{
    CancelWaitedSelectionProcessAndReturnNull(); //????
}

Answer 1

您可以使用 TaskCompletionSource 来发出选择信号。类似于

private TaskCompletionSource<MyOptions> tcs;
public Task<MyOptions> ShowPanelAndWaitForSelection(){
    // show panel and do other initialization
    tcs = new TaskCompletionSource<MyOptions>();
    return  tcs.Task;
}
public void OnOptionSelection(MyOptions value) => tcs.SetResult(value);
public void OnCanceled() => tcs.SetCanceled();

当任务被取消时，任何等待者都会收到 OperationCanceledException，因此您的代码通常如下所示：

try{
    ...
    var selectedOption = await ShowPanelAndWaitForSelection();
    ...
}
catch(OperationCanceledException){
    // Handle cancellation
}
catch(Exception e){
   // Handle actual errors
}

这假设您的 UI 是非模式的，例如以相同的形式显示和隐藏面板。如果您为每个步骤使用模式对话框，则不需要任何异步代码。

这种风格本质上是使用编译器生成状态机，而不是手动编写这样的状态机。我认为这可能是处理特定情况的有用风格，因为您可以使用 if/while 等常规结构来制作决策树。但它可能并不总是积极的，并且可能会让不期望的开发人员绊倒。

Answer 2

下面是一个异步方法，它异步等待第一次单击一个或多个按钮，并返回单击的按钮：

public static Task<Button> OnClickAsync(params Button[] buttons)
{
    var tcs = new TaskCompletionSource<Button>();
    foreach (var button in buttons) button.Click += OnClick;
    return tcs.Task;

    void OnClick(object sender, RoutedEventArgs e)
    {
        foreach (var button in buttons) button.Click -= OnClick;
        tcs.SetResult((Button)sender);
    }
}

可以这样使用：

public async Task<List<Item>> RequestUserToChooseItemAsync()
{
    PrepareItemsInList();
    ShowSelectionPanel();
    var selectedButton = await OnClickAsync(btnOK, btnCancel);
    if (selectedButton == btnCancel) return null;
    return SelectedItemsFromPanel;
}

该方法应该在 UI 线程上独占调用，而不是在后台线程上调用，因为它会交互与 UI 元素。