如何正确等待BackgroundWorker完成？

Question

观察下面的代码：

var handler = GetTheRightHandler();
var bw = new BackgroundWorker();
bw.RunWorkerCompleted += OnAsyncOperationCompleted;
bw.DoWork += OnDoWorkLoadChildren;
bw.RunWorkerAsync(handler);

现在假设我想等到 bw 完成工作。这样做的正确方法是什么？

我的解决方案是这样的：

bool finished = false;
var handler = GetTheRightHandler();
var bw = new BackgroundWorker();
bw.RunWorkerCompleted += (sender, args) =>
{
  OnAsyncOperationCompleted(sender, args);
  finished = true;
});
bw.DoWork += OnDoWorkLoadChildren;
bw.RunWorkerAsync(handler);
int timeout = N;
while (!finished && timeout > 0)
{
  Thread.Sleep(1000);
  --timeout;
}
if (!finished)
{
  throw new TimedoutException("bla bla bla");
}

但我不喜欢它。

我考虑过用同步事件替换 finished 标志，将其设置在 RunWorkerCompleted 处理程序中，并稍后阻止它，而不是执行 while-sleep 循环。

唉，这是错误的，因为代码可能在 WPF 或 WindowsForm 同步上下文中运行，在这种情况下，我会阻塞与 RunWorkerCompleted 处理程序运行的同一线程，这显然不是很明智的举动。

我想知道更好的解决方案。

谢谢。

编辑：

PS

• 示例代码是故意设计来澄清我的问题的。我完全知道完成回调，但我想知道如何等待完成。这是我的问题。
• 我知道 Thread.Join、Delegate.BeginInvoke、ThreadPool.QueueUserWorkItem 等...这个问题具体是关于 BackgroundWorker。

编辑2：

好的，我想如果我解释一下这个场景会容易得多。

我有一个单元测试方法，它调用一些异步代码，而这些代码最终又会调用一个 BackgroundWorker ，我可以将完成处理程序传递给它。所有代码都是我的，因此如果我愿意，我可以更改实现。 不过，我不会替换 BackgroundWorker，因为它会自动使用正确的同步上下文，这样当在 UI 线程上调用代码时，就会在同一 UI 线程上调用完成回调，这非常好。

不管怎样，单元测试方法有可能在 BW 完成工作之前就结束了，这是不好的。所以我想等到 BW 完成并想知道最好的方法。

还有更多的部分，但总体情况或多或少像我刚才描述的那样。

Answer 1

尝试像这样使用 AutoResetEvent 类：

var doneEvent = new AutoResetEvent(false);
var bw = new BackgroundWorker();

bw.DoWork += (sender, e) =>
{
  try
  {
    if (!e.Cancel)
    {
      // Do work
    }
  }
  finally
  {
    doneEvent.Set();
  }
};

bw.RunWorkerAsync();
doneEvent.WaitOne();

警告：您应该确保无论发生什么情况都会调用 doneEvent.Set()。此外，您可能希望为 doneEvent.WaitOne() 提供指定超时时间的参数。

注意：此代码几乎是 Fredrik Kalseth 回答 类似问题。

Answer 2

要等待后台工作线程（单个或多个），请执行以下操作：

1. 创建您以编程方式创建的后台工作线程的列表：

   私有IList m_WorkersWithData = new List();
   

2. 在列表中添加后台工作人员：

   BackgroundWorker工人=新的BackgroundWorker();
   worker.DoWork += new DoWorkEventHandler(worker_DoWork);
   worker.ProgressChanged += new ProgressChangedEventHandler(worker_ProgressChanged);
   工人.WorkerReportsProgress = true;
   m_WorkersWithData.Add(worker);
   Worker.RunWorkerAsync();
   

3. 使用以下函数等待列表中的所有worker：

   private void CheckAllThreadsHaveFinishedWorking()
   {
       布尔 hasAllThreadsFinished = false;
       while (!hasAllThreadsFinished)
       {
           hasAllThreadsFinished =（来自 m_WorkersWithData 中的工作人员
                                    哪里worker.IsBusy
                                    选择工人).ToList().Count == 0;
           应用程序.DoEvents(); //如果你想要有进度条并且想要更新它，这个调用非常重要
                                   //来自后台工作者的Progress事件。
           线程.睡眠(1000); //如果循环继续，则此调用将等待，确保之前释放了 CPU 时间
                                   //重新检查。
       }
       m_WorkersWithData.Clear(); //循环退出后清除所有后台worker列表以释放内存。
                                   //相反你也可以处置你的后台工作者。
   }
   

