TimeoutAttribute支持修饰参数

Author: xljiulang

WebApiClient.Test/Attributes/HttpActionAttributes/TimeoutAttributeTest.cs

@@ -0,0 +1,56 @@
+using System;
+using System.Net.Http;
+using System.Threading.Tasks;
+using WebApiClient;
+using WebApiClient.Attributes;
+using WebApiClient.Contexts;
+using Xunit;
+
+
+namespace WebApiClient.Test.Attributes
+{
+    public class TimeoutAttributeTest
+    {
+        [Fact]
+        public async Task BeforeRequestAsyncTest()
+        {
+            var context = new TestActionContext(
+                httpApi: null,
+                httpApiConfig: new HttpApiConfig(),
+                apiActionDescriptor: new ApiActionDescriptor(typeof(IMyApi).GetMethod("PostAsync")));
+
+            var attr = new TimeoutAttribute(50);
+            await attr.BeforeRequestAsync(context);
+
+            await Task.Delay(100);
+            var canceled = context.CancellationTokens[0].IsCancellationRequested;
+            Assert.True(canceled);
+        }
+
+        [Fact]
+        public async Task BeforeRequestAsync_ParameterTest()
+        {
+            var context = new TestActionContext(
+                httpApi: null,
+                httpApiConfig: new HttpApiConfig(),
+                apiActionDescriptor: new ApiActionDescriptor(typeof(IMyApi).GetMethod("PostAsync")));
+
+            IApiParameterAttribute attr = new TimeoutAttribute(50);
+
+            var parameter = context.ApiActionDescriptor.Parameters[0].Clone(10);
+            await attr.BeforeRequestAsync(context, parameter);
+
+            await Task.Delay(20);
+            var canceled = context.CancellationTokens[0].IsCancellationRequested;
+            Assert.True(canceled);
+
+
+            parameter = context.ApiActionDescriptor.Parameters[0].Clone(TimeSpan.FromMilliseconds(5));
+            await attr.BeforeRequestAsync(context, parameter);
+
+            await Task.Delay(10);
+            canceled = context.CancellationTokens[0].IsCancellationRequested;
+            Assert.True(canceled);
+        }
+    }
+}

WebApiClient.Test/Attributes/TimeoutAttributeTest.cs

@@ -59,7 +59,7 @@ public override async Task BeforeRequestAsync(ApiActionContext context)
         {
             if (string.IsNullOrEmpty(this.name))
             {
-                throw new NotSupportedException($"请传入name和value参数：{nameof(FormFieldAttribute)}");
+                throw new HttpApiConfigException($"请传入name和value参数：{nameof(FormFieldAttribute)}");
             }
 
             if (this.IsIgnoreWith(this.value) == false)

WebApiClient/Attributes/FormFieldAttribute.cs

@@ -59,7 +59,7 @@ public override async Task BeforeRequestAsync(ApiActionContext context)
         {
             if (string.IsNullOrEmpty(this.name))
             {
-                throw new NotSupportedException($"请传入name和value参数：{nameof(MulitpartTextAttribute)}");
+                throw new HttpApiConfigException($"请传入name和value参数：{nameof(MulitpartTextAttribute)}");
             }
 
             if (this.IsIgnoreWith(this.value) == false)

WebApiClient/Attributes/HttpActionAttributes/TimeoutAttribute.cs

@@ -0,0 +1,108 @@
+using System;
+using System.Diagnostics;
+using System.Threading;
+using System.Threading.Tasks;
+using WebApiClient.Contexts;
+
+namespace WebApiClient.Attributes
+{
+    /// <summary>
+    /// 表示此请求的超时时间
+    /// </summary>
+    [DebuggerDisplay("Timeout = {TimeSpan}")]
+    [AttributeUsage(AttributeTargets.Interface | AttributeTargets.Method | AttributeTargets.Parameter, AllowMultiple = false, Inherited = true)]
+    public class TimeoutAttribute : ApiActionAttribute, IApiParameterAttribute
+    {
+        /// <summary>
+        /// 获取超时时间
+        /// </summary>
+        public TimeSpan? TimeSpan { get; private set; }
+
+        /// <summary>
+        /// 表示将参数值作为请求的超时时间
+        /// </summary>
+        public TimeoutAttribute()
+        {
+        }
+
+        /// <summary>
+        /// 指定请求的超时时间
+        /// </summary>
+        /// <param name="milliseconds">超时时间的毫秒数</param>
+        public TimeoutAttribute(int milliseconds)
+            : this((double)milliseconds)
+        {
+        }
+
+        /// <summary>
+        /// 指定请求的超时时间
+        /// </summary>
+        /// <param name="milliseconds">超时时间的毫秒数</param>
+        public TimeoutAttribute(double milliseconds)
+        {
+            this.TimeSpan = System.TimeSpan.FromMilliseconds(milliseconds);
+        }
+
+        /// <summary>
+        /// 执行前
+        /// </summary>
+        /// <param name="context">上下文</param>
+        /// <exception cref="HttpApiConfigException"></exception>
+        /// <returns></returns>
+        public override Task BeforeRequestAsync(ApiActionContext context)
+        {
+            if (this.TimeSpan.HasValue == false)
+            {
+                throw new HttpApiConfigException($"请传入milliseconds参数：{nameof(TimeoutAttribute)}");
+            }
+
+            this.SetTimeout(context, this.TimeSpan.Value);
+            return ApiTask.CompletedTask;
+        }
+
+        /// <summary>
+        /// http请求之前
+        /// </summary>
+        /// <param name="context">上下文</param>
+        /// <param name="parameter">特性关联的参数</param>
+        /// <exception cref="HttpApiConfigException"></exception>
+        /// <returns></returns>
+        Task IApiParameterAttribute.BeforeRequestAsync(ApiActionContext context, ApiParameterDescriptor parameter)
+        {
+            if (parameter.Value is IConvertible convertible)
+            {
+                var doubleValue = Convert.ToDouble(convertible);
+                var timeout = System.TimeSpan.FromMilliseconds(doubleValue);
+                this.SetTimeout(context, timeout);
+            }
+            else if (parameter.Value is TimeSpan timeout)
+            {
+                this.SetTimeout(context, timeout);
+            }
+            else
+            {
+                throw new HttpApiConfigException($"无法将参数{parameter.Member}转换为Timeout");
+            }
+            return ApiTask.CompletedTask;
+        }
+
+
+        /// <summary>
+        /// 设置超时时间到上下文
+        /// </summary>
+        /// <param name="context">上下文</param>
+        /// <param name="timeout">超时时间</param>
+        /// <exception cref="HttpApiConfigException"></exception>
+        private void SetTimeout(ApiActionContext context, TimeSpan timeout)
+        {
+            var maxTimeout = context.HttpApiConfig.HttpClient.Timeout;
+            if (maxTimeout >= System.TimeSpan.Zero && timeout > maxTimeout)
+            {
+                throw new HttpApiConfigException($"Timeout值{timeout}不能超时HttpApiConfig.HttpClient.Timeout");
+            }
+
+            var cancellation = new CancellationTokenSource(timeout);
+            context.CancellationTokens.Add(cancellation.Token);
+        }
+    }
+}