HttpClient を使用して .NET にプログレス バーを?qū)g裝する

.NET 4.5 で導(dǎo)入された IProgress<T> インターフェイスでは、非同期の進行狀況レポートの処理が可能になり、HttpClient を使用してファイルをダウンロードするための進行狀況バー機能が実裝されます。

IProgress<T>

パラメータとして DownloadAsync 実裝を受け入れる HttpClient の IProgress<float> オペレーションの拡張メソッドを作成します。この実裝により、進行狀況バーまたは 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))
        {
            // 未傳遞進度報告器或內(nèi)容長度未知時忽略進度報告
            if (progress == null || !contentLength.HasValue)
            {
                await download.CopyToAsync(destination);
                return;
            }

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

このメソッドでは、progress.Report() メソッドが現(xiàn)在のダウンロードの進行狀況 (パーセント単位) を IProgress<float> 実裝に渡し、それに応じて進行狀況バーやその他の UI 要素を更新できるようにします。

進行狀況レポート用のストリーム拡張機能

データがターゲット ストリームに書き込まれるときに実際の進行狀況レポートを処理するには、Stream クラスの拡張メソッドを作成することを検討してください。

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);
    }
}

この拡張メソッドは、ターゲット ストリームに書き込まれたバイト數(shù)を監(jiān)視し、渡された IProgress<long> 実裝を使用して進行狀況を報告します。

これらの拡張メソッドを組み合わせることで、HttpClient を使用したファイル ダウンロード操作のプログレス バー機能を簡単に実裝できます。

以上が.NET で HttpClient を使用してプログレス バーを?qū)g裝するにはどうすればよいですか?の詳細內(nèi)容です。詳細については、PHP 中國語 Web サイトの他の関連記事を參照してください。