C# 异步下载文件

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

先看一下程序的界面：

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

private void button1_Click(object sender, EventArgs e)
{
    using (WebClient client = new WebClient())
    {
        client.DownloadFileAsync(new Uri(this.textBox1.Text.Trim()),Path.GetFileName(this.textBox1.Text.Trim()));
        client.DownloadProgressChanged += client_DownloadProgressChanged;
        client.DownloadFileCompleted += client_DownloadFileCompleted;
    }
}
                              
void client_DownloadProgressChanged(object sender, DownloadProgressChangedEventArgs e)
{
    this.label1.Text = string.Format("当前接收到{0}字节，文件大小总共{1}字节", e.BytesReceived, e.TotalBytesToReceive);
    this.progressBar1.Value = e.ProgressPercentage;
}
                              
void client_DownloadFileCompleted(object sender, System.ComponentModel.AsyncCompletedEventArgs e)
{
    if (e.Cancelled)
    {
        MessageBox.Show("文件下载被取消", "提示", MessageBoxButtons.OKCancel);
    }
    this.progressBar1.Value = 0;
    MessageBox.Show("文件下载成功", "提示");
}

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

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

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

/// <summary>
/// 请求状态
/// </summary>
public class RequestState
{
    /// <summary>
    /// 缓冲区大小
    /// </summary>
    public int BUFFER_SIZE { get; set; }
                          
    /// <summary>
    /// 缓冲区
    /// </summary>
    public byte[] BufferRead { get; set; }
                          
    /// <summary>
    /// 保存路径
    /// </summary>
    public string SavePath { get; set; }
                          
    /// <summary>
    /// 请求流
    /// </summary>
    public HttpWebRequest Request { get; set; }
                          
    /// <summary>
    /// 响应流
    /// </summary>
    public HttpWebResponse Response { get; set; }
                          
    /// <summary>
    /// 流对象
    /// </summary>
    public Stream ResponseStream { get; set; }
                          
    /// <summary>
    /// 文件流
    /// </summary>
    public FileStream FileStream { get; set; }
}

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

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

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

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

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

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

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

/// <summary>
/// 异步读取流的回调函数
/// </summary>
/// <param name="asyncResult">用于在回调函数当中传递操作状态</param>
private void ReadCallback(IAsyncResult asyncResult)
{
    RequestState requestState = (RequestState)asyncResult.AsyncState;
    int read = requestState.ResponseStream.EndRead(asyncResult);
    if (read > 0)
    {
        //将缓冲区的数据写入该文件流
        requestState.FileStream.Write(requestState.BufferRead, 0, read);
         
        //开始异步读取流
        requestState.ResponseStream.BeginRead(requestState.BufferRead, 0, requestState.BufferRead.Length, ReadCallback, requestState);
    }
    else
    {
        requestState.Response.Close();
        requestState.FileStream.Close();
    }
}

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

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