使用 HttpClient 在 .NET 中實(shí)現(xiàn)進(jìn)度條

在 .NET 4.5 中引入的 IProgress<T> 接口允許處理異步進(jìn)度報(bào)告，從而為使用 HttpClient 下載文件實(shí)現(xiàn)進(jìn)度條功能。

使用 IProgress<T> 的擴(kuò)展方法

為 HttpClient 的 DownloadAsync 操作創(chuàng)建一個(gè)擴(kuò)展方法，該方法接受 IProgress<float> 實(shí)現(xiàn)作為參數(shù)。此實(shí)現(xiàn)將使用下載狀態(tài)更新進(jìn)度條或 UI。

public static async Task DownloadAsync(this HttpClient client, string requestUri, Stream destination, IProgress<float> progress = null, CancellationToken cancellationToken = default)
{
    // 首先獲取 http 頭信息以檢查內(nèi)容長度
    using (var response = await client.GetAsync(requestUri, HttpCompletionOption.ResponseHeadersRead))
    {
        var contentLength = response.Content.Headers.ContentLength;

        using (var download = await response.Content.ReadAsStreamAsync(cancellationToken))
        {
            // 未傳遞進(jìn)度報(bào)告器或內(nèi)容長度未知時(shí)忽略進(jìn)度報(bào)告
            if (progress == null || !contentLength.HasValue)
            {
                await download.CopyToAsync(destination);
                return;
            }

            // 將絕對進(jìn)度（已下載字節(jié)數(shù)）轉(zhuǎn)換為相對進(jìn)度（0% - 100%）
            var relativeProgress = new Progress<long>(totalBytes => progress.Report((float)totalBytes / contentLength.Value));
            // 使用擴(kuò)展方法在下載時(shí)報(bào)告進(jìn)度
            await download.CopyToAsync(destination, 81920, relativeProgress, cancellationToken);
            progress.Report(1); // 報(bào)告100%完成
        }
    }
}

在此方法中，progress.Report() 方法會(huì)將當(dāng)前下載進(jìn)度（百分比）傳遞給您的 IProgress<float> 實(shí)現(xiàn)，從而允許它相應(yīng)地更新進(jìn)度條或其他 UI 元素。

流擴(kuò)展用于進(jìn)度報(bào)告

為了在將數(shù)據(jù)寫入目標(biāo)流時(shí)處理實(shí)際的進(jìn)度報(bào)告，請考慮為 Stream 類創(chuàng)建一個(gè)擴(kuò)展方法。

public static async Task CopyToAsync(this Stream source, Stream destination, int bufferSize, IProgress<long> progress = null, CancellationToken cancellationToken = default)
{
    if (source == null)
        throw new ArgumentNullException(nameof(source));
    if (!source.CanRead)
        throw new ArgumentException("必須可讀", nameof(source));
    if (destination == null)
        throw new ArgumentNullException(nameof(destination));
    if (!destination.CanWrite)
        throw new ArgumentException("必須可寫", nameof(destination));
    if (bufferSize < 0)
        throw new ArgumentOutOfRangeException(nameof(bufferSize));

    var buffer = new byte[bufferSize];
    long totalBytesRead = 0;
    int bytesRead;
    while ((bytesRead = await source.ReadAsync(buffer, 0, buffer.Length, cancellationToken).ConfigureAwait(false)) != 0)
    {
        await destination.WriteAsync(buffer, 0, bytesRead, cancellationToken).ConfigureAwait(false);
        totalBytesRead += bytesRead;
        progress?.Report(totalBytesRead);
    }
}

此擴(kuò)展方法監(jiān)視寫入目標(biāo)流的字節(jié)數(shù)，并使用傳入的 IProgress<long> 實(shí)現(xiàn)報(bào)告進(jìn)度。

通過組合這些擴(kuò)展方法，您可以輕松地為使用 HttpClient 的文件下載操作實(shí)現(xiàn)進(jìn)度條功能。

以上是如何在.NET中使用HttpClient實(shí)現(xiàn)進(jìn)度條？的詳細(xì)內(nèi)容。更多信息請關(guān)注PHP中文網(wǎng)其他相關(guān)文章！