Merge pull request #150 from dotnetcore/feature/CompletionOption

Feature/completion option

Author: xljiulang

App/Clients/IUserApi.cs

@@ -15,6 +15,7 @@ namespace App.Clients
     [LoggingFilter]
     [OAuthToken]
     [HttpHost("http://localhost:6000/")]
+    [JsonNetReturn]
     public interface IUserApi : IHttpApi
     {
         [HttpGet("api/users/{account}")]
@@ -39,6 +40,7 @@ public interface IUserApi : IHttpApi
         ITask<byte[]> GetAsByteArrayAsync([Required] string account, CancellationToken token = default);
 
         [HttpGet("api/users/{account}")]
+        [HttpCompletionOption(HttpCompletionOption.ResponseHeadersRead)]
         ITask<Stream> GetAsStreamAsync([Required] string account, CancellationToken token = default);
 
         [HttpGet("api/users/{account}")]

WebApiClientCore.Extensions.NewtonsoftJson/Attributes/JsonNetReturnAttribute.cs

@@ -35,22 +35,19 @@ public JsonNetReturnAttribute(double acceptQuality)
         /// <returns></returns>
         public override async Task SetResultAsync(ApiResponseContext context)
         {
-            var response = context.HttpContext.ResponseMessage;
-            if (response == null || response.Content == null)
+            var content = context.HttpContext.ResponseMessage?.Content;
+            if (content == null)
             {
                 return;
             }
 
-            if (context.ApiAction.Return.DataType.IsRawType == false)
-            {
-                var json = await response.Content.ReadAsStringAsync().ConfigureAwait(false);
-                var resultType = context.ApiAction.Return.DataType.Type;
+            var json = await content.ReadAsStringAsync().ConfigureAwait(false);
+            var resultType = context.ApiAction.Return.DataType.Type;
 
-                var name = context.HttpContext.OptionsName;
-                var options = context.HttpContext.ServiceProvider.GetService<IOptionsMonitor<JsonNetSerializerOptions>>().Get(name);
+            var name = context.HttpContext.OptionsName;
+            var options = context.HttpContext.ServiceProvider.GetService<IOptionsMonitor<JsonNetSerializerOptions>>().Get(name);
 
-                context.Result = JsonConvert.DeserializeObject(json, resultType, options.JsonDeserializeOptions);
-            }
+            context.Result = JsonConvert.DeserializeObject(json, resultType, options.JsonDeserializeOptions);
         }
     }
 }

WebApiClientCore/Attributes/ActionAttributes/HttpCompletionOptionAttribute.cs

@@ -0,0 +1,38 @@
+using System;
+using System.Net.Http;
+using System.Threading.Tasks;
+
+namespace WebApiClientCore.Attributes
+{
+    /// <summary>
+    /// 指示请求完成选项的特性
+    /// </summary>
+    [AttributeUsage(AttributeTargets.Method, AllowMultiple = false, Inherited = true)]
+    public class HttpCompletionOptionAttribute : ApiActionAttribute
+    {
+        /// <summary>
+        /// 请求完成选项
+        /// </summary>
+        private readonly HttpCompletionOption completionOption;
+
+        /// <summary>
+        /// 指示请求完成选项的特性
+        /// </summary>
+        /// <param name="completionOption">请求完成选项</param>
+        public HttpCompletionOptionAttribute(HttpCompletionOption completionOption)
+        {
+            this.completionOption = completionOption;
+        }
+
+        /// <summary>
+        /// 执行前
+        /// </summary>
+        /// <param name="context">上下文</param>
+        /// <returns></returns>
+        public override Task OnRequestAsync(ApiRequestContext context)
+        {
+            context.HttpContext.CompletionOption = this.completionOption;
+            return Task.CompletedTask;
+        }
+    }
+}

WebApiClientCore/Attributes/FilterAttributes/LoggingFilterAttribute.cs

@@ -85,7 +85,7 @@ public sealed async override Task OnResponseAsync(ApiResponseContext context)
             {
                 logMessage.HasResponse = true;
                 logMessage.ResponseHeaders = response.GetHeadersString();
-                logMessage.ResponseContent = await this.ReadResponseContentAsync(response).ConfigureAwait(false);
+                logMessage.ResponseContent = await this.ReadResponseContentAsync(context).ConfigureAwait(false);
             }
 
             await this.WriteLogAsync(context, logMessage).ConfigureAwait(false);
@@ -111,11 +111,23 @@ public sealed async override Task OnResponseAsync(ApiResponseContext context)
         /// <summary>
         /// 读取响应内容
         /// </summary>
-        /// <param name="response"></param>
+        /// <param name="context"></param>
         /// <returns></returns>
-        private async Task<string?> ReadResponseContentAsync(HttpResponseMessage response)
+        private async Task<string?> ReadResponseContentAsync(ApiResponseContext context)
         {
-            return response.Content == null ? null : await response.Content.ReadAsStringAsync().ConfigureAwait(false);
+            var content = context.HttpContext.ResponseMessage?.Content;
+            if (content == null)
+            {
+                return null;
+            }
+
+            if (content.IsBuffered() == true ||
+                context.HttpContext.CompletionOption == HttpCompletionOption.ResponseContentRead)
+            {
+                return await content.ReadAsStringAsync().ConfigureAwait(false);
+            }
+
+            return "...";
         }
 
         /// <summary>

WebApiClientCore/BuildInProxies/Invokers/HttpRequest.cs

@@ -37,8 +37,9 @@ public static async Task<ApiResponseContext> SendAsync(ApiRequestContext context
             {
                 var client = context.HttpContext.HttpClient;
                 var request = context.HttpContext.RequestMessage;
+                var completionOption = context.HttpContext.CompletionOption;
                 using var tokenLinker = new CancellationTokenLinker(context.HttpContext.CancellationTokens);
-                var response = await client.SendAsync(request, tokenLinker.Token).ConfigureAwait(false);
+                var response = await client.SendAsync(request, completionOption, tokenLinker.Token).ConfigureAwait(false);
 
                 context.HttpContext.ResponseMessage = response;
                 await SetCacheAsync(context, actionCache?.Key, response).ConfigureAwait(false);

WebApiClientCore/HttpContext.cs

@@ -10,6 +10,11 @@ namespace WebApiClientCore
     /// </summary>
     public class HttpContext : HttpClientContext, IDisposable
     {
+        /// <summary>
+        /// 获取或设置指示请求完成选项
+        /// </summary>
+        public HttpCompletionOption CompletionOption { get; set; }
+
         /// <summary>
         /// 获取请求取消令牌集合
         /// </summary>