使用 C# 下載文件的多種方法小結
文件下載是一個軟件開發中的常見需求。本文從最簡單的下載方式開始步步遞進,講述瞭文件下載過程中的常見問題並給出瞭解決方案。並展示瞭如何使用多線程提升 HTTP 的下載速度以及調用 aria2 實現非 HTTP 協議的文件下載。
簡單下載
在 .NET 程序中下載文件最簡單的方式就是使用 WebClient 的 DownloadFile 方法:
var url = "https://www.coderbusy.com"; var save = @"D:\1.html"; using (var web = new WebClient()) { web.DownloadFile(url,save); }
異步下載
該方法也提供異步的實現:
var url = "https://www.coderbusy.com"; var save = @"D:\1.html"; using (var web = new WebClient()) { await web.DownloadFileTaskAsync(url, save); }
下載文件的同時向服務器發送自定義請求頭
如果需要對文件下載請求進行定制,可以使用 HttpClient :
var url = "https://www.coderbusy.com"; var save = @"D:\1.html"; var http = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Get,url); //增加 Auth 請求頭 request.Headers.Add("Auth","123456"); var response = await http.SendAsync(request); response.EnsureSuccessStatusCode(); using (var fs = File.Open(save, FileMode.Create)) { using (var ms = response.Content.ReadAsStream()) { await ms.CopyToAsync(fs); } }
如何解決下載文件不完整的問題
以上所有代碼在應對小文件的下載時沒有特別大的問題,在網絡情況不佳或文件較大時容易引入錯誤。以下代碼在開發中很常見:
var url = "https://www.coderbusy.com"; var save = @"D:\1.html"; if (!File.Exists(save)) { Console.WriteLine("文件不存在,開始下載..."); using (var web = new WebClient()) { await web.DownloadFileTaskAsync(url, save); } Console.WriteLine("文件下載成功"); } Console.WriteLine("開始處理文件"); //TODO:對文件進行處理
如果在 DownloadFileTaskAsync 方法中發生瞭異常(通常是網絡中斷或網絡超時),那麼下載不完整的文件將會保留在本地系統中。在該任務重試執行時,因為文件已存在(雖然它不完整)所以會直接進入處理程序,從而引入異常。
一個簡單的修復方式是引入異常處理,但這種方式對應用程序意外終止造成的文件不完整無效:
var url = "https://www.coderbusy.com"; var save = @"D:\1.html"; if (!File.Exists(save)) { Console.WriteLine("文件不存在,開始下載..."); using (var web = new WebClient()) { try { await web.DownloadFileTaskAsync(url, save); } catch { if (File.Exists(save)) { File.Delete(save); } throw; } } Console.WriteLine("文件下載成功"); } Console.WriteLine("開始處理文件"); //TODO:對文件進行處理
筆者更喜歡的方式是引入一個臨時文件。下載操作將數據下載到臨時文件中,當確定下載操作執行完畢時將臨時文件改名:
var url = "https://www.coderbusy.com"; var save = @"D:\1.html"; if (!File.Exists(save)) { Console.WriteLine("文件不存在,開始下載..."); //先下載到臨時文件 var tmp = save + ".tmp"; using (var web = new WebClient()) { await web.DownloadFileTaskAsync(url, tmp); } File.Move(tmp, save, true); Console.WriteLine("文件下載成功"); } Console.WriteLine("開始處理文件"); //TODO:對文件進行處理
使用 Downloader 進行 HTTP 多線程下載
在網絡帶寬充足的情況下,單線程下載的效率並不理想。我們需要多線程和斷點續傳才可以拿到更好的下載速度。
Downloader 是一個現代化的、流暢的、異步的、可測試的和可移植的 .NET 庫。這是一個包含異步進度事件的多線程下載程序。Downloader 與 .NET Standard 2.0 及以上版本兼容,可以在 Windows、Linux 和 macOS 上運行。
GitHub 開源地址: https://github.com/bezzad/Downloader
NuGet 地址:https://www.nuget.org/packages/Downloader
從 NuGet 安裝 Downloader 之後,創建一個下載配置:
var downloadOpt = new DownloadConfiguration() { BufferBlockSize = 10240, // 通常,主機最大支持8000字節,默認值為8000。 ChunkCount = 8, // 要下載的文件分片數量,默認值為1 MaximumBytesPerSecond = 1024 * 1024, // 下載速度限制為1MB/s,默認值為零或無限制 MaxTryAgainOnFailover = int.MaxValue, // 失敗的最大次數 OnTheFlyDownload = false, // 是否在內存中進行緩存? 默認值是true ParallelDownload = true, // 下載文件是否為並行的。默認值為false TempDirectory = "C:\\temp", // 設置用於緩沖大塊文件的臨時路徑,默認路徑為Path.GetTempPath()。 Timeout = 1000, // 每個 stream reader 的超時(毫秒),默認值是1000 RequestConfiguration = // 定制請求頭文件 { Accept = "*/*", AutomaticDecompression = DecompressionMethods.GZip | DecompressionMethods.Deflate, CookieContainer = new CookieContainer(), // Add your cookies Headers = new WebHeaderCollection(), // Add your custom headers KeepAlive = false, ProtocolVersion = HttpVersion.Version11, // Default value is HTTP 1.1 UseDefaultCredentials = false, UserAgent = $"DownloaderSample/{Assembly.GetExecutingAssembly().GetName().Version.ToString(3)}" } };
創建一個下載服務:
var downloader = new DownloadService(downloadOpt);
配置事件處理器(該步驟可以省略):
// Provide `FileName` and `TotalBytesToReceive` at the start of each downloads // 在每次下載開始時提供 "文件名 "和 "要接收的總字節數"。 downloader.DownloadStarted += OnDownloadStarted; // Provide any information about chunker downloads, like progress percentage per chunk, speed, total received bytes and received bytes array to live streaming. // 提供有關分塊下載的信息,如每個分塊的進度百分比、速度、收到的總字節數和收到的字節數組,以實現實時流。 downloader.ChunkDownloadProgressChanged += OnChunkDownloadProgressChanged; // Provide any information about download progress, like progress percentage of sum of chunks, total speed, average speed, total received bytes and received bytes array to live streaming. // 提供任何關於下載進度的信息,如進度百分比的塊數總和、總速度、平均速度、總接收字節數和接收字節數組的實時流。 downloader.DownloadProgressChanged += OnDownloadProgressChanged; // Download completed event that can include occurred errors or cancelled or download completed successfully. // 下載完成的事件,可以包括發生錯誤或被取消或下載成功。 downloader.DownloadFileCompleted += OnDownloadFileCompleted;
接著就可以下載文件瞭:
string file = @"D:\1.html"; string url = @"https://www.coderbusy.com"; await downloader.DownloadFileTaskAsync(url, file);
下載非 HTTP 協議的文件
除瞭 WebClient 可以下載 FTP 協議的文件之外,上文所示的其他方法隻能下載 HTTP 協議的文件。
aria2 是一個輕量級的多協議和多源命令行下載工具。它支持 HTTP/HTTPS、FTP、SFTP、BitTorrent 和 Metalink。aria2 可以通過內置的 JSON-RPC 和 XML-RPC 接口進行操作。
我們可以調用 aria2 實現文件下載功能。
GitHub 地址:https://github.com/aria2/aria2
下載地址:https://github.com/aria2/aria2/releases
將下載好的 aria2c.exe 復制到應用程序目錄,如果是其他系統則可以下載對應的二進制文件。
public static async Task Download(string url, string fn) { var exe = "aria2c"; var dir = Path.GetDirectoryName(fn); var name = Path.GetFileName(fn); void Output(object sender, DataReceivedEventArgs args) { if (string.IsNullOrWhiteSpace(args.Data)) { return; } Console.WriteLine("Aria:{0}", args.Data?.Trim()); } var args = $"-x 8 -s 8 --dir={dir} --out={name} {url}"; var info = new ProcessStartInfo(exe, args) { UseShellExecute = false, CreateNoWindow = true, RedirectStandardOutput = true, RedirectStandardError = true, }; if (File.Exists(fn)) { File.Delete(fn); } Console.WriteLine("啟動 aria2c: {0}", args); using (var p = new Process { StartInfo = info, EnableRaisingEvents = true }) { if (!p.Start()) { throw new Exception("aria 啟動失敗"); } p.ErrorDataReceived += Output; p.OutputDataReceived += Output; p.BeginOutputReadLine(); p.BeginErrorReadLine(); await p.WaitForExitAsync(); p.OutputDataReceived -= Output; p.ErrorDataReceived -= Output; } var fi = new FileInfo(fn); if (!fi.Exists || fi.Length == 0) { throw new FileNotFoundException("文件下載失敗", fn); } }
以上代碼通過命令行參數啟動瞭一個新的 aria2c 下載進程,並對下載進度信息輸出在瞭控制臺。調用方式如下:
var url = "https://www.coderbusy.com"; var save = @"D:\1.html"; await Download(url, save);
到此這篇關於使用 C# 下載文件的十八般武藝的文章就介紹到這瞭,更多相關C# 下載文件內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet!
推薦閱讀:
- C#使用async和await實現異步編程
- C#目錄和文件管理操作詳解
- Java Stopwatch類,性能與時間計時器案例詳解
- c# Async streams的使用解析
- C#中async和await的深入分析