Winform文件下載之WebClient

最近升級了公司內部使用的一個下載小工具，主要提升了下面幾點：

1． 在一些分公司的局域網中，連接不上外網

2． 服務器上的文件更新后，下載到的還是更新前的文件

3． 沒有下載進度提示

4． 不能終止下載

下面和大家分享一些心得。

鑒于各種復雜的網絡環境，筆者決定采用不同的編程接口進行下載嘗試，以增加程序的可用性。

這里僅介紹使用WebClient的方法。博文中主要介紹思路和關鍵代碼，完整的demo附在文末。

使用代理訪問網絡

很多公司的員工都是通過公司設置的代理上網的。通過代理上網主要是方便公司進行各種的管制，當然也能實現一些特殊的功能… 不過這會給我們的程序訪問網絡帶來一些問題。

其實，WebClient中的API已經很智能了，比如我們創建的HttpWebRequest對象，它自帶一個Proxy屬性。也就是說，WebHttpRequest默認會使用找到的代理。這很棒，也能處理很多情況了。可是如果這個默認的代理需要驗證域用戶的身份信息，這時使用WebHttpRequest訪問網絡就可能失敗。此時查看 Proxy. Credentials屬性，發現它是null.

從WebClient的API中是可以取到系統默認的Credentials的，只是不太清楚為什么Proxy.Credentials屬性默認沒有設置為這個值。我們自己設置下就可以了。

request.Proxy.Credentials = CredentialCache.DefaultCredentials;

但實際的網絡環境可能會更復雜，需要用戶來指定聯網的代理，并同時指定聯網所需的Credentials。寫法如下：

myProxy = new WebProxy(“proxyAddress”); 

myProxy.Credentials = new NetworkCredential(ProxyUserName, ProxyUserPasswd, DomainName);

克服緩存

緩存可謂無處不再，在服務器端CDN會有緩存，在客戶端的代理層也會有緩存。所以經常出現的問題是：服務器上的文件明明更新了，還是會有一些客戶下載到舊文件。我們先來處理客戶端的緩存問題。

HttpWebRequest的CachePolicy.Level屬性就是設置緩存策略的，只是它的默認值是 BypassCache. 我們把它改為 Reload就行了:

request.CachePolicy = new System.Net.Cache.RequestCachePolicy(System.Net.Cache.RequestCacheLevel.Reload);

接下是服務器端的緩存問題。

現在大家好像都在使用CDN，可在使用中經常發現CDN端的緩存更新有問題。在網上查了查也沒有什么好的解決辦法，不過倒是有一個很好的workaround，就是在請求中添加一個隨機的字符串作為參數。

Random rdm = new Random();

string s = rdm.Next().ToString();

myUrl += "?" + s;

需要注意的是，關于緩存，一定要使用符合當前用例的策略，且不可搞一刀切。

更友好的下載過程

使用滾動條顯示下載進度，顯示實時的下載速度，允許用戶取消下載

下面是下載用的核心代碼，我們把它分為計算下載百分比和計算當前下載速度分別介紹。

// 獲得下載文件的長度

double contentLength = DownloadManager.GetContentLength(myHttpWebClient);

byte[] buffer = new byte[BufferSize];

long downloadedLength = 0;

long currentTimeSpanDataLength = 0;         

int currentDataLength;

while ((currentDataLength = stream.Read(buffer, 0, BufferSize)) > 0 && !this._cancelDownload)

{

    fileStream.Write(buffer, 0, currentDataLength);

    downloadedLength += (long)currentDataLength;

    currentTimeSpanDataLength += (long)currentDataLength;

    int intDownloadSpeed = 0;

    if (this._downloadStopWatch.ElapsedMilliseconds > 800)

    {

        double num5 = (double)currentTimeSpanDataLength / 1024.0;

        double num6 = (double)this._downloadStopWatch.ElapsedMilliseconds / 1000.0;

        double doubleDownloadSpeed = num5 / num6;

        intDownloadSpeed = (int)Math.Round(doubleDownloadSpeed, 0);

        this._downloadStopWatch.Reset();

        this._downloadStopWatch.Start();

        currentTimeSpanDataLength = 0;

    }

    double doubleDownloadPersent = 0.0;

    if (contentLength > 0.0)

    {

        doubleDownloadPersent = (double)downloadedLength / contentLength;

}

}

在下載的過程中計算下載百分比

首先需要從http請求中獲得要下載文件的長度，細節請參考本文所配demo.

double contentLength = DownloadManager.GetContentLength(myHttpWebClient);

每從文件流中讀取一次數據，我們知道讀了多少個字節(currentDataLength)，累計下來就是當前已經下載了的文件長度。

downloadedLength += (long)currentDataLength;

然后做個除法就行了：

doubleDownloadPersent = (double)downloadedLength / contentLength;

計算實時的下載速度

對于當前的下載速度，我們計算過去的一段時間內下載下來的字節數。時間段可以使用StopWatch來獲得，我選擇的時間段要求大于800毫秒。

if (this._downloadStopWatch.ElapsedMilliseconds > 800)

{

    /***********************************/

    // 計算上一個時間段內的下載速度

    double num5 = (double)currentTimeSpanDataLength / 1024.0;

    double num6 = (double)this._downloadStopWatch.ElapsedMilliseconds / 1000.0;

    double doubleDownloadSpeed = num5 / num6;

    /***********************************/

intDownloadSpeed = (int)Math.Round(doubleDownloadSpeed, 0);

// 本次網速計算完成后重置時間計時器和數據計數器，開始下次的計算

    this._downloadStopWatch.Reset();

    this._downloadStopWatch.Start();

    currentTimeSpanDataLength = 0;

}

事實上每次計算下載速度的時間段長度是不顧定的，但這并不影響計算結果，我只要保證距離上次計算超過了800毫秒就行了。

允許用戶取消下載

對于一個執行時間比較長的任務來說，不允許用戶取消它是被深惡痛絕的！尤其是網速不太好的時候。所以我們需要給用戶一個選擇：可以痛快(而不是痛苦)的結束當前的旅程。

而這一切對我們來說又是那么的簡單！

while ((currentDataLength = stream.Read(buffer, 0, BufferSize)) > 0 && !this._cancelDownload){}

當從數據流中讀取數據時，我們檢查用戶是不是按下了“取消”按鈕，就是這里的 this._cancelDownload 變量。如果它是 true就結束當前的下載。     

至此，把用戶抱怨最多的幾個點都搞定了。其實也沒有增加多少代碼，并且每個知識點看起來都是那么的細微。但很明顯的提高了用戶的使用體驗。這也給我們帶來了一些啟發，完成主要功能可能只是工作中的一部分，另外的一些工作可能并不是那么明顯，需要我們不斷的體會，發覺…

Demo 下載