Answer 3

BackgroundWorker 有一个完成事件。不要等待，而是从完成处理程序中调用剩余的代码路径。

Answer 4

这个问题很老了，但我认为作者没有得到他想要的答案。

这有点脏，它是在 vb.NET 中，但对我有用

Private Sub MultiTaskingForThePoor()
    Try
        'Start background worker
        bgwAsyncTasks.RunWorkerAsync()
        'Do some other stuff here
        For i as integer = 0 to 100
            lblOutput.Text = cstr(i)
        Next

        'Wait for Background worker
        While bgwAsyncTasks.isBusy()
            Windows.Forms.Application.DoEvents()
        End While

        'Voila, we are back in sync
        lblOutput.Text = "Success!"
    Catch ex As Exception
        MsgBox("Oops!" & vbcrlf & ex.Message)
    End Try
End Sub

Answer 5

使用 Application.DoEvents() 在循环中检查 backgrWorker.IsBusy 并不是一个好方法。

我同意@JohannesH，你应该明确使用 AutoResetEvent 作为一个优雅的解决方案。但不要在UI Thread中使用，会导致主线程阻塞；它应该来自另一个后台工作线程。

AutoResetEvent aevent = new AutoResetEvent(false);    
private void button1_Click(object sender, EventArgs e)
{
    bws = new BackgroundWorker();
    bws.DoWork += new DoWorkEventHandler(bw_work);
    bws.RunWorkerCompleted += new RunWorkerCompletedEventHandler(bw_complete);
    bws.RunWorkerAsync();

    bwWaiting.DoWork += new DoWorkEventHandler(waiting_work);
    bwWaiting.RunWorkerCompleted += new RunWorkerCompletedEventHandler(waiting_complete);
    bwWaiting.RunWorkerAsync();
}

void bw_work(object sender, DoWorkEventArgs e)
{
    Thread.Sleep(2000);
}

void bw_complete(object sender, RunWorkerCompletedEventArgs e)
{
    Debug.WriteLine("complete " + bwThread.ToString());
    aevent.Set();
}
void waiting_work(object sender, DoWorkEventArgs e)
{
    aevent.WaitOne();
}

void waiting_complete(object sender, RunWorkerCompletedEventArgs e)
{
    Debug.WriteLine("complete waiting thread");
}

Answer 6

VB.NET

While BackgroundWorker1.IsBusy()
    Windows.Forms.Application.DoEvents()
End While

您可以使用它来链接多个事件。 （接下来的伪代码）

download_file("filepath")

    While BackgroundWorker1.IsBusy()
       Windows.Forms.Application.DoEvents()
    End While
'Waits to install until the download is complete and lets other UI events function install_file("filepath")
While BackgroundWorker1.IsBusy()
    Windows.Forms.Application.DoEvents()
End While
'Waits for the install to complete before presenting the message box
msgbox("File Installed")

Answer 7

不太确定你所说的等待是什么意思。您的意思是您希望（由 BW）完成某件事，完成后您想做其他事情吗？
像您一样使用 bw.RunWorkerCompleted （使用单独的函数以提高可读性），并在该回调函数中执行下一步操作。
启动计时器来检查工作是否不会花费太长时间。

var handler = GetTheRightHandler();
var bw = new BackgroundWorker();
bw.RunWorkerCompleted += (sender, args) =>
{
  OnAsyncOperationCompleted(sender, args);
});
bw.DoWork += OnDoWorkLoadChildren;
bw.RunWorkerAsync(handler);

Timer Clock=new Timer();
Clock.Interval=1000;
Clock.Start();
Clock.Tick+=new EventHandler(Timer_Tick);

public void Timer_Tick(object sender,EventArgs eArgs)
{   
    if (bw.WorkerSupportsCancellation == true)
    {
        bw.CancelAsync();
    }

    throw new TimedoutException("bla bla bla");
 }

在 OnDoWorkLoadChildren 中：

if ((worker.CancellationPending == true))
{
    e.Cancel = true;
    //return or something
}

Answer 8

我也在寻找合适的解决方案。我用独占锁解决了等待。代码中的关键路径是写入公共容器（此处为控制台）并增加或减少工作人员。写入此变量时任何线程都不应干扰，否则计数将不再得到保证。

