增加文件上传进度事件

Author: xljiulang

WebApiClient/Contexts/ApiActionContext.cs

@@ -164,8 +164,12 @@ private async Task ExecRequestAsync()
             {
                 try
                 {
+                    var completionOption = this.ApiActionDescriptor.Return.DataType.IsHttpResponseWrapper ?
+                        HttpCompletionOption.ResponseHeadersRead :
+                        HttpCompletionOption.ResponseContentRead;
+
                     this.ResponseMessage = await this.HttpApiConfig.HttpClient
-                        .SendAsync(this.RequestMessage, cancellation.Token)
+                        .SendAsync(this.RequestMessage, completionOption, cancellation.Token)
                         .ConfigureAwait(false);
 
                     this.Result = await this.ApiActionDescriptor.Return.Attribute

WebApiClient/DownloadProgressEventArgs.cs

@@ -0,0 +1,62 @@
+using System;
+
+namespace WebApiClient
+{
+    /// <summary>
+    /// 表示下载进度
+    /// </summary>
+    public class DownloadProgressEventArgs : EventArgs
+    {
+        /// <summary>
+        /// 获取当前收到的字节数
+        /// </summary>
+        public long CurrentBytes { get; }
+
+        /// <summary>
+        /// 获取总字节数
+        /// </summary>
+        public long? TotalBytes { get; }
+
+        /// <summary>
+        /// 获取是否已完成
+        /// </summary>
+        public bool IsCompleted { get; }
+
+        /// <summary>
+        /// 获取当前进度
+        /// </summary>
+        public double Progress
+        {
+            get
+            {
+                if (this.TotalBytes == null)
+                {
+                    return 0.00d;
+                }
+                return (double)this.CurrentBytes / (double)this.TotalBytes.Value;
+            }
+        }
+
+        /// <summary>
+        /// 下载进度
+        /// </summary>
+        /// <param name="current">当前收到的字节数</param>
+        /// <param name="total">总字节数</param>
+        /// <param name="isCompleted">是否已完成</param>
+        public DownloadProgressEventArgs(long current, long? total, bool isCompleted)
+        {
+            this.CurrentBytes = current;
+            this.TotalBytes = total;
+            this.IsCompleted = isCompleted;
+        }
+
+        /// <summary>
+        /// 转换为字符串
+        /// </summary>
+        /// <returns></returns>
+        public override string ToString()
+        {
+            return $"{Math.Round(this.Progress * 100, 2)}%";
+        }
+    }
+}

WebApiClient/HttpResponseFile.cs

@@ -13,6 +13,11 @@ namespace WebApiClient
     [DebuggerDisplay("FileName = {FileName}")]
     public class HttpResponseFile : HttpResponseWrapper
     {
+        /// <summary>
+        /// 下载进度变化事件
+        /// </summary>
+        public event EventHandler<DownloadProgressEventArgs> DownloadProgressChanged;
+
         /// <summary>
         /// 获取响应的友好文件名称
         /// </summary>
@@ -86,13 +91,25 @@ public async Task SaveAsAsync(Stream stream)
             }
 
             var length = 0;
+            var current = 0L;
             var buffer = new byte[8 * 1024];
             var sourceStream = await this.HttpResponse.Content.ReadAsStreamAsync().ConfigureAwait(false);
 
+            var args = new DownloadProgressEventArgs(current, this.FileSize, false);
+            this.DownloadProgressChanged?.Invoke(this, args);
+
             while ((length = await sourceStream.ReadAsync(buffer, 0, buffer.Length).ConfigureAwait(false)) > 0)
             {
+                current = current + length;
+
+                args = new DownloadProgressEventArgs(current, this.FileSize, false);
+                this.DownloadProgressChanged?.Invoke(this, args);
+
                 await stream.WriteAsync(buffer, 0, length).ConfigureAwait(false);
             }
+
+            args = new DownloadProgressEventArgs(current, this.FileSize, true);
+            this.DownloadProgressChanged?.Invoke(this, args);
         }
     }
 }