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。這是一個經典的異步操作的例子，希望大家能夠好好理解。