public class Program
{
    public static int worker = 0;
    public static object lockObject = 0;

    static void Main(string[] args)
    {

        BackgroundworkerTest backgroundworkerTest = new BackgroundworkerTest();
        backgroundworkerTest.WalkDir("C:\\");
        while (backgroundworkerTest.Worker > 0)
        {
            // Exclusive write on console
            lock (backgroundworkerTest.ExclusiveLock)
            {
                Console.CursorTop = 4; Console.CursorLeft = 1;
                var consoleOut = string.Format("Worker busy count={0}", backgroundworkerTest.Worker);
                Console.Write("{0}{1}", consoleOut, new string(' ', Console.WindowWidth-consoleOut.Length));
            }
        }
    }
}

public class BackgroundworkerTest
{
    private int worker = 0;
    public object ExclusiveLock = 0;

    public int Worker
    {
        get { return this.worker; }
    }

    public void WalkDir(string dir)
    {
        // Exclusive write on console
        lock (this.ExclusiveLock)
        {
            Console.CursorTop = 1; Console.CursorLeft = 1;
            var consoleOut = string.Format("Directory={0}", dir);
            Console.Write("{0}{1}", consoleOut, new string(' ', Console.WindowWidth*3 - consoleOut.Length));
        }

        var currentDir = new System.IO.DirectoryInfo(dir);
        DirectoryInfo[] directoryList = null;
        try
        {
            directoryList = currentDir.GetDirectories();
        }
        catch (UnauthorizedAccessException unauthorizedAccessException)
        {
            // No access to this directory, so let's leave
            return;
        }

        foreach (var directoryInfo in directoryList)
        {
            var bw = new BackgroundWorker();

            bw.RunWorkerCompleted += (sender, args) =>
            {
                // Make sure that this worker variable is not messed up
                lock (this.ExclusiveLock)
                {
                    worker--;
                }
            };

            DirectoryInfo info = directoryInfo;
            bw.DoWork += (sender, args) => this.WalkDir(info.FullName);

            lock (this.ExclusiveLock)
            {
                // Make sure that this worker variable is not messed up
                worker++;
            }
            bw.RunWorkerAsync();
        }
    }
}

Answer 9

我将 任务 与 BackgroundWorker

您可以创建任意数量的任务并将其添加到任务列表。
Worker 将在添加任务时启动，如果在 Worker IsBusy 期间添加任务则重新启动，并在没有更多任务时停止。

这将允许您根据需要异步更新 GUI，而不会冻结它。

这对我来说是有效的。

    // 'tasks' is simply List<Task> that includes events for adding objects
    private ObservableCollection<Task> tasks = new ObservableCollection<Task>();
    // this will asynchronously iterate through the list of tasks 
    private BackgroundWorker task_worker = new BackgroundWorker();

    public Form1()
    {
        InitializeComponent();
        // set up the event handlers
        tasks.CollectionChanged += tasks_CollectionChanged;
        task_worker.DoWork += task_worker_DoWork;
        task_worker.RunWorkerCompleted += task_worker_RunWorkerCompleted;
        task_worker.WorkerSupportsCancellation = true;

    }

    // ----------- worker events
    void task_worker_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)
    {
        if (tasks.Count != 0)
        {
            task_worker.RunWorkerAsync();
        }
    }

    void task_worker_DoWork(object sender, DoWorkEventArgs e)
    {
        try
        {

            foreach (Task t in tasks)
            {
                t.RunSynchronously();
                tasks.Remove(t);
            }
        }
        catch
        {
            task_worker.CancelAsync();
        }
    }


    // ------------- task event
    // runs when a task is added to the list
    void tasks_CollectionChanged(object sender,
        System.Collections.Specialized.NotifyCollectionChangedEventArgs e)
    {
        if (!task_worker.IsBusy)
        {
            task_worker.RunWorkerAsync();
        }
    }

现在您所需要做的就是创建一个新任务并将其添加到列表中。它将由工作人员按照其放入 List<> 的顺序运行。

Task t = new Task(() => {

        // do something here
    });

    tasks.Add(t);

Answer 10

OpenCV 中存在函数 WaitKey。 Ir 允许以这种方式解决这个问题：

while (this->backgroundWorker1->IsBusy) {
    waitKey(10);
    std::cout << "Wait for background process: " << std::endl;
}
this->backgroundWorker1->RunWorkerAsync();