C# BackgroundWorker用法详解

发布时间 - 2026-01-11 00:37:51    点击率:

在C#程序中,经常会有一些耗时较长的CPU密集型运算,如果直接在 UI 线程执行这样的运算就会出现UI不响应的问题。解决这类问题的主要途径是使用多线程,启动一个后台线程,把运算操作放在这个后台线程中完成。但是原生接口的线程操作有一些难度,如果要更进一步的去完成线程间的通信就会难上加难。

还好 .NET 类库中提供了一个叫做 BackgroundWorker 的类可以比较优雅的解决这类问题。虽然BackgroundWorker 类使用起来比较简单,但其中还是有一些需要注意的细节,下面我们就通过 demo 程序介绍它的主要用法。我们在 demo中计算1到100的累加和,为了演示,每次计算都 sleep 600毫秒,demo 的UI为:

用法概述

在窗体上构建一个BackgroundWorker 实例,在它的 DoWork事件处理函数中添加耗时的运算,然后调用它的RunWorkerAsync方法就可以了。

private BackgroundWorker _demoBGWorker = new BackgroundWorker();
_demoBGWorker.DoWork += BGWorker_DoWork;
_demoBGWorker.RunWorkerAsync();
private void BGWorker_DoWork(object sender, DoWorkEventArgs e)
{
  //在这里执行耗时的运算。
  int sum = 0;
  for (int i = 0; i <= 100; i++)
  {
    sum += i;
  }
}

是不是有点太简单了?那么让我们考虑下面的问题:

如果我们想要把参数传递给运算过程该怎么做?

在运算过程中我们希望把实时的信息显示在UI上该怎么办?

如果我们想要取消正在进行的运算该怎么办?

如果运算过程出现异常我们又该如何处理?

接下来我们就一个一个的处理这些问题。

把参数传递给运算过程

直接把100写死到运算过程中可不好,我们还打算允许用户指定求和的范围呢!所以需要把100作为参数传递给计算过程。在概述中我们通过调用RunWorkerAsync方法启动计算过程,其实这个方法可以接受一个 object 类型的参数。通过它我们就可以把任何数据传递给计算过程:

//别忘了设置滚动条。
this.progressBarSum.Maximum = 100;
_demoBGWorker.RunWorkerAsync(100);
//下面是更新后的 BGWorker_DoWork 方法:
private void BGWorker_DoWork(object sender, DoWorkEventArgs e)
{
  //在这里执行耗时的运算。
  int endNumber = 0;
  if(e.Argument != null)
  {
    endNumber = (int)e.Argument;
  }
  int sum = 0;
  for (int i = 0; i <= endNumber; i++)
  {
    sum += i;
  }
}

BGWorker_DoWork事件处理函数通过参数 e 的Argument属性传来了我们期望的运算信息。

把消息传递给UI

由于计算过程比较长,我们在通过进度条来显示当前进度的同时,还希望能实时的把计算的中间结果显示在UI上。当然,BackgroundWorker对这个用例也提供了很好的支持。它允许我们在执行计算的过程中给UI线程发送消息,下面看看具体的做法:

_demoBGWorker.WorkerReportsProgress = true;
_demoBGWorker.ProgressChanged += BGWorker_ProgressChanged;

首先要把WorkerReportsProgress 属性设置为 true,然后为ProgressChanged 事件添加处理方法:

private void BGWorker_ProgressChanged(object sender, ProgressChangedEventArgs e)
{
  //修改进度条的显示。
  this.progressBarSum.Value = e.ProgressPercentage;

  //如果有更多的信息需要传递,可以使用 e.UserState 传递一个自定义的类型。
  //这是一个 object 类型的对象,您可以通过它传递任何类型。
  //我们仅把当前 sum 的值通过 e.UserState 传回,并通过显示在窗口上。
  string message = e.UserState.ToString();
  this.labelSum.Text = message;
}

继续更新 BGWorker_DoWork方法:

private void BGWorker_DoWork(object sender, DoWorkEventArgs e)
{
  BackgroundWorker bgWorker = sender as BackgroundWorker;
  int endNumber = 0;
  if(e.Argument != null)
  {
    endNumber = (int)e.Argument;
  }

  int sum = 0;
  for (int i = 0; i <= endNumber; i++)
  {
    sum += i;
    
    string message = "Current sum is: " + sum.ToString();
    //ReportProgress 方法把信息传递给 ProcessChanged 事件处理函数。
    //第一个参数类型为 int,表示执行进度。
    //如果有更多的信息需要传递,可以使用 ReportProgress 的第二个参数。
    //这里我们给第二个参数传进去一条消息。
    bgWorker.ReportProgress(i, message);
    Thread.Sleep(600);
  }
}

OK,现在已经可以看到进度条和执行信息的更新了。

取消操作

在执行过程中允许用户取消当前的操作是一个基本的设计,BackgroundWorker自然有很好的支持:

_demoBGWorker.WorkerSupportsCancellation = true;

和WorkerReportsProgress属性一样,如果要支持取消操作我们需要设置 WorkerSupportsCancellation属性为 true。并且还要在BGWorker_DoWork方法中进行支持,在 for 循环中 Thread.Sleep(600)后面添加代码:

 bgWorker.ReportProgress(i, message);
Thread.Sleep(600);

//在操作的过程中需要检查用户是否取消了当前的操作。
if (bgWorker.CancellationPending == true)
{
  e.Cancel = true;
  break;
}

如果检测到用户点击的取消按钮,就退出当前的计算过程。下面是点击取消按钮时要调用的代码:

_demoBGWorker.CancelAsync();

现在已经可以支持取消操作了,赶快试试吧!

异常处理

如果在计算过程中发生了异常该怎么处理?有没有办法知道计算过程已经结束?当然要有,即便是正常的结束也需要拿到计算的结果。

