如何进行 C# 异步编程？

Question

我正在使用很久以前用 Visual Basic.net 编写的数据库中的导出工具。

我切换到 C# 并喜欢用 C# 重新编程，因为我积累了比以前更多的经验 :-)

我的 C# 应用程序的 UI 挂起，因为有一个大型数据库查询要做。所以我已经了解了异步编程。也尝试过线程和任务，但我无法找到解决我问题的正确方法。

这就是我所拥有的：它是一个 Windows 窗体应用程序，并且有一个创建新线程的开始按钮。

名为 Export 的方法是我在名为 actions.cs 的第二个类文件中创建的非静态方法。它是非静态的，因为该方法应该在代码中经常重复使用，但参数不同。

所以我在Form1上实例化Button_Clicked事件中的方法，并带有相应的参数：

actions KuliMon = new actions()
        {
            ExportPath = settings.ReadActSetting("baexport", "ExportPfad", ""),
            Trennzeichen = settings.ReadGlobSetting("Trennzeichen", ";"),
            ConnectionString = settings.ReadGlobSetting("Mand1_odbc", ""),
            SQLFile = "kuli.sql",
            ExportAktion = "kuli"
        };

然后我从 Button_click 事件启动线程，如下所示：

Thread ExportThread = new Thread(KuliMon.Export);
        ExportThread.Start();

这行得通。没有粘贴 GUI。但是现在问题来了。我在 actions.cs 中的方法 Export 是将 DB-Query 导出到 csv-File 中，但也应该以字符串变量的形式返回结果，然后我可以将其显示在 Form1 上的 TextBox 中。

通过阅读我发现 Invoke-Method 这一点帮助很大。在 Thread.Start() 下，我添加了以下内容：

this.Invoke((MethodInvoker)delegate
        {
             tx_main_t1.Text = "Hello";
        });

当我点击按钮时，TextBox 会说“你好”。但不是你好，我需要在线程中运行的方法导出的返回字符串。这里的问题是如何获取带有查询结果的字符串。

在我的理解中，线程方法必须调用一个 void 方法并且不能返回一个值。

我想创建一个公共属性字符串并在 Export 中使用返回值填充字符串，如下所示：

public string results { get; set; }

我尝试过在方法导出中使用 return ReturnValue 而不是

results = ReturnValue;

然后，在 Form1 中，我尝试用 KuliMon.results 填充 TextBox，但它是空的，因为我按照我的想法创建了一个 Export 实例。

Answer 1

数据库查询和写入文件都是 I/O 绑定操作，因此它们非常适合 async 和 await。

首先，您将定义 KuliMon.Export 的异步版本：

async Task<string> ExportAsync()
{
  var data = await myQuery.ToListAsync();

  await myStream.WriteAsync(...);

  return results;
}

例如，您可以使用Entity Framework 6 for asynchronous query support。

然后你可以从你的 UI 中调用它：

async void button1_Clicked(...)
{
  TextBox1.Text = await myInstance.ExportAsync();
}

如果您出于某种原因不能使用异步数据库查询（例如，我认为 Oracle 目前不支持它们），那么您可以使用调用同步 API 的后台线程。请注意，Task.Run 是 Thread 和 BackgroundWorker 的现代替代品：

string Export();
...
async void button1_Clicked(...)
{
  TextBox1.Text = await Task.Run(() => myInstance.Export());
}

Answer 2

您应该查看 BackGroundWorker 类
https://msdn.microsoft.com/en-us/library/cc221403%28v=vs.95%29.aspx

您可以分配一个函数在工作人员完成工作时调用，并让该函数更新您的 UI。

Answer 3

使用 .Net 4.5 和 c#5 中支持的 async await（您可以在早期的 .Net 版本中获得对 3.5 或 4.0 的 AsyncBridge 包的支持）

private async void button1_Click(object sender, EventArgs e)
{
     button1.Enabled = false;
     try
     {
          //Code will wait here for your method to return without blocking UI Exceptions or Result will be automatically Scheduled to UI thread
          string result = await DoStuffAsync("myParameter");
     }
     catch
     {
          MessageBox.Show("Ups an error");
     }
     finally
     {
         button1.Enabled = true;
     }

}

/// <summary>
/// Wraps the synchron implementation off DoStuff
/// </summary>    
public Task<string> DoStuffAsync(string s)
{
   return Task.Factory.StartNew(DoStuff, s); //here parameter s is forwarded to your synchronus implementation
}

/// <summary>
/// Your orginal synchron implementation with the dbQuerry
/// or long running calculations
/// </summary>   
public string DoStuff(string s)
{
      //do your normal code;
      return result
}