Merge pull request #1 from dotnetcore/master

合并

Author: hjkl950217

App/App.csproj

@@ -6,6 +6,7 @@
   </PropertyGroup>
 
   <ItemGroup>
+    <ProjectReference Include="..\WebApiClientCore.Extensions.NewtonsoftJson\WebApiClientCore.Extensions.NewtonsoftJson.csproj" />
     <ProjectReference Include="..\WebApiClientCore.Extensions.OAuths\WebApiClientCore.Extensions.OAuths.csproj" />
     <ProjectReference Include="..\WebApiClientCore\WebApiClientCore.csproj" />
   </ItemGroup>

README.md

@@ -0,0 +1,108 @@
+using System.Threading.Tasks;
+using WebApiClientCore.Extensions.JsonRpc;
+
+namespace WebApiClientCore.Attributes
+{
+    /// <summary>
+    /// 表示Json-Rpc请求方法
+    /// </summary>
+    public class JsonRpcMethodAttribute : HttpPostAttribute, IApiFilterAttribute
+    {
+        /// <summary>
+        /// JsonRpc的方法名称
+        /// </summary>
+        private readonly string? method;
+
+        /// <summary>
+        /// 获取或设置提交的Content-Type
+        /// 默认为application/json-rpc 
+        /// </summary>
+        public string ContentType { get; set; } = JsonRpcContent.MediaType;
+
+        /// <summary>
+        /// 获取或设置JsonRpc的参数风格
+        /// 默认为JsonRpcParamsStyle.Array
+        /// </summary>
+        public JsonRpcParamsStyle ParamsStyle { get; set; } = JsonRpcParamsStyle.Array;
+
+        /// <summary>
+        /// 获取过滤器是否启用
+        /// </summary>
+        bool IAttributeEnable.Enable => true;
+
+        /// <summary>
+        /// Json-Rpc请求方法
+        /// </summary>
+        public JsonRpcMethodAttribute()
+            : this(method: null, path: null)
+        {
+        }
+
+        /// <summary>
+        /// Json-Rpc请求方法
+        /// </summary>
+        /// <param name="method">JsonRpc的方法名称</param>
+        public JsonRpcMethodAttribute(string? method)
+            : this(method, path: null)
+        {
+        }
+
+        /// <summary>
+        /// Json-Rpc请求方法
+        /// </summary>
+        /// <param name="method">JsonRpc的方法名称</param>
+        /// <param name="path">JsonRpc路径</param>
+        public JsonRpcMethodAttribute(string? method, string? path)
+            : base(path)
+        {
+            this.method = method;
+        }
+
+        /// <summary>
+        /// Action请求前
+        /// </summary>
+        /// <param name="context"></param>
+        /// <returns></returns>
+        public override Task OnRequestAsync(ApiRequestContext context)
+        {
+            var parametrs = new JsonRpcParameters();
+            context.Properties.Set(typeof(JsonRpcParameters), parametrs);
+
+            return base.OnRequestAsync(context);
+        }
+
+        /// <summary>
+        /// Filter请求前
+        /// </summary>
+        /// <param name="context">上下文</param>
+        /// <returns></returns>
+        Task IApiFilterAttribute.OnRequestAsync(ApiRequestContext context)
+        {
+            var jsonRpcContent = new JsonRpcContent(this.ContentType);
+            context.HttpContext.RequestMessage.Content = jsonRpcContent;
+
+            var parameters = context.Properties.Get<JsonRpcParameters>(typeof(JsonRpcParameters));
+            var jsonRpcRequest = new JsonRpcRequest
+            {
+                Method = this.method ?? context.ApiAction.Name,
+                Params = parameters.ToJsonRpcParams(this.ParamsStyle),
+            };
+
+            var options = context.HttpContext.HttpApiOptions.JsonSerializeOptions;
+            var jsonSerializer = context.HttpContext.ServiceProvider.GetJsonSerializer();
+            jsonSerializer.Serialize(jsonRpcContent, jsonRpcRequest, options);
+
+            return Task.CompletedTask;
+        }
+
+        /// <summary>
+        /// Filter响应后
+        /// </summary>
+        /// <param name="context">上下文</param>
+        /// <returns></returns>
+        Task IApiFilterAttribute.OnResponseAsync(ApiResponseContext context)
+        {
+            return Task.CompletedTask;
+        }
+    }
+}

WebApiClientCore.Extensions.JsonRpc/Attributes/JsonRpcMethodAttribute.cs

@@ -0,0 +1,29 @@
+using System.Threading.Tasks;
+using WebApiClientCore.Exceptions;
+using WebApiClientCore.Extensions.JsonRpc;
+
+namespace WebApiClientCore.Attributes
+{
+    /// <summary>
+    /// 表示Rpc请求的一个参数
+    /// </summary> 
+    public class JsonRpcParamAttribute : ApiParameterAttribute
+    {
+        /// <summary>
+        /// 请求前
+        /// </summary>
+        /// <param name="context"></param>
+        /// <returns></returns>
+        public override Task OnRequestAsync(ApiParameterContext context)
+        {
+            var parameters = context.Properties.Get<JsonRpcParameters>(typeof(JsonRpcParameters));
+            if (parameters == null)
+            {
+                throw new ApiInvalidConfigException($"请为接口方法{context.ApiAction.Name}修饰{nameof(JsonRpcMethodAttribute)}");
+            }
+
+            parameters.Add(context);
+            return Task.CompletedTask;
+        }
+    }
+}

