小小一方士 C# Async\Await 之 上传/下载文件进度条实现原理

关于上传下载文件(图片等),涉及到UI进度条的显示,c#中 System.IProgress提供了相应的api.

namespace System
{
    //
    // 摘要:
    //     定义进度更新的提供程序。
    //
    // 类型参数:
    //   T:
    //     进度更新值的类型。此类型参数是逆变。即可以使用指定的类型或派生程度更低的类型。有关协变和逆变的详细信息，请参阅 泛型中的协变和逆变。
    public interface IProgress<in T>
    {
        //
        // 摘要:
        //     报告进度更新。
        //
        // 参数:
        //   value:
        //     进度更新之后的值。
        void Report(T value);
    }
}

对于多个文件的使用,这个使用还是很不错的选择,如下为相关使用代码:

  async Task<int> UploadPicturesAsync(List<object> imageList, IProgress<int> progress, CancellationToken ct)
        {
            try
            {
                int totalCount = imageList.Count;
                int processCount = await Task.Run<int>(() =>
                {
                    int tempCount = 0;
                    foreach (var image in imageList)
                    {
                        //await the processing and uploading logic here
                        //int processed = await UploadAndProcessAsync(image);
                        // 异步上传/下载方法
                        bool success = Task.Run(async () =>
                                  {
                                      await Task.Delay(2000);
                                      return image.ToString() == "取消" ? false : true;
                                  }).Result;
                        if (ct.IsCancellationRequested)     //判断是否取消
                        {
                            ct.ThrowIfCancellationRequested();
                        }  
                        if (progress != null)
                        {
                            progress.Report((tempCount * 100 / totalCount));
                        }
                        tempCount++;
                    }

                    return tempCount;
                });
                return processCount;
            }
            catch (OperationCanceledException ex)
            {    
                throw ex;
            }
        }
        // 向应该被取消的 System.Threading.CancellationToken 发送信号
        // cts.Token 传播有关应取消操作的通知。
        CancellationTokenSource cts = new CancellationTokenSource();
        /// <summary>
        /// 进度条 异步上传   异步上传button
        /// </summary>
        public async void ProgressBar()
        {
            //construct Progress<T>, passing ReportProgress as the Action<T> 
            //Progress 提供调用每个报告进度的值的回调的 
            var progressIndicator = new Progress<int>(ReportProgress);
            //call async method
            // 模拟上传/下载文件
            List<object> files = new List<object>
            {
                1,2,"取消",3,4,5,2,4,11
            };
            try
            {
                int uploads = await UploadPicturesAsync(files, progressIndicator, cts.Token);
                Console.WriteLine($"upload Count=>{uploads}");
            }
            catch (OperationCanceledException ex)
            {
                Console.WriteLine($"上传已取消:{ex.Message}");
            }
        }
        /// <summary>
        /// UI线程交互
        /// </summary>
        /// <param name="value"></param>
        void ReportProgress(int value)
        {
            //UI 线程显示进度信息
            Console.WriteLine($"{value}%");
            if (value == 33)   //模拟 取消按钮处理
            {
                cts.Cancel();
            }
            //Update the UI to reflect the progress value that is passed back.
        }

 参考:https://devblogs.microsoft.com/dotnet/async-in-4-5-enabling-progress-and-cancellation-in-async-apis/