_demoBGWorker.RunWorkerCompleted += BGWorker_RunWorkerCompleted;
private void BGWorker_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)
{
  //如果用户取消了当前操作就关闭窗口。
  if (e.Cancelled)
  {
    this.Close();
  }

  //计算已经结束,需要禁用取消按钮。
  this.btnCancel.Enabled = false;

  //计算过程中的异常会被抓住,在这里可以进行处理。
  if (e.Error != null)
  {
    Type errorType = e.Error.GetType();
    switch (errorType.Name)
    {
      case "ArgumentNullException":
      case "MyException":
        //do something.
        break;
      default:
        //do something.
        break;
    }
  }

  //计算结果信息:e.Result
  //use it do something.
}

RunWorkerCompleted 事件处理函数会在DoWork 事件处理函数返回后被调用。通过它我们可以进行一些运算结束后的操作,比如禁用取消按钮,异常处理,结果显示等。

注意,如果想要拿到 e.Result,您需要在BGWorker_DoWork方法中设置 e.Result属性,如:

e.Result = sum;

总结,BackgroundWorker 类功能完善且使用简便,实在是处理异步耗时操作的利器!

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。


# C#  # backgroundworker  # backgroundworker用法  # C#中Backgroundworker与Thread的区别  # C#使用BackgroundWorker控件  # C#中BackgroundWorker类用法总结  # c# BackgroundWorker组件的作用  # C#中backgroundWorker类的用法详解  # c# BackgroundWorker使用方法  # C# BackgroundWorker使用教程  # C#中backgroundworker的使用教程  # C# BackgroundWorker组件学习入门介绍  # c#中使用BackgroundWorker的实现  # 过程中  # 在这里  # 就会  # 很好  # 这类  # 第二个  # 进度条  # 可以使用  # 较长  # 已经结束  # 就可以  # 是一个  # 放在  # 第一个  # 让我们  # 要有  # 取消了  # 会在  # 您可以  # 要在 


相关栏目: 【 网站优化151355 】 【 网络推广146373 】 【 网络技术251813 】 【 AI营销90571


相关推荐: 如何用PHP快速搭建高效网站?分步指南  Laravel的HTTP客户端怎么用_Laravel HTTP Client发起API请求教程  如何在IIS7上新建站点并设置安全权限?  如何确保FTP站点访问权限与数据传输安全?  VIVO手机上del键无效OnKeyListener不响应的原因及解决方法  如何确认建站备案号应放置的具体位置?  DeepSeek是免费使用的吗 DeepSeek收费模式与Pro版本功能详解  如何快速搭建个人网站并优化SEO?  如何快速选择适合个人网站的云服务器配置?  如何在宝塔面板中创建新站点?  Win11怎么恢复误删照片_Win11数据恢复工具使用【推荐】  EditPlus中的正则表达式 实战(2)  INTERNET浏览器怎样恢复关闭标签页_INTERNET浏览器标签恢复快捷键与方法【指南】  Laravel安装步骤详细教程_Laravel环境搭建指南  nginx修改上传文件大小限制的方法  浅谈redis在项目中的应用  Laravel怎么创建控制器Controller_Laravel路由绑定与控制器逻辑编写【指南】  javascript中的数组方法有哪些_如何利用数组方法简化数据处理  Laravel怎么解决跨域问题_Laravel配置CORS跨域访问  如何在万网主机上快速搭建网站?  如何在 Telegram Web View(iOS)中防止键盘遮挡底部输入框  儿童网站界面设计图片,中国少年儿童教育网站-怎么去注册?  Laravel如何使用Scope本地作用域_Laravel模型常用查询逻辑封装技巧【手册】  node.js报错:Cannot find module &#39;ejs&#39;的解决办法  最好的网站制作公司,网购哪个网站口碑最好,推荐几个?谢谢?  零基础网站服务器架设实战:轻量应用与域名解析配置指南  如何确保西部建站助手FTP传输的安全性?  Laravel如何处理跨站请求伪造(CSRF)保护_Laravel表单安全机制与令牌校验  Laravel如何使用缓存系统提升性能_Laravel缓存驱动和应用优化方案  Windows驱动无法加载错误解决方法_驱动签名验证失败处理步骤  香港服务器网站测试全流程:性能评估、SEO加载与移动适配优化  Laravel如何使用集合(Collections)进行数据处理_Laravel Collection常用方法与技巧  Laravel怎么实现API接口鉴权_Laravel Sanctum令牌生成与请求验证【教程】  千库网官网入口推荐 千库网设计创意平台入口  Laravel Asset编译怎么配置_Laravel Vite前端构建工具使用  历史网站制作软件,华为如何找回被删除的网站?  Python企业级消息系统教程_KafkaRabbitMQ高并发应用  Laravel怎么判断请求类型_Laravel Request isMethod用法  QQ浏览器网页版登录入口 个人中心在线进入  如何在阿里云域名上完成建站全流程?  google浏览器怎么清理缓存_谷歌浏览器清除缓存加速详细步骤  Laravel如何使用Guzzle调用外部接口_Laravel发起HTTP请求与JSON数据解析【详解】  合肥制作网站的公司有哪些,合肥聚美网络科技有限公司介绍?  Edge浏览器如何截图和滚动截图_微软Edge网页捕获功能使用教程【技巧】  Laravel如何获取当前用户信息_Laravel Auth门面获取用户ID  高性能网站服务器部署指南:稳定运行与安全配置优化方案  Laravel Telescope怎么调试_使用Laravel Telescope进行应用监控与调试  如何选择PHP开源工具快速搭建网站?  Laravel如何配置和使用缓存?(Redis代码示例)  Laravel怎么使用Session存储数据_Laravel会话管理与自定义驱动配置【详解】