HttpClient به عنوان جایگزینی برای HttpWebRequest API قدیمی، به همراه NET 4.5. ارائه شد و هدف آن یکپارچه کردن پیاده سازیهای متفاوت موجود به همراه ارائه راهحلی چندسکویی است که از WPF/UWP ، ASP.NET تا NET Core. و iOS/Android را نیز پشتیبانی میکند. تمام قابلیتهای جدید پروتکل HTTP مانند HTTP/2 نیز از این پس تنها به همراه این API ارائه میشوند.
در مطلب «روش استفادهی صحیح از HttpClient در برنامههای دات نت» با روش استفادهی تک وهلهای آن آشنا شدیم. در این مطلب نکات ویژهی دریافت فایلهای حجیم آنرا بررسی خواهیم کرد. بدون توجه به این نکات، یا OutOfMemoryException را دریافت خواهید کرد و یا پیش از پایان کار، با خطای Timeout این پروسه به پایان خواهد رسید.
مشکل اول: نیاز به تغییر Timeout پیش فرض
فرض کنید میخواهیم فایل حجیمی را با تنظیمات پیشفرض HttpClient دریافت کنیم:
در این حالت باتوجه به اینکه Timeout پیشفرض HttpClient به 100 ثانیه تنظیم شدهاست، اگر سرعت دریافت بالایی را نداشته باشید و نتوانید این فایل را پیش از 2 دقیقه دریافت کنید، برنامه با استثنای TaskCancelledException متوقف خواهد شد.
بنابراین اولین تغییر مورد نیاز، تنظیم صریح Timeout آن است:
مشکل دوم: دریافت استثنای OutOfMemoryExceptions
روش دریافت پیشفرض اطلاعات توسط HttpClient، نگهداری و بافر تمام آنها در حافظهی سیستم است. این روش برای اطلاعات کم حجم، مشکلی را به همراه نخواهد داشت. بنابراین در حین دریافت فایلهای چندگیگابایتی با آن، حتما با استثنای OutOfMemoryException مواجه خواهیم شد.
در این حالت برای رفع مشکل، از متد ReadAsStreamAsync آن استفاده میکنیم. به این ترتیب بجای یک آرایهی بزرگ از بایتها، با استریمی از آنها سر و کار داشته و به این صورت مشکل مواجه شدن با کمبود حافظه برطرف میشود.
مشکل: در این حالت اگر برنامه را اجرا کنید، تا پایان کار متد DownloadLargeFileAsync، حجم فایل دریافتی تغییری نخواهد کرد. یعنی هنوز هم کل فایل در حافظه بافر میشود و سپس استریم آن در اختیار FileStream نهایی برای نوشتن قرار خواهد گرفت.
علت اینجا است که متد client.GetAsync تا زمانیکه کل Response ارسالی از طرف سرور خوانده نشود (headers + content)، عملیات را سد کرده و منتظر میماند. بنابراین با این تغییرات عملا به نتیجهی دلخواه نرسیدهایم.
دریافت اطلاعات Header و سپس استریم کردن Content
چون متد client.GetAsync تا دریافت کامل headers + content متوقف میماند، میتوان به آن اعلام کرد تنها هدر را به صورت کامل دریافت کن و سپس باقیماندهی عملیات دریافت بدنهی Response را به صورت Stream در اختیار ادامهی برنامه قرار بده. برای اینکار نیاز است پارامتر HttpCompletionOption را تکمیل کرد:
پارامتر HttpCompletionOption.ResponseHeadersRead به متد GetAsync اعلام میکند که پس از خواندن هدر Response، ادامهی عملیات را در اختیار سطرهای بعدی کد قرار بده و عملیات را تا پایان خواندن کامل Response در حافظه، متوقف نکن.
مشکل سوم: برنامه در دریافت سومین فایل از یک سرور هنگ میکند.
تعداد اتصالات همزمانی را که میتوان توسط HttpClient به یک سرور گشود، محدود هستند. برای مثال این عدد در Full .NET Framework مساوی 2 است. بنابراین اگر اتصال سوم موازی را شروع کنیم، چون Timeout را به بینهایت تنظیم کردهایم، این قسمت از برنامه هیچگاه تکمیل نخواهد شد.
روش تنظیم تعداد اتصالات مجاز به یک سرور:
- در Full .NET Framework با تنظیم خاصیت ServicePointManager.DefaultConnectionLimit است که به 2 تنظیم شدهاست.
- این مورد در NET Core. توسط پارامتر HttpClientHandler و خاصیت MaxConnectionsPerServer آن تنظیم میشود:
البته مقدار پیشفرض آن int.MaxValue است که نسبت به حالت Full .NET Framework عدد بسیار بزرگتری است.
در مطلب «روش استفادهی صحیح از HttpClient در برنامههای دات نت» با روش استفادهی تک وهلهای آن آشنا شدیم. در این مطلب نکات ویژهی دریافت فایلهای حجیم آنرا بررسی خواهیم کرد. بدون توجه به این نکات، یا OutOfMemoryException را دریافت خواهید کرد و یا پیش از پایان کار، با خطای Timeout این پروسه به پایان خواهد رسید.
مشکل اول: نیاز به تغییر Timeout پیش فرض
فرض کنید میخواهیم فایل حجیمی را با تنظیمات پیشفرض HttpClient دریافت کنیم:
using System; using System.Net.Http; using System.Threading.Tasks; namespace HttpClientTips.LargeFiles { class Program { private static readonly HttpClient _client = new HttpClient(); static async Task Main(string[] args) { var bytes = await DownloadLargeFileAsync(); } public static async Task<byte[]> DownloadLargeFileAsync() { Console.WriteLine("Downloading a 4K content - too much bytes."); var response = await _client.GetAsync("http://downloads.4ksamples.com/downloads/sample-Elysium.2013.2160p.mkv"); var bytes = await response.Content.ReadAsByteArrayAsync(); return bytes; } } }
بنابراین اولین تغییر مورد نیاز، تنظیم صریح Timeout آن است:
private static readonly HttpClient _client = new HttpClient { Timeout = Timeout.InfiniteTimeSpan };
مشکل دوم: دریافت استثنای OutOfMemoryExceptions
روش دریافت پیشفرض اطلاعات توسط HttpClient، نگهداری و بافر تمام آنها در حافظهی سیستم است. این روش برای اطلاعات کم حجم، مشکلی را به همراه نخواهد داشت. بنابراین در حین دریافت فایلهای چندگیگابایتی با آن، حتما با استثنای OutOfMemoryException مواجه خواهیم شد.
namespace HttpClientTips.LargeFiles { class Program { private static readonly HttpClient _client = new HttpClient { Timeout = Timeout.InfiniteTimeSpan }; static async Task Main(string[] args) { await DownloadLargeFileAsync(); } public static async Task DownloadLargeFileAsync() { Console.WriteLine("Downloading a 4K content. too much bytes."); var response = await _client.GetAsync("http://downloads.4ksamples.com/downloads/sample-Elysium.2013.2160p.mkv"); using (var streamToReadFrom = await response.Content.ReadAsStreamAsync()) { string fileToWriteTo = Path.GetTempFileName(); Console.WriteLine($"Save path: {fileToWriteTo}"); using (var streamToWriteTo = File.Open(fileToWriteTo, FileMode.Create)) { await streamToReadFrom.CopyToAsync(streamToWriteTo); } } } } }
مشکل: در این حالت اگر برنامه را اجرا کنید، تا پایان کار متد DownloadLargeFileAsync، حجم فایل دریافتی تغییری نخواهد کرد. یعنی هنوز هم کل فایل در حافظه بافر میشود و سپس استریم آن در اختیار FileStream نهایی برای نوشتن قرار خواهد گرفت.
علت اینجا است که متد client.GetAsync تا زمانیکه کل Response ارسالی از طرف سرور خوانده نشود (headers + content)، عملیات را سد کرده و منتظر میماند. بنابراین با این تغییرات عملا به نتیجهی دلخواه نرسیدهایم.
دریافت اطلاعات Header و سپس استریم کردن Content
چون متد client.GetAsync تا دریافت کامل headers + content متوقف میماند، میتوان به آن اعلام کرد تنها هدر را به صورت کامل دریافت کن و سپس باقیماندهی عملیات دریافت بدنهی Response را به صورت Stream در اختیار ادامهی برنامه قرار بده. برای اینکار نیاز است پارامتر HttpCompletionOption را تکمیل کرد:
var response = await _client.GetAsync( "http://downloads.4ksamples.com/downloads/sample-Elysium.2013.2160p.mkv", HttpCompletionOption.ResponseHeadersRead);
مشکل سوم: برنامه در دریافت سومین فایل از یک سرور هنگ میکند.
تعداد اتصالات همزمانی را که میتوان توسط HttpClient به یک سرور گشود، محدود هستند. برای مثال این عدد در Full .NET Framework مساوی 2 است. بنابراین اگر اتصال سوم موازی را شروع کنیم، چون Timeout را به بینهایت تنظیم کردهایم، این قسمت از برنامه هیچگاه تکمیل نخواهد شد.
روش تنظیم تعداد اتصالات مجاز به یک سرور:
- در Full .NET Framework با تنظیم خاصیت ServicePointManager.DefaultConnectionLimit است که به 2 تنظیم شدهاست.
- این مورد در NET Core. توسط پارامتر HttpClientHandler و خاصیت MaxConnectionsPerServer آن تنظیم میشود:
private static readonly HttpClientHandler _handler = new HttpClientHandler { MaxConnectionsPerServer = int.MaxValue, // default for .NET Core UseDefaultCredentials = true }; private static readonly HttpClient _client = new HttpClient(_handler) { Timeout = Timeout.InfiniteTimeSpan };