WebApiClientCore.Extensions.JsonRpc/Attributes/JsonRpcParamAttribute.cs

@@ -0,0 +1,18 @@
+namespace WebApiClientCore.Attributes
+{
+    /// <summary>
+    /// 表示JsonRpc的参数风格
+    /// </summary>
+    public enum JsonRpcParamsStyle
+    {
+        /// <summary>
+        /// 数组形式
+        /// </summary>
+        Array,
+
+        /// <summary>
+        /// 对象形式
+        /// </summary>
+        Object
+    }
+}

WebApiClientCore.Extensions.JsonRpc/Attributes/JsonRpcParamsStyle.cs

@@ -0,0 +1,24 @@
+using WebApiClientCore.HttpContents;
+
+namespace WebApiClientCore.Extensions.JsonRpc
+{
+    /// <summary>
+    /// 表示JsonRpc请求内容
+    /// </summary>
+    class JsonRpcContent : BufferContent
+    { 
+        /// <summary>
+        /// 获取对应的ContentType
+        /// </summary>
+        public static string MediaType => "application/json-rpc";
+
+        /// <summary>
+        /// JsonRpc请求内容
+        /// </summary> 
+        /// <param name="mediaType">媒体类型</param>
+        public JsonRpcContent( string? mediaType)
+            : base(mediaType ?? MediaType)
+        { 
+        } 
+    }
+}

WebApiClientCore.Extensions.JsonRpc/Internals/JsonRpcContent.cs

@@ -0,0 +1,29 @@
+using System.Collections.Generic;
+using System.Linq;
+using WebApiClientCore.Attributes;
+
+namespace WebApiClientCore.Extensions.JsonRpc
+{
+    /// <summary>
+    /// 表示JsonRpc参数
+    /// </summary>
+    class JsonRpcParameters : List<ApiParameterContext>
+    {
+        /// <summary>
+        /// 转换为jsonRpc请求参数
+        /// </summary>
+        /// <param name="paramsStyle"></param>
+        /// <returns></returns>
+        public object ToJsonRpcParams(JsonRpcParamsStyle paramsStyle)
+        {
+            if (paramsStyle == JsonRpcParamsStyle.Array)
+            {
+                return this.Select(item => item.ParameterValue).ToArray();
+            }
+            else
+            {
+                return this.ToDictionary(item => item.Parameter.Name, item => item.ParameterValue);
+            }
+        } 
+    }
+}

WebApiClientCore.Extensions.JsonRpc/Internals/JsonRpcParameters.cs

@@ -0,0 +1,42 @@
+using System;
+using System.Text.Json.Serialization;
+using System.Threading;
+
+namespace WebApiClientCore.Extensions.JsonRpc
+{
+    /// <summary>
+    /// 表示JsonRpc的请求实体
+    /// </summary>
+    class JsonRpcRequest
+    {  
+        /// <summary>
+        /// id值
+        /// </summary>
+        private static int @id = 0;
+
+        /// <summary>
+        /// jsonrpc
+        /// 2.0
+        /// </summary>
+        [JsonPropertyName("jsonrpc")]
+        public string JsonRpc { get; set; } = "2.0";
+
+        /// <summary>
+        /// 请求的方法名
+        /// </summary>
+        [JsonPropertyName("method")]
+        public string Method { get; set; } = string.Empty;
+
+        /// <summary>
+        /// 请求的参数数组
+        /// </summary>
+        [JsonPropertyName("params")]
+        public object Params { get; set; } = Array.Empty<object>();
+
+        /// <summary>
+        /// 请求的id
+        /// </summary>
+        [JsonPropertyName("id")]
+        public int Id { get; set; } = Interlocked.Increment(ref id);
+    }
+}

WebApiClientCore.Extensions.JsonRpc/Internals/JsonRpcRequest.cs

@@ -0,0 +1,23 @@
+namespace WebApiClientCore.Extensions.JsonRpc
+{
+    /// <summary>
+    /// 表示JsonRpc的错误内容
+    /// </summary>
+    public class JsonRpcError
+    {
+        /// <summary>
+        /// 错误码
+        /// </summary>
+        public int Code { get; set; }
+
+        /// <summary>
+        /// 提示消息
+        /// </summary>
+        public string? Message { get; set; }
+
+        /// <summary>
+        /// 错误内容
+        /// </summary>
+        public object? Data { get; set; }
+    }
+}

WebApiClientCore.Extensions.JsonRpc/JsonRpcError.cs

@@ -0,0 +1,38 @@
+using System.Text.Json.Serialization;
+
+namespace WebApiClientCore.Extensions.JsonRpc
+{
+    /// <summary>
+    /// 表示JsonRpc的请求返回结果
+    /// </summary>
+    /// <typeparam name="TResult"></typeparam>
+    public class JsonRpcResult<TResult>
+    {
+        /// <summary>
+        /// 请求id
+        /// </summary>
+        [JsonPropertyName("id")]
+        public int? Id { get; set; }
+
+        /// <summary>
+        /// jsonrpc版本号
+        /// </summary>
+        [JsonPropertyName("jsonrpc")]
+        public string JsonRpc { get; set; } = string.Empty;
+
+        /// <summary>
+        /// 结果值
+        /// </summary>
+#nullable disable
+        [JsonPropertyName("result")]
+        public TResult Result { get; set; }
+#nullable enable
+
+        /// <summary>
+        /// 错误内容
+        /// </summary>
+        [JsonPropertyName("error")]
+        public JsonRpcError? Error { get; set; }
+    }
+}
+