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

Question

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

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

我尝试在谷歌上搜索解决方案，但似乎以前没有人问过这个问题。我将非常感谢提供的任何帮助。 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 实际代表什么，特别是对于给定的后台任务，它是单个值，还是单个任务可能对sernum 具有多个值。如果是前者，即您在启动任务时知道值是什么，那么您可以通过在用于每个实际事件处理程序的匿名方法中捕获它来直接将其传递给事件处理程序。

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

您可以像在此处那样使用添加到设计器中的表单的单个组件，但这要复杂得多，因为您必须动态地向RunWorkerCompleted 事件添加一个处理程序，该事件同时取消订阅它本身以及您订阅了 DoWork 和 RunWorkerCompleted 事件的委托（在此方案中，您不会将任何方法直接订阅到设计器中的组件）。

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

这种方法只更适合您拥有的组件在设计器中的场景，因为您仍然需要一种方法将对该自定义数据结构的引用返回给 RunWorkerCompleted 事件处理程序，您只能这样做通过将其存储在例如一个实例字段，可以在启动 worker 的 Click 事件处理程序和 RunWorkerCompleted 事件之间共享（坦率地说，如果你这样做，那么在这一点上，是否值得将该引用传递给 @ 987654344@ 方法，因为DoWork 事件处理程序也可以获取相同的实例字段。）

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

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

如果您需要比这更具体的帮助，您需要发布一个新问题，并附上一个很好的 Minimal, Complete, and Verifiable code example 来显示您尝试尝试的上述方法中的哪一种，或者此处未列出的其他替代方法，以及具体是什么你无法弄清楚的。

Answer 2

见下面的代码。你不需要上课。可以使用类似的代码简单地发送一个字符串或整数。

        public class Parameters
        {
            public string message = "";
        }

        private void startAsync_Click(object sender, EventArgs e)
        {
            if (backgroundWorker1.IsBusy != true)
            {
                // Start the asynchronous operation.
                Parameters parameters = new Parameters() { message = "The quick brown fox jumped over the lazy dog" };


                backgroundWorker1.RunWorkerAsync(parameters);
            }
        }



        private void backgroundWorker1_DoWork(object sender, DoWorkEventArgs e)
        {
            Parameters parameters = e.Argument as Parameters;
        }