等待FormClosing事件中的异步函数

时间:2013-05-20 19:03:17

标签: c# .net-4.5 async-await formclosing

我遇到了一个问题,我无法等待FormClosing事件中的异步函数,这将决定表单关闭是否应该继续。我创建了一个简单的示例,如果您关闭而不保存,则会提示您保存未保存的更改(非常类似于记事本或微软词)。我遇到的问题是当我等待异步保存功能时,它会在保存功能完成之前关闭表单,然后在完成后返回结束功能并尝试继续。我唯一的解决方案是在调用SaveAsync之前取消关闭事件,然后如果保存成功,它将调用form.Close()函数。我希望有一种更清洁的方法来处理这种情况。

要复制方案,请创建一个带有文本框(txtValue),复选框(cbFail)和按钮(btnSave)的表单。这是表单的代码。

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Windows.Forms;

namespace TestZ
{
public partial class Form1 : Form
{

    string cleanValue = "";

    public Form1()
    {
        InitializeComponent();
    }

    public bool HasChanges()
    {
        return (txtValue.Text != cleanValue);
    }

    public void ResetChangeState()
    {
        cleanValue = txtValue.Text;
    }

    private async void btnSave_Click(object sender, EventArgs e)
    {
        //Save without immediate concern of the result
        await SaveAsync();
    }

    private async Task<bool> SaveAsync()
    {
        this.Cursor = Cursors.WaitCursor; 
        btnSave.Enabled = false;
        txtValue.Enabled = false;
        cbFail.Enabled = false;

        Task<bool> work = Task<bool>.Factory.StartNew(() =>
        {
            //Work to do on a background thread
            System.Threading.Thread.Sleep(3000); //Pretend to work hard.

            if (cbFail.Checked)
            {
                MessageBox.Show("Save Failed.");
                return false;
            }
            else
            {
                //The value is saved into the database, mark current form state as "clean"
                MessageBox.Show("Save Succeeded.");
                ResetChangeState();
                return true;
            }
        });

        bool retval = await work;

        btnSave.Enabled = true;
        txtValue.Enabled = true;
        cbFail.Enabled = true;
        this.Cursor = Cursors.Default;

        return retval;            
    }


    private async void Form1_FormClosing(object sender, FormClosingEventArgs e)
    {
        if (HasChanges())
        {
            DialogResult result = MessageBox.Show("There are unsaved changes. Do you want to save before closing?", "Unsaved Changes", MessageBoxButtons.YesNoCancel, MessageBoxIcon.Question);
            if (result == System.Windows.Forms.DialogResult.Yes)
            {
                //This is how I want to handle it - But it closes the form while it should be waiting for the Save() to complete.
                //bool SaveSuccessful = await Save();
                //if (!SaveSuccessful)
                //{
                //    e.Cancel = true;
                //}

                //This is how I have to handle it:
                e.Cancel = true; 
                bool SaveSuccessful = await SaveAsync();                    
                if (SaveSuccessful)
                {
                    this.Close();
                }
            }
            else if (result == System.Windows.Forms.DialogResult.Cancel)
            {
                e.Cancel = true;
            }

            //If they hit "No", just close the form.
        }
    }

}
}
  

编辑05/23/2013

     

人们会问我为什么会这样做,这是可以理解的   做这个。我们库中的数据类通常会保存,   加载,新建,删除旨在异步运行的函数   (请参阅SaveAsync作为示例)。我实际上并不那么关心   特别是在FormClosing事件中异步运行该函数。但如果   用户想要在关闭表单之前保存,我需要它等待   看看保存是否成功。如果保存失败,那么我想要它   取消表格结束活动。我只是想找到最干净的方式   处理这个。

6 个答案:

答案 0 :(得分:32)

在我看来,最好的答案是取消表格。总是。取消它,根据需要显示对话框,一旦用户完成对话框,以编程方式关闭表单。

这就是我的所作所为:

async void Window_Closing(object sender, CancelEventArgs args)
{
    var w = (Window)sender;
    var h = (ObjectViewModelHost)w.Content;
    var v = h.ViewModel;

    if (v != null &&
        v.IsDirty)
    {
        args.Cancel = true;
        w.IsEnabled = false;

        // caller returns and window stays open
        await Task.Yield();

        var c = await interaction.ConfirmAsync(
            "Close",
            "You have unsaved changes in this window. If you exit they will be discarded.",
            w);
        if (c)
            w.Close();

        // doesn't matter if it's closed
        w.IsEnabled = true;
    }
}

