好得很程序员自学网

<tfoot draggable='sEl'></tfoot>

C# BackgroundWorker使用教程

查询了一下msdn文档,其中微软就backgroundworker类的功能有这么一个描述(英文的,根据个人理解翻译):backgroundworker类允许您在单独的线程上执行某个可能导致用户界面(ui)停止响应的耗时操作(比如文件下载数据库事务等),并且想要一个响应式的ui来反应当前耗时操作的进度。

可以看的出来,backgroundworker组件提供了一种执行异步操作(后台线程)的同时,并且还能妥妥的显示操作进度的解决方案。于是乎,我便深入的了解了一下backgroundworker类。针对backgroundworker类的部分重要属性和方法进行了一次总结。

1、属性:

workerreportsprogress

bool类型,指示backgroundworker是否可以报告进度更新。当该属性值为true是,将可以成功调用reportprogress方法,否则将引发invalidoperationexception异常。 用法:

?

private backgroundworker bgworker = new backgroundworker();

bgworker.workerreportsprogress = true ;

workersupportscancellation

bool类型,指示backgroundworker是否支持异步取消操作。当该属性值为true是,将可以成功调用cancelasync方法,否则将引发invalidoperationexception异常。 用法:

?

bgworker.workersupportscancellation = true ;

cancellationpending

bool类型,指示应用程序是否已请求取消后台操作。此属性通常放在用户执行的异步操作内部,用来判断用户是否取消执行异步操作。当执行backgroundworker.cancelasync()方法时,该属性值将变为true。 用法:

?

//在dowork中键入如下代码

for ( int i = 0; i <= 100; i++)

{

  if (bgworker.cancellationpending)

  {

  e.cancel = true ;

  return ;

  }

  else

  {

  bgworker.reportprogress(i, "working" );

  system.threading.thread.sleep(10);

  }

}

isbusy

bool类型,指示backgroundworker是否正在执行一个异步操作。此属性通常放在backgroundworker.runworkerasync()方法之前,避免多次调用runworkerasync()方法引发异常。当执行backgroundworker.runworkerasync()方法是,该属性值将变为true。

?

//防止重复执行异步操作引发错误

if (bgworker.isbusy)

  return ;

bgworker.runworkerasync();

2、方法:

runworkerasync()

开始执行一个后台操作。调用该方法后,将触发backgroundworker.dowork事件,并以异步的方式执行dowork事件中的代码。

该方法还有一个带参数的重载方法:runworkerasync(object)。该方法允许传递一个object类型的参数到后台操作中,并且可以通过dowork事件的doworkeventargs.argument属性将该参数提取出来。
注:当backgroundworker的isbusy属性为true时,调用该方法将引发invalidoperationexception异常。

?

//在启动异步操作的地方键入代码

bgworker.runworkerasync( "hello" );

reportprogress(int percentprogress)

报告操作进度。调用该方法后,将触发backgroundworker. progresschanged事件。另外,该方法包含了一个int类型的参数percentprogress,用来表示当前异步操作所执行的进度百分比。

该方法还有一个重载方法:reportprogress(int percentprogress, object userstate)。允许传递一个object类型的状态对象到 progresschanged事件中,并且可以通过progresschanged事件的progresschangedeventargs.userstate属性取得参数值。

注:调用该方法之前需确保workerreportsprogress属性值为true,否则将引发invalidoperationexception异常。
用法:

?

for ( int i = 0; i <= 100; i++)

{

  //向progresschanged报告进度

  bgworker.reportprogress(i, "working" );

  system .threading. thread .sleep(10);

}

cancelasync()

请求取消当前正在执行的异步操作。调用该方法将使backgroundworker.cancellationpending属性设置为true。
但需要注意的是,并非每次调用cancelasync()都能确保异步操作,cancelasync()通常不适用于取消一个紧密执行的操作,更适用于在循环体中执行。

用法:

?

//在需要执行取消操作的地方键入以下代码

bgworker.cancelasync();

3、事件:

dowork

用于承载异步操作。当调用backgroundworker.runworkerasync()时触发。
需要注意的是,由于dowork事件内部的代码运行在非ui线程之上,所以在dowork事件内部应避免于用户界面交互,而于用户界面交互的操作应放置在progresschanged和runworkercompleted事件中。

progresschanged

当调用backgroundworker.reportprogress(int percentprogress)方式时触发该事件。
该事件的progresschangedeventargs.progresspercentage属性可以接收来自reportprogress方法传递的percentprogress参数值,progresschangedeventargs.userstate属性可以接收来自reportprogress方法传递的userstate参数。

runworkercompleted

异步操作完成或取消时执行的操作,当调用dowork事件执行完成时触发。
该事件的runworkercompletedeventargs参数包含三个常用的属性error,cancelled,result。其中,error表示在执行异步操作期间发生的错误;cancelled用于判断用户是否取消了异步操作;result属性接收来自dowork事件的doworkeventargs参数的result属性值,可用于传递异步操作的执行结果。

4、附源代码:

前台

后台

?

using system;

using system.collections.generic;

using system测试数据ponentmodel;

using system.data;

using system.drawing;

using system.linq;

using system.text;

using system.threading;

using system.threading.tasks;

using system.windows.forms;

 

namespace prograssbar

{

  public partial class prograssbarusebackgroundworker : form

  {

 

  private backgroundworker bgworker = new backgroundworker();

 

  public prograssbarusebackgroundworker()

  {

  initializecomponent();

  initializebackgroundworker();

  }

 

  private void initializebackgroundworker()

  {

  bgworker.workerreportsprogress = true ;

  bgworker.workersupportscancellation = true ;

  bgworker.dowork += new doworkeventhandler(bgworker_dowork);

  bgworker.progresschanged += new progresschangedeventhandler(bgworker_progesschanged);

  bgworker.runworkercompleted += new runworkercompletedeventhandler(bgworker_workercompleted);

  }

 

  private void btnstart_click( object sender, eventargs e)

  {

  if (bgworker.isbusy)

  return ;

  this .progressbar1.maximum = 100;

  this .btnstart.enabled = false ;

  this .btnstop.enabled = true ;

  bgworker.runworkerasync( "hello" );

  }

 

  public void bgworker_dowork( object sender, doworkeventargs e)

  {

  for ( int i = 0; i <= 100; i++)

  {

  if (bgworker.cancellationpending)

  {

  e.cancel = true ;

  return ;

  }

  else

  {

  bgworker.reportprogress(i, "working" );

  system.threading.thread.sleep(10);

  }

  }

  }

 

  public void bgworker_progesschanged( object sender, progresschangedeventargs e)

  {

  //string state = (string)e.userstate;//接收reportprogress方法传递过来的userstate

  this .progressbar1.value = e.progresspercentage;

  this .label1.text = "处理进度:" + convert.tostring(e.progresspercentage) + "%" ;

  }

 

  public void bgworker_workercompleted( object sender, runworkercompletedeventargs e)

  {

  if (e.error!= null )

  {

  messagebox.show(e.error.tostring());

  return ;

  }

  if (!e.cancelled)

  this .label1.text = "处理完毕!" ;

  else

  this .label1.text = "处理终止!" ;

 

  }

 

  private void btnstop_click( object sender, eventargs e)

  {

  this .btnstart.enabled = true ;

  this .btnstop.enabled = false ;

  bgworker.cancelasync();

  }

  }

}

运行结果:

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

原文链接:https://HdhCmsTestcnblogs测试数据/zhaoshujie/p/9634136.html

dy("nrwz");

查看更多关于C# BackgroundWorker使用教程的详细内容...

  阅读:46次