增加文件上传进度事件

Author: xljiulang

WebApiClient/HttpResponseFile.cs

@@ -16,7 +16,7 @@ public class HttpResponseFile : HttpResponseWrapper
         /// <summary>
         /// 下载进度变化事件
         /// </summary>
-        public event EventHandler<DownloadProgressEventArgs> DownloadProgressChanged;
+        public event EventHandler<ProgressEventArgs> DownloadProgressChanged;
 
         /// <summary>
         /// 获取响应的友好文件名称
@@ -95,20 +95,20 @@ public async Task SaveAsAsync(Stream stream)
             var buffer = new byte[8 * 1024];
             var sourceStream = await this.HttpResponse.Content.ReadAsStreamAsync().ConfigureAwait(false);
 
-            var args = new DownloadProgressEventArgs(current, this.FileSize, false);
+            var args = new ProgressEventArgs(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);
+                args = new ProgressEventArgs(current, this.FileSize, false);
                 this.DownloadProgressChanged?.Invoke(this, args);
 
                 await stream.WriteAsync(buffer, 0, length).ConfigureAwait(false);
             }
 
-            args = new DownloadProgressEventArgs(current, this.FileSize, true);
+            args = new ProgressEventArgs(current, this.FileSize, true);
             this.DownloadProgressChanged?.Invoke(this, args);
         }
     }

WebApiClient/Parameterables/MulitpartFile.cs

@@ -28,6 +28,11 @@ public class MulitpartFile : IApiParameterable
         /// </summary>
         private readonly string fileName;
 
+        /// <summary>
+        /// 上传进度变化事件
+        /// </summary>
+        public event EventHandler<ProgressEventArgs> UploadProgressChanged;
+
         /// <summary>
         /// 获取文件好友名称
         /// </summary>
@@ -100,23 +105,158 @@ public MulitpartFile(string localFilePath)
         /// <param name="parameter">特性关联的参数</param>
         async Task IApiParameterable.BeforeRequestAsync(ApiActionContext context, ApiParameterDescriptor parameter)
         {
-            context.RequestMessage.AddMulitpartFile(this.GetStream(), parameter.Name, this.FileName, this.ContentType);
+            context.RequestMessage.AddMulitpartFile(this.GetUploadStream(), parameter.Name, this.FileName, this.ContentType);
             await ApiTask.CompletedTask;
         }
 
         /// <summary>
         /// 获取文件流
         /// </summary>
         /// <returns></returns>
