一、引言
在上一个专题中为大家介绍了.NET 1.0中提出来的异步编程模式——APM，虽然APM为我们实现异步编程提供了一定的支持，同时它也存在着一些明显的问题——不支持对异步操作的取消和没有提供对进度报告的功能，对于有界面的应用程序来说，进度报告和取消操作的支持也是必不可少的，既然存在这样的问题，微软当然也应该提供给我们解决问题的方案了，所以微软在.NET 2.0的时候就为我们提供了一个新的异步编程模型，也就是我这个专题中介绍的基于事件的异步编程模型——EAP。
二、介绍
实现了基于事件的异步模式的类将具有一个或者多个以Async为后缀的方法和对应的Completed事件，并且这些类都支持异步方法的取消、进度报告和报告结果。
当我们调用实现基于事件的异步模式的类的 XxxAsync方法时，即代表开始了一个异步操作，该方法调用完之后会使一个线程池线程去执行耗时的操作，所以当UI线程调用该方法时，当然也就不会堵塞UI线程了。并且基于事件的异步模式是建立了APM的基础之上的(这也是我在上一专题中详解介绍APM的原因)，而APM又是建立了在委托之上的（对于这点可以参考该系列的APM专题）。BackgroundWorker类就是用EAP实现的。
三、使用BackgroundWorker组件进行异步编程
下面向大家演示一个使用BackgroundWorker组件实现异步下载文件的一个小程序，该程序支持异步下载(指的就是用线程池线程要执行下载操作)，断点续传、下载取消和进度报告的功能，通过这个程序，相信大家也会对基于事件的异步模式有一个更好的理解和知道该模式可以完成一些什么样的任务，下面就看看该程序的主要代码的（因为代码中都有详细的解释，这里就不多解释代码的实现了）：
public FileDownloader()
{
InitializeComponent();
string url = "http://download.microsoft.com/download/7/0/3/703455ee-a747-4cc8-bd3e-98a615c3aedb/dotNetFx35setup.exe";
//string url = "http://download.microsoft.com/download/9/5/A/95A9616B-7A37-4AF6-BC36-D6EA96C8DAAE/dotNetFx40_Full_x86_x64.exe";
txbUrl.Text = url;
this.btnPause.Enabled = false;
GetTotalSize();
downloadPath = Environment.GetFolderPath(Environment.SpecialFolder.Desktop) + "\\" + Path.GetFileName(this.txbUrl.Text.Trim());
if (File.Exists(downloadPath))
{
FileInfo fileInfo = new FileInfo(downloadPath);
DownloadSize = (int)fileInfo.Length;
progressBar1.Value = (int)((float)DownloadSize / (float)totalSize * 100);
}
//启用支持 ReportProgress and Cancellation
bgWorkerFileDownload.WorkerReportsProgress = true;
bgWorkerFileDownload.WorkerSupportsCancellation = true;
}
//开始或恢复下载
private void btnDownload_Click(object sender, EventArgs e)
{
if (bgWorkerFileDownload.IsBusy != true)
{
// 启动异步操作触发DoWork事件
bgWorkerFileDownload.RunWorkerAsync();
// 创建RequestState 实例
requestState = new RequestState(downloadPath);
requestState.filestream.Seek(DownloadSize, SeekOrigin.Begin);
this.btnDownload.Enabled = false;
this.btnPause.Enabled = true;
}
else
{
MessageBox.Show("正在执行操作，请稍后");
}
}
// 暂停下载
private void btnPause_Click(object sender, EventArgs e)
{
if (bgWorkerFileDownload.IsBusy && bgWorkerFileDownload.WorkerSupportsCancellation == true)
{
//终止异步操作触发RunWorkerCompleted事件
bgWorkerFileDownload.CancelAsync();
}
}
#region BackGroundWorker Event
//当调用RunWorkerAsync方法时触发
private void bgWorkerFileDownload_DoWork(object sender, DoWorkEventArgs e)
{
// Get the source of event
BackgroundWorker bgworker = sender as BackgroundWorker;
try
{
HttpWebRequest myHttpWebRequest = (HttpWebRequest)WebRequest.Create(txbUrl.Text.Trim());
//如果文件已下载了一部分，
// The server should start sending data from the DownloadSize to the end of the data in the HTTP entity.
if (DownloadSize != 0)
{
myHttpWebRequest.AddRange(DownloadSize);
}
if (DownloadSize >= totalSize)
{
MessageBox.Show("已经下载完毕");
return;
}
requestState.request = myHttpWebRequest;
requestState.response = (HttpWebResponse)myHttpWebRequest.GetResponse();
requestState.streamResponse = requestState.response.GetResponseStream();
int readSize = 0;
while (true)
{
if (bgworker.CancellationPending == true)
{
e.Cancel = true;
break;
}
readSize = requestState.streamResponse.Read(requestState.BufferRead, 0, requestState.BufferRead.Length);
if (readSize > 0)
{
DownloadSize += readSize;
int percentComplete = (int)((float)DownloadSize / (float)totalSize * 100);
requestState.filestream.Write(requestState.BufferRead, 0, readSize);
// 报告进度，引发ProgressChanged事件的发生
bgworker.ReportProgress(percentComplete);
}
else
{
break;
}
}
}
catch
{
throw;
}
}
// 当调用ReportProgress方法时触发
private void bgWorkerFileDownload_ProgressChanged(object sender, ProgressChangedEventArgs e)
{
this.progressBar1.Value = e.ProgressPercentage;
}
//当后台操作完成，取消或者有错误时触发。
private void bgWorkerFileDownload_RunWorkerCompleted(object sender, RunWorkerCompletedEventArgs e)
{
if (e.Error != null)
{
MessageBox.Show(e.Error.Message);
requestState.response.Close();
}
else if (e.Cancelled)
{
MessageBox.Show(String.Format("下载暂停，下载的文件地址为：{0}\n 已经下载的字节数为: {1}字节", downloadPath, DownloadSize));
requestState.response.Close();
requestState.filestream.Close();
this.btnDownload.Enabled = true;
this.btnPause.Enabled = false;
}
else
{
MessageBox.Show(String.Format("下载已完成，下载的文件地址为：{0}，文件的总字节数为: {1}字节", downloadPath, totalSize));
this.btnDownload.Enabled = false;
this.btnPause.Enabled = false;
requestState.response.Close();
requestState.filestream.Close();
}
}
#endregion BackGroundWorker Event
// 获取文件总大小
private void GetTotalSize()
{
HttpWebRequest myHttpWebRequest = (HttpWebRequest)WebRequest.Create(txbUrl.Text.Trim());
HttpWebResponse response = (HttpWebResponse)myHttpWebRequest.GetResponse();
totalSize = response.ContentLength;
response.Close();
}
运行程序点击"下载"按钮然后再点击"暂停"后的结果：
当暂停下载后，我们还可以点 ”下载“按钮继续下载该文件，此时并不会从开开始下载，而会接着上次的下载继续下载(这个实现主要是通过AddRange方法来实现的，该方法是指出向服务器请求文件的大小，上面代码中通过传入DownloadSize来告诉服务器，这次我需要的内容不是从开头开始的，而是从已经下载的文件字节数开始到该文件的总的字节结尾，这样就就实现了断点续传的功能了，使户暂停下载不至于之前下载的都白费了。)，程序的运行结果为：
四、将EAP模型改成基于任务的异步模式TAP
为了演示，以下代码包装了 DownloadStringAsync 方法。 DownloadStringAsync 接受 URI，在下载时引发 DownloadProgressChanged 事件，以报告进度的多个统计信息，并在完成时引发 DownloadStringCompleted 事件。 最终在指定 URI 中返回一个字符串，其中包含页面内容。
public static Task<string> DownloadStringAsync(Uri url)
{
var tcs = new TaskCompletionSource<string>();
var wc = new WebClient();
wc.DownloadStringCompleted += (s,e) =>
{
if (e.Error != null)
tcs.TrySetException(e.Error);
else if (e.Cancelled)
tcs.TrySetCanceled();
else
tcs.TrySetResult(e.Result);
};
wc.DownloadStringAsync(url);
return tcs.Task;
}
五、小结
到这里，本专题的内容就介绍完了，本专题主要介绍.NET 2.0中提出的新的异步编程模式——基于事件的异步编程模式，相信通过本专题的介绍，你将对EAP有一定的了解，并且对BackgroundWorker组件、委托和事件也会有深入地的理解，而不再停留在只会使用该组件阶段，而是到达”会知其然之气所以然“的一个阶段。后面的一个专题将会为大家介绍。NET 4.0中提出的最新的异步编程模式，也是进行异步编程推荐的一种编程模式，即基于任务的编程模式（TAP）。
原文地址：https://www.cnblogs.com/springsnow/p/9400217.html