c#异步下载

转载：http://blog.csdn.net/chinacsharper/article/details/17895737

在C#中 利用WebClient这个核心类，可以轻易的打造一个下载器。但是这里想要强调的是，我们用的是异步操作。所谓异步，是相对于同步的概念而言的。比如Web中的Ajax就是基于异步的。它能够提供良好的用户体验，让用户在进行操作时，不感觉到“卡”（不阻塞UI线程），能够同时进行其它的操作并能够随意的切换到任务界面。在下载文件时，如果文件过大，我们用同步的下载方式进行下载会感觉程序“假死”，其实程序在后台不断的运行，但我们看不到下载的过程。所以这时候使用异步方法能够有效的解决这个问题。

先看一下程序的界面：

实现上面的操作很简单，只需要几行代码就可以搞定。

[csharp]  view plain copy

1. private void button1_Click(object sender, EventArgs e)  
2. {  
3.     using (WebClient client = new WebClient())  
4.     {  
5.         client.DownloadFileAsync(new Uri(this.textBox1.Text.Trim()),Path.GetFileName(this.textBox1.Text.Trim()));  
6.         client.DownloadProgressChanged += client_DownloadProgressChanged;  
7.         client.DownloadFileCompleted += client_DownloadFileCompleted;  
8.     }  
9. }  
10.   
11. void client_DownloadProgressChanged(object sender, DownloadProgressChangedEventArgs e)  
12. {  
13.     this.label1.Text = string.Format("当前接收到{0}字节，文件大小总共{1}字节", e.BytesReceived, e.TotalBytesToReceive);  
14.     this.progressBar1.Value = e.ProgressPercentage;  
15. }  
16.   
17. void client_DownloadFileCompleted(object sender, System.ComponentModel.AsyncCompletedEventArgs e)  
18. {  
19.     if (e.Cancelled)  
20.     {  
21.         MessageBox.Show("文件下载被取消", "提示", MessageBoxButtons.OKCancel);  
22.     }  
23.     this.progressBar1.Value = 0;  
24.     MessageBox.Show("文件下载成功", "提示");  
25. }  

我们只需要在textbox中填入文件的地址，比如迅雷的下载地址：http://dlsw.baidu.com/sw-search-sp/soft/ca/13442/Thunder_dl_7.9.18.4706Preview.2205245239.exe，就可以用上面的代码进行下载了。

在C#当中，还可以利用HttpWebRequest进行文件的异步下载。下面的代码可能稍微有点复杂，但是可以帮助我们深入理解“异步“操作的过程。

我们先定义一个类，用于保存操作的状态：

[csharp]  view plain copy

1. /// <summary>  
2. /// 请求状态  
3. /// </summary>  
4. public class RequestState  
5. {  
6.     /// <summary>  
7.     /// 缓冲区大小  
8.     /// </summary>  
9.     public int BUFFER_SIZE { get; set; }  
10.   
11.     /// <summary>  
12.     /// 缓冲区  
13.     /// </summary>  
14.     public byte[] BufferRead { get; set; }  
15.   
16.     /// <summary>  
17.     /// 保存路径  
18.     /// </summary>  
19.     public string SavePath { get; set; }  
20.   
21.     /// <summary>  
22.     /// 请求流  
23.     /// </summary>  
24.     public HttpWebRequest Request { get; set; }  
25.   
26.     /// <summary>  
27.     /// 响应流  
28.     /// </summary>  
29.     public HttpWebResponse Response { get; set; }  
30.   
31.     /// <summary>  
32.     /// 流对象  
33.     /// </summary>  
34.     public Stream ResponseStream { get; set; }  
35.   
36.     /// <summary>  
37.     /// 文件流  
38.     /// </summary>  
39.     public FileStream FileStream { get; set; }  
40. }  

在一个Button的Click事件下，键入如下代码：

[csharp]  view plain copy

1. //下载文件的url  
2. string url = this.textBox1.Text.Trim();  
3.   
4. //创建一个初始化请求对象  
5. HttpWebRequest request = (HttpWebRequest)WebRequest.Create(new Uri(url));  
6.   
7. //设置下载相关参数  
8. RequestState requestState = new RequestState();  
9. requestState.BUFFER_SIZE = 1024;  
10. requestState.BufferRead = new byte[requestState.BUFFER_SIZE];  
11. requestState.Request = request;  
12. requestState.SavePath = Path.Combine("D:\\", Path.GetFileName(url));  
13. requestState.FileStream = new FileStream(requestState.SavePath, FileMode.OpenOrCreate);  
14.   
15. //开始异步请求资源  
16. request.BeginGetResponse(new AsyncCallback(ResponseCallback), requestState);  

我们可以看到，异步的操作方法一般都是以Begin开头的BeginGetResponse，我们平时用的比较多的同步方法直接使用GetResponse。另外AsyncCallback是一个委托，前面讲过，它里面的参数是一个方法，我们起名为ResponseCallback，并且把requestState作为参数传递过去。

接下来就可以看一下ResponseCallback方法：

[csharp]  view plain copy

1. /// <summary>  
2. /// 请求资源方法的回调函数  
3. /// </summary>  
4. /// <param name="asyncResult">用于在回调函数当中传递操作状态</param>  
5. private void ResponseCallback(IAsyncResult asyncResult)  
6. {  
7.     RequestState requestState = (RequestState)asyncResult.AsyncState;  
8.     requestState.Response = (HttpWebResponse)requestState.Request.EndGetResponse(asyncResult);  
9.   
10.     Stream responseStream = requestState.Response.GetResponseStream();  
11.     requestState.ResponseStream = responseStream;  
12.   
13.     //开始异步读取流  
14.     responseStream.BeginRead(requestState.BufferRead, 0, requestState.BufferRead.Length, ReadCallback, requestState);  
15. }  

我们可以看到，回调函数里面又有一个异步操作。它的任务是对响应流异步的读取到缓冲区当中。

再进一步，看一下ReadCallback回调函数。

[csharp]  view plain copy

1. /// <summary>  
2. /// 异步读取流的回调函数  
3. /// </summary>  
4. /// <param name="asyncResult">用于在回调函数当中传递操作状态</param>  
5. private void ReadCallback(IAsyncResult asyncResult)  
6. {  
7.     RequestState requestState = (RequestState)asyncResult.AsyncState;  
8.     int read = requestState.ResponseStream.EndRead(asyncResult);  
9.     if (read > 0)  
10.     {  
11.         //将缓冲区的数据写入该文件流  
12.         requestState.FileStream.Write(requestState.BufferRead, 0, read);  
13.   
14.         //开始异步读取流  
15.         requestState.ResponseStream.BeginRead(requestState.BufferRead, 0, requestState.BufferRead.Length, ReadCallback, requestState);  
16.     }  
17.     else  
18.     {  
19.         requestState.Response.Close();  
20.         requestState.FileStream.Close();  
21.     }  
22. }  

这里面是真正的将流写入文件的过程，并且用BeginRead方法递归的写入文件流直到文件完全写好为止（完全下载到本地）。

上面我参考了官方网站上面的代码，可以在这里查询到：BeginGetResponse。这是一个经典的异步操作的例子，希望大家能够好好理解。