使用 HttpClient 异步方法的 BackgroundWorker答案

【问题标题】：BackgroundWorker that uses HttpClient async methods使用 HttpClient 异步方法的 BackgroundWorker
【发布时间】：2015-12-10 15:39:20
【问题描述】：

我过去曾在 Windows 窗体应用程序中使用过 BackgroundWorker。对于我的新练习，我需要在 worker 内部使用 async 方法，对此我有点困惑。

这是我的代码结构。在表单加载事件中，我正在创建 BackgroundWorker 对象和设置事件

private void fMain_Load( object sender, EventArgs e ) {
    bw = new BackgroundWorker();
    bw.WorkerReportsProgress = true;
    bw.DoWork += new DoWorkEventHandler( bw_DoWork );
    bw.ProgressChanged += new ProgressChangedEventHandler( bw_ProgressChanged );
    bw.RunWorkerCompleted += new RunWorkerCompletedEventHandler( bw_RunWorkerCompleted );
}

当用户单击按钮时，我正在启动工作人员

private void btnGenerate_Click( object sender, EventArgs e ) {
    Settings settings = new Settings();
    pbCounter.Visible = true;
    btnGenerate.Enabled = false;
    bw.RunWorkerAsync( settings );
}

这是工作代码

private async void bw_DoWork( object sender, DoWorkEventArgs e ) {
    try {
        for ( int ix = 1; i <= 100; i++ ) {
            using (var client = new HttpClient()) {
                [???? how to call and wait here ????]
                HttpResponseMessage response = await client.PostAsync( "endpoint", new StringContent( JsonConvert.SerializeObject( formContent ), Encoding.UTF8, "application/json" ) );
            }

            //The counter will keep track of your process
            Application.DoEvents();
            int percentage = ix * 100 / settings.TotalRuns;
            bw.ReportProgress( percentage );
        }
    }
    catch ( Exception ex ) {
        MessageBox.Show( ex.Message, "Gift Creator", MessageBoxButtons.OK, MessageBoxIcon.Error );
    }
}

【问题讨论】：

我不认为 BackgroundWorker 与 async-await 配合得很好。您可能应该使用其他东西（或构建它）。
那行不通。如果您将DoWork 处理程序async 并在内部使用await，则该方法将返回那里并且后台工作程序将完成。我认为您在使用异步时不需要后台工作人员，但必须考虑一下如何报告进度。
@RenéVogt：对。我想把后台工作人员扔掉。但是我非常喜欢它处理进度通知的方式。有什么建议吗？
您可以简单地将 for 循环原样（包括 await）放入您的按钮处理程序并从那里更新进度条（对于每次迭代）。我不知道HttpClient 类以及它是否报告进度。但是您似乎只想显示 loop 的进度。

标签： c# async-await backgroundworker asp.net-4.5

【解决方案1】：

如果您使用async 和await，则不需要后台工作人员。事实上，您的后台工作人员将无法工作，因为当您使用await 时，控制权已交还给调用者。当DoWork 处理程序将控制权返回给它的调用者时，后台工作人员将终止并且不再继续其剩余的任务。

所以我会创建按钮处理程序 async 并在那里执行 http 请求：

    private async void btnGenerate_Click(object sender, EventArgs e)
    {
        const int totalRuns = 5;
        pbCounter.Visible = true;
        pbCounter.Minimum = 0;
        pbCounter.Maximum = totalRuns;
        pbCounter.Value = 0;
        btnGenerate.Enabled = false;

        try
        {
            for ( int i = 1; i <= totalRuns; i++ ) 
            {
                using (var client = new HttpClient()) 
                    await client.PostAsync( "endpoint", new StringContent( JsonConvert.SerializeObject( formContent ), Encoding.UTF8, "application/json" ) );
                pbCounter.Value = i;

            }
        }
        catch (Exception ex )
        {
            MessageBox.Show( ex.Message, "Gift Creator", MessageBoxButtons.OK, MessageBoxIcon.Error );
        }

        btnGenerate.Enabled = true;
    }

所以这个处理程序在等待 http 请求时将控制权交还给调用者（说它过于简单：UI）。请求完成后，在pbCounter.Value = i 行继续执行 - 并在 UI 线程上！所以你可以安全地更新进度条，因为你不是从另一个线程做的。

我希望这对你有帮助。请注意，我将pbCounter.Maximum 设置为您将要运行的循环数，因此您无需计算百分比。

【讨论】：