答案 1 :(得分:1)

您无法使用async / await保持表单关闭。你可以得到奇怪的结果。

我要做的是创建一个Thread并将其IsBackground属性设置为false(默认情况下为false),以便在表单关闭时保持进程处于活动状态。

protected override void OnClosing(CancelEventArgs e)
{
    e.Cancel = false;
    new Thread(() => { 
        Thread.Sleep(5000); //replace this line to save some data.....
        MessageBox.Show("EXITED"); 
    }).Start();
    base.OnClosing(e);
}

答案 2 :(得分:1)

对话框在处理消息的同时仍将当前方法保留在堆栈中。

您可以在FormClosing处理程序中显示一个“正在保存...”对话框,并在新任务中运行实际的保存操作,该任务会在编程完成后以编程方式关闭该对话框。

请记住,SaveAsync在非UI线程中运行,并且需要通过Control.Invoke封送任何访问UI元素(请参见下面对decoy.Hide的调用)。最好的办法可能是事先从控件中提取任何数据,然后仅在任务中使用变量。

protected override void OnFormClosing(FormClosingEventArgs e)
{
        Form decoy = new Form()
        {
                ControlBox = false,
                StartPosition = FormStartPosition.CenterParent,
                Size = new Size(300, 100),
                Text = Text, // current window caption
        };
        Label label = new Label()
        {
                Text = "Saving...",
                TextAlign = ContentAlignment.MiddleCenter,
                Dock = DockStyle.Fill,
        };
        decoy.Controls.Add(label);
        var t = Task.Run(async () =>
        {
                try
                {
                        // keep form open if saving fails
                        e.Cancel = !await SaveAsync();
                }
                finally
                {
                        decoy.Invoke(new MethodInvoker(decoy.Hide));
                }
        });
        decoy.ShowDialog(this);
        t.Wait(); //TODO: handle Exceptions
}

答案 3 :(得分:-1)

为什么必须涉及异步行为?这听起来像必须以线性方式发生。我发现最简单的解决方案通常是正确的。

除了下面的代码,您可以让主线程休眠一两秒,并让异步线程在主线程中设置一个标志。

void Form1_FormClosing(object sender, FormClosingEventArgs e)
{
    if (HasChanges())
    {
        DialogResult result = MessageBox.Show("There are unsaved changes. Do you want to save before closing?", "Unsaved Changes", MessageBoxButtons.YesNoCancel, MessageBoxIcon.Question);
        if (result == DialogResult.Yes)
        {
            e.Cancel = true; 
            if(!Save())
            {
                MessageBox.Show("Your work could not be saved. Check your input/config and try again");
                e.Cancel = true;
            }
        }
        else if (result == DialogResult.Cancel)
        {
            e.Cancel = true;
        } } }

答案 4 :(得分:-1)

当我尝试处理所有关闭事件异步时,我遇到了类似的问题。我相信这是因为没有什么可以阻止主线程向前推进实际的FormClosingEvents。只需在等待之后放入一些内联代码,它就可以解决问题。在我的情况下,我保存当前状态,无论响应(等待响应)。一旦用户响应,您就可以轻松地让任务返回当前状态,以便妥善保存。

这对我有用:分离任务,询问退出确认,等待任务,一些内联代码。

    Task myNewTask = SaveMyCurrentStateTask();  //This takes a little while so I want it async in the background

    DialogResult exitResponse = MessageBox.Show("Are you sure you want to Exit MYAPPNAME? ", "Exit Application?", MessageBoxButtons.YesNo, MessageBoxIcon.Question, MessageBoxDefaultButton.Button2);

            await myNewTask;

            if (exitResponse == DialogResult.Yes)
            {
                e.Cancel = false;
            }
            else
            {
                e.Cancel = true;
            }

答案 5 :(得分:-1)

如果在执行异步方法期间引发了异常,我需要中止关闭表单。

我实际上使用Task.Run .Wait()

private void Example_FormClosing(object sender, FormClosingEventArgs e)
{
    try
    {
        Task.Run(async () => await CreateAsync(listDomains)).Wait();
    }
    catch (Exception ex)
    {
        MessageBox.Show($"{ex.Message}", "Attention", MessageBoxButtons.OK, MessageBoxIcon.Error);
        e.Cancel = true;
    }
}