-        private Stream GetStream()
+        private UploadStream GetUploadStream()
+        {
+            var inner = this.stream ?? new FileStream(this.filePath, FileMode.Open, FileAccess.Read);
+            return new UploadStream(inner, this.RaiseUploadProgressChanged);
+        }
+
+        /// <summary>
+        /// 触发上传进度变化事件
+        /// </summary>
+        /// <param name="e"></param>
+        private void RaiseUploadProgressChanged(ProgressEventArgs e)
+        {
+            this.UploadProgressChanged?.Invoke(this, e);
+        }
+
+
+        /// <summary>
+        /// 表示上传数据流
+        /// </summary>
+        private class UploadStream : Stream
         {
-            if (this.stream != null)
+            /// <summary>
+            /// 内部流
+            /// </summary>
+            private readonly Stream inner;
+
+            /// <summary>
+            /// 总字节数
+            /// </summary>
+            private readonly long? totalBytes;
+
+            /// <summary>
+            /// 进度事件处理者
+            /// </summary>
+            private readonly Action<ProgressEventArgs> eventArgsHandler;
+
+            /// <summary>
+            /// 记录当前字节数
+            /// </summary>
+            private long currentBytes = 0L;
+
+            /// <summary>
+            /// 上传数据流
+            /// </summary>
+            /// <param name="inner">内部流</param>
+            /// <param name="eventArgsHandler">进度事件处理者</param>
+            /// <exception cref="ArgumentNullException"></exception>
+            public UploadStream(Stream inner, Action<ProgressEventArgs> eventArgsHandler)
             {
-                return this.stream;
+                this.inner = inner ?? throw new ArgumentNullException(nameof(inner));
+                this.eventArgsHandler = eventArgsHandler ?? throw new ArgumentNullException(nameof(eventArgsHandler));
+
+                try
+                {
+                    this.totalBytes = inner.Length;
+                }
+                catch (Exception) { }
             }
-            else
+
+            /// <summary>
+            /// 获取是否可读
+            /// </summary>
+            public override bool CanRead => this.inner.CanRead;
+
+            /// <summary>
+            /// 获取是否可定位
+            /// </summary>
+            public override bool CanSeek => this.inner.CanSeek;
+
+            /// <summary>
+            /// 获取是否可写
+            /// </summary>
+            public override bool CanWrite => this.inner.CanWrite;
+
+            /// <summary>
+            /// 获取数据长度
+            /// </summary>
+            public override long Length => this.inner.Length;
+
+            /// <summary>
+            /// 获取数据指针公交车
+            /// </summary>
+            public override long Position
+            {
+                get => this.inner.Position;
+                set => this.inner.Position = value;
+            }
+
+            /// <summary>
+            /// 冲刷
+            /// </summary>
+            public override void Flush()
+            {
+                this.inner.Flush();
+            }
+
+            /// <summary>
+            /// 读取数据
+            /// </summary>
+            /// <param name="buffer"></param>
+            /// <param name="offset"></param>
+            /// <param name="count"></param>
+            /// <returns></returns>
+            public override int Read(byte[] buffer, int offset, int count)
+            {
+                var length = this.inner.Read(buffer, offset, count);
+                var isCompleted = length == 0;
+
+                this.currentBytes = this.currentBytes + length;
+                var args = new ProgressEventArgs(this.currentBytes, this.totalBytes, isCompleted);
+                this.eventArgsHandler.Invoke(args);
+
+                return length;
+            }
+
+            /// <summary>
+            /// 定位
+            /// </summary>
+            /// <param name="offset"></param>
+            /// <param name="origin"></param>
+            /// <returns></returns>
+            public override long Seek(long offset, SeekOrigin origin)
+            {
+                return this.inner.Seek(offset, origin);
+            }
+
+            /// <summary>
+            /// 设置长度
+            /// </summary>
+            /// <param name="value"></param>
+            public override void SetLength(long value)
+            {
+                this.inner.SetLength(value);
+            }
+
+            /// <summary>
+            /// 写入数据
+            /// </summary>
+            /// <param name="buffer"></param>
+            /// <param name="offset"></param>
+            /// <param name="count"></param>
+            public override void Write(byte[] buffer, int offset, int count)
             {
-                return new FileStream(this.filePath, FileMode.Open, FileAccess.Read);
+                this.inner.Write(buffer, offset, count);
             }
         }
     }

WebApiClient/DownloadProgressEventArgs.cs renamed to WebApiClient/ProgressEventArgs.cs

@@ -3,12 +3,12 @@
 namespace WebApiClient
 {
     /// <summary>
-    /// 表示下载进度
+    /// 表示上传或下载进度
     /// </summary>
-    public class DownloadProgressEventArgs : EventArgs
+    public class ProgressEventArgs : EventArgs
     {
         /// <summary>
-        /// 获取当前收到的字节数
+        /// 获取当前完成的字节数
         /// </summary>
         public long CurrentBytes { get; }
 
@@ -38,12 +38,12 @@ public double Progress
         }
 
         /// <summary>
-        /// 下载进度
+        /// 上传或下载进度
         /// </summary>
-        /// <param name="current">当前收到的字节数</param>
+        /// <param name="current">当前完成的字节数</param>
         /// <param name="total">总字节数</param>
         /// <param name="isCompleted">是否已完成</param>
-        public DownloadProgressEventArgs(long current, long? total, bool isCompleted)
+        public ProgressEventArgs(long current, long? total, bool isCompleted)
         {
             this.CurrentBytes = current;
             this.TotalBytes = total;