C# 文件下載 : 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 下載