c# - 将参数传递给 Backgroundworker 错误处理程序

Question

我的程序必须同时测试不同插槽中的多个产品。当插槽出现错误，如意外从计算机脱离时，程序假设将错误类型和用户在启动 UI 时提供的产品序列号记录到文本文件中。

我正在使用 Background Worker 来处理多线程。虽然我已设法使用 e.Error 记录错误类型，但我似乎无法弄清楚如何将序列号从 DoWork 函数传递到后台工作程序错误处理程序。

我尝试使用谷歌搜索解决方案，但之前似乎没有人问过这个问题。我将非常感谢所提供的任何帮助。PS:我是 C# 的新手，所以要温和哈哈 :)

下面是一个示例代码:

        private void startAsync_Click(object sender, EventArgs e)
        {
            if (backgroundWorker1.IsBusy != true)
            {
                // Start the asynchronous operation.
                backgroundWorker1.RunWorkerAsync();
            }
        }

        private void cancelAsync_Click(object sender, EventArgs e)
        {
            if (backgroundWorker1.WorkerSupportsCancellation == true)
            {
                // Cancel the asynchronous operation.
                backgroundWorker1.CancelAsync();
            }
        }

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

            int b = 0; //simulate error
            for (int i = 1; i <= 10; i++)
            {
                if (worker.CancellationPending == true)
                {
                    string[] array2 = { "1", "cancelled" };
                    e.Result = array2; //passing values when user cancel through e.Result object
                    e.Cancel = true;
                    break;
                }
                else
                {
                    // Perform a time consuming operation and report progress.
                    worker.ReportProgress(i * 10, "Test a");
                    int a = 1 / b; //simulate error
                    System.Threading.Thread.Sleep(1000);

        }
                string[] array1 = {"1","done"};
                e.Result = array1; //passing values when complete through e.Result object
            }
        }

        private void backgroundWorker1_ProgressChanged(object sender, ProgressChangedEventArgs e)
        {
            resultLabel.Text = e.ProgressPercentage.ToString() + "%" + e.UserState.ToString();
        }

        private void backgroundWorker1_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)
        {
            if (e.Cancelled == true)
            {
                string[] someArray2 = e.Result as string[];
                string sernum = someArray2[0];
                string status = someArray2[1];
                resultLabel.Text = sernum + " " + status;
            }
            else if (e.Error != null)
            {
                resultLabel.Text = "Error: " + e.Error.Message; //how to pass sernum here?
            }
            else
            {
                string[] someArray = e.Result as string[];
                string sernum = someArray[0];
                string status = someArray[1];
                resultLabel.Text = sernum + " " + status;

            }
        }

Answer 1

有很多不同的方法可以在发生异常时将数据返回给 RunWorkerCompleted 事件处理程序。

恕我直言，从语义的角度来看，最自然的做法是将数据放在异常本身中。例如:

class BackgroundWorkerException : Exception
{
    public string Sernum { get; }

    public BackgroundWorkerException(string sernum, Exception inner)
        : base("DoWork event handler threw an exception", inner)
    {
        Sernum = sernum;
    }
}

然后在您的 DoWork 处理程序中:

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

    try
    {
        int b = 0; //simulate error
        for (int i = 1; i <= 10; i++)
        {
            if (worker.CancellationPending == true)
            {
                string[] array2 = { "1", "cancelled" };
                e.Result = array2; //passing values when user cancel through e.Result object
                e.Cancel = true;
                break;
            }
            else
            {
                // Perform a time consuming operation and report progress.
                worker.ReportProgress(i * 10, "Test a");
                int a = 1 / b; //simulate error
                System.Threading.Thread.Sleep(1000);

            }
            string[] array1 = {"1","done"};
            e.Result = array1; //passing values when complete through e.Result object
        }
    }
    catch (Exception e)
    {
        throw new BackgroundWorkerException("1", e);
    }
}

最后，在 RunWorkerCompleted 事件处理程序中:

private void backgroundWorker1_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)
{
    if (e.Cancelled == true)
    {
        string[] someArray2 = e.Result as string[];
        string sernum = someArray2[0];
        string status = someArray2[1];
        resultLabel.Text = sernum + " " + status;
    }
    else if (e.Error != null)
    {
        string sernum = ((BackgroundWorkerException)e.Error).Sernum;

        resultLabel.Text = "Error: " + e.Error.Message;
    }
    else
    {
        string[] someArray = e.Result as string[];
        string sernum = someArray[0];
        string status = someArray[1];
        resultLabel.Text = sernum + " " + status;

    }
}

您的问题不清楚 sernum 实际代表什么，特别是它是否是给定后台任务的单个值，或者单个任务可能对 有多个值序列号。如果是前者，即您知道什么时候开始任务，那么您可以通过在用于每个实际事件处理程序的匿名方法中捕获它，将其直接传递给事件处理程序。

如果不进行一些更改，该方法将无法在您的特定场景中使用。您似乎已将单个 BackgroundWorker 对象作为组件添加到您的表单中并正在重用它。如果您每次都创建一个新的 BackgroundWorker，那么使用匿名方法会更好/更容易，这样您就可以将匿名方法委托(delegate)订阅到 DoWork 和 RunWorkerCompleted。 (您必须在每次调用之前订阅它，因为据推测，sernum 值每次都不同。)

您可以让它与添加到设计器中的表单的单个组件一起工作，就像您在这里所做的那样，但它要复杂得多，因为您必须动态地向 RunWorkerCompleted 取消订阅自身和您订阅 DoWork 和 RunWorkerCompleted 事件的委托(delegate)的事件(在此方案中，您不会直接订阅设计器中组件的任何方法).

另一种方法是创建自定义数据结构作为 RunWorkerAsync() 的参数传递，它可以包含 sernum 值的属性。您可以在启动工作程序的方法中或在 DoWork 事件处理程序中设置此值。

这种方法只更适合您拥有的 component-in-Designer 场景，因为您仍然需要一种方法将对该自定义数据结构的引用返回给 RunWorkerCompleted 事件处理程序，您只能通过将其存储在例如一个实例字段，可以在启动 worker 的 Click 事件处理程序和 RunWorkerCompleted 事件之间共享(坦率地说，如果你这样做，那么它是否是有争议的甚至值得将该引用传递给 RunWorkerAsync() 方法，因为 DoWork 事件处理程序也可以获得相同的实例字段。)

另一种方法是像我在上面的代码示例中所做的那样捕获异常，但不是重新抛出异常，而是将其视为工作已取消(即设置 Result 和取消属性)。

另一种方法是完全放弃 BackgroundWorker 并切换到基于 TPL Task 的习惯用法。这并没有隐含地解决问题，但它允许上述任何选项，以及仅定义您自己的模式以将错误传回的选项。

如果您需要比这更具体的帮助，您需要发布一个新问题，并提供一个很好的 Minimal, Complete, and Verifiable code example这表明您已尝试尝试上述哪些方法，或此处未列出的其他替代方法，以及具体您无法弄清楚的内容。