如何让BackgroundWorker返回一个对象

Question

我需要使 RunWorkerAsync() 返回 List。

能够从后台工作者返回对象的过程是什么？

Answer 1

在 BackgroundWorker（后台工作发生的地方）的 DoWork 事件处理程序中，有一个参数 DoWorkEventArgs。 该对象有一个公共属性对象 Result。 当您的工作线程生成其结果（在您的情况下为 List）时，将 e.Result 设置为该结果，然后返回。

现在您的BackgroundWorker 已完成其任务，它会触发RunWorkerCompleted 事件，该事件有一个RunWorkerCompletedEventArgs 对象作为参数。 RunWorkerCompletedEventArgs.Result 将包含来自 BackgroundWorker 的结果。

例子：

private void bgw_DoWork(object sender, DoWorkEventArgs e)
{
    int result = 2+2;
    e.Result = result;
}

private void bgw_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)
{
    int result = (int)e.Result;
    MessageBox.Show("Result received: " + result.ToString());
}

Answer 2

我假设您不想阻止并等待 RunWorkerAsync() 的结果（如果您这样做，就没有理由运行异步！

如果您想在后台进程完成时收到通知，请挂钩 RunWorkerCompleted 。如果要返回某些状态，请在 DoWork 事件参数的 Result 成员中返回它。

事件

    private void BackgroundWorker_DoWork(object sender, DoWorkEventArgs e)
    {
      // do your thing
      ....
      // return results
      e.Result = theResultObject;
    }
    
    // now get your results
    private void BackgroundWorker_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)
    {
      MyResultObject result = (MyResultObject)e.Result;
      // process your result...
    }

Answer 3

RunWorkerAsync() 异步启动进程，并在进程实际完成之前返回并继续执行代码。 如果您想获取 BackgroundWorker 的结果，则需要创建一个实例变量来保存该值，并在 BackgroundWorker 完成后检查它。

如果您想等到工作完成，那么您不需要 BackgroundWorker。

Answer 4

为了补充大卫的答案，人们可​​能想要推送一个元组来为方法提供多个参数。

为此，让我更新他的答案，其中通过每个调用传递一个值（称为engagementId），并且元组保存要使用的原始项目以及结果。

private void bgw_DoWork(object sender, DoWorkEventArgs e)
{
    var engagementId = (int)e.Argument;
    int result = 2 + 2;
    e.Result = (engagementId, result);
}

private void bgw_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)
{
    (int engagementId, int result) tupleResult = ((int, int)) e.Result; // Both (( are needed for tuple/casting.

    MessageBox.Show($"Result received {tupleResult.result} for engagement {tupleResult.engagementId}");
}

---

有关详细信息，请参阅如何转换为元组的答案。

Answer 5

根据您的模型，您要么希望工作线程在完成工作时回调到其创建者（或其他进程），要么必须经常轮询工作线程以查看它是否已完成，如果所以，得到结果。

等待工作线程返回其结果的想法破坏了多线程的好处。

Answer 6

您可以让您的线程引发一个以对象作为参数的事件：

ThreadFinishedEvent(this, new ThreadEventArgs(object));

其中：

public class ThreadEventArgs : EventArgs
{
    public ThreadEventArgs(object object)
    {
        Object = object
    }

    public object Object
    {
        get; private set;
    }
}

Answer 7

一般来说，当异步运行进程时，工作线程应该调用委托或触发事件（如 ChrisF）。

您可以查看新的 PFX，它具有一些可以返回值的并发函数。

例如，有一个名为 Parallel.ForEach() 的函数，它具有可以返回值的重载。

查看此内容以获取更多信息

http://msdn.microsoft.com/en-us/magazine/cc817396.aspx

Answer 8

不要在“DoWork”方法中进行后台工作，而是创建一个返回您想要返回的类型的方法，并将其应用到 e.Result，如此处建议的其他答案所示。 作为回答 OP 问题而不使问题过于复杂的最小示例...

        private List<FileInfo> FileInfoWorker(object sender, DoWorkEventArgs e)
    {
        return new List<FileInfo>(new DirectoryInfo("C:\\SOTest").GetFiles().ToList());
    }

    private void bgwTest_DoWork(object sender, DoWorkEventArgs e)
    {
        BackgroundWorker worker = sender as BackgroundWorker;

        e.Result = FileInfoWorker(worker, e);
    }

    private void bgwTest_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)
    {
        if (e.Error != null)
        {
            MessageBox.Show(e.Error.Message);
        }
        else if (e.Cancelled)
        {
            tbStatus.Text = "Background operation cancelled.";
        }
        else
        {
            tbStatus.Text = "Background operation complete.";
        }
    }

该示例还演示了如何从 BackgroundWorker API 更新 TextBox。 未显示的是对通过 ProgressBar 和 TextBoxes 报告进度的支持以及对取消的支持，API 也支持这两者。 该代码是通过按钮运行的...

        private void btnSOTest_Click(object sender, EventArgs e)
    {
        bgwTest.RunWorkerAsync();
    }