WebApi v1.1 提供参数属性同步复制到动态 Api 的能力

Author: JeffreySu

Sample/Senparc.CO2NET.Sample.net6/Services/ApiBindTestService.cs

@@ -3,6 +3,7 @@
 using Microsoft.Extensions.DependencyInjection;
 using Swashbuckle.AspNetCore.Annotations;
 using System;
+using System.ComponentModel;
 using System.Diagnostics;
 using System.Linq;
 using System.Reflection;
@@ -383,7 +384,8 @@ public string RewriteApiBind(string name = "Senparc", int value = 920)
         /// 静态类，自动继承 class 配置
         /// </summary>
         /// <returns></returns>
-        public static string StaticMethod() {
+        public static string StaticMethod()
+        {
             return "ClassCover.StaticMethod";
         }
     }
@@ -488,4 +490,60 @@ public MyTestAttribute(string name)
         }
     }
 
+
+    /// <summary>
+    /// 参数带 Attribute
+    /// </summary>
+    [ApiController]
+    public class ParameterAttribute
+    {
+        /// <summary>
+        /// 参数带 Attribute 测试
+        /// </summary>
+        /// <param name="requestData"></param>
+        /// <returns></returns>
+        [ApiBind(ApiRequestMethod = WebApi.ApiRequestMethod.Post)]
+        public static string ParameterAttributeTest([FromBody]RequestData requestData1)
+        {
+            /* 
+             * 可用 PostMan 等工具测试：
+             * curl --location --request POST 'https://localhost:44351/api/Senparc.CO2NET.Sample/ParameterAttribute/CO2NET.Sample_ParameterAttribute.ParameterAttributeTest' \
+               --header 'Content-Type: application/json' \
+               --data-raw '{
+                   "UserName": "SenparcCoreAdmin96",
+                   "Password": "743e815e2"
+                }'
+             *
+             *  结果:SenparcCoreAdmin96:743e815e2 -- 2021/11/22 21:11:14 +08:00
+             */
+
+            return $"{requestData1.UserName}:{requestData1.Password} -- {SystemTime.Now}";
+        }
+
+
+    }
+    public class RequestData
+    {
+        public string UserName { get; set; }
+        public string Password { get; set; }
+    }
+
+    [ApiController]
+    [Route("[controller]")]
+    public class NormalApi : ControllerBase
+    {
+
+        [HttpPost("login")]
+        public IActionResult Login([FromBody]RequestData request)
+        {
+            return Content($"{request.UserName}:{request.Password} -- {SystemTime.Now}");
+        }
+
+        [HttpGet("login2")]
+        public IActionResult Login2(RequestData request)
+        {
+            return Content($"{request.UserName}:{request.Password}");
+        }
+    }
+
 }

src/Senparc.CO2NET.WebApi/Senparc.CO2NET.WebApi.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <TargetFrameworks>netstandard2.1;netcoreapp3.1;net5.0;net6.0</TargetFrameworks>
-    <Version>1.0</Version>
+    <Version>1.1</Version>
     <LangVersion>latest</LangVersion>
     <AssemblyName>Senparc.CO2NET.WebApi</AssemblyName>
     <RootNamespace>Senparc.CO2NET.WebApi</RootNamespace>
@@ -30,7 +30,8 @@
 		v0.2.5.7 添加 ForbiddenExternalAccess 参数，设置是否允许外部访问
 		v0.2.6 添加 WebApiEngineOptions
 		v0.2.8 提供 .NET Standard 2.1 版本
-</PackageReleaseNotes>
+		v1.1 提供参数属性同步复制到动态 Api 的能力
+	</PackageReleaseNotes>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)' == 'Release' ">
     <OutputPath>..\BuildOutPut</OutputPath>
@@ -48,6 +49,7 @@
   <ItemGroup>
     <PackageReference Include="Microsoft.AspNetCore.Mvc.Core" Version="2.2.5" />
     <PackageReference Include="Swashbuckle.AspNetCore.Annotations" Version="6.2.3" />
+    <!--<PackageReference Include="System.Reflection.Emit" Version="4.7.0" />-->
   </ItemGroup>
   <ItemGroup>
     <ProjectReference Include="..\Senparc.CO2NET.AspNet\Senparc.CO2NET.AspNet.csproj" />

src/Senparc.CO2NET.WebApi/WebApiEngines/WebApiEngine.cs

@@ -7,9 +7,13 @@
 
     创建标识：Senparc - 20210627
 
+    修改标识：Senparc - 20211122
+    修改描述：v1.1 提供参数属性同步复制到动态 Api 的能力
+   
 ----------------------------------------------------------------*/
 
 using Microsoft.AspNetCore.Mvc;
+using Microsoft.AspNetCore.Mvc.ModelBinding;
 using Senparc.CO2NET.WebApi.ActionFilters;
 using Swashbuckle.AspNetCore.Annotations;
 using System;
@@ -324,7 +328,6 @@ private async Task BuildApiMethodForOneThread(IGrouping<string, KeyValuePair<str
                         }
 
                         //叠加类和特性的方法
-
                         foreach (var item in customAttrs)
                         {
                             if (item.AttributeType == _typeOfApiBind)
@@ -360,27 +363,64 @@ private async Task BuildApiMethodForOneThread(IGrouping<string, KeyValuePair<str
                     //setPropMthdBldr.SetReturnType(apiMethodInfo.ReturnType);
 
                     //设置参数
-                    var boundType = false;
+                    var boundSourceMetadata = false;//参数使用了[FromBody]等特性标记
+                    var boundClassType = false;//参数中已经绑定了 class 复杂类型
                     //定义其他参数
                     for (int i = 0; i < parameters.Length; i++)
                     {
                         var p = parameters[i];
                         ParameterBuilder pb = setPropMthdBldr.DefineParameter(i + 1/*从1开始，0为返回值*/, p.Attributes, p.Name);
                         //处理参数，反之出现复杂类型的参数，抛出异常：InvalidOperationException: Action 'WeChat_OfficialAccountController.CardApi_GetOrderList (WeixinApiAssembly)' has more than one parameter that was specified or inferred as bound from request body. Only one parameter per action may be bound from body. Inspect the following parameters, and use 'FromQueryAttribute' to specify bound from query, 'FromRouteAttribute' to specify bound from route, and 'FromBodyAttribute' for parameters to be bound from body:
-                        if (p.ParameterType.IsClass)
+
+
+                        boundSourceMetadata = boundSourceMetadata || typeof(IBindingSourceMetadata).IsAssignableFrom(p.ParameterType);
+
+                        //复制添加单个参数上的所有特性
+                        try
                         {
-                            if (boundType == false)
+                            var paramAttrs = p.CustomAttributes;// CustomAttributeData.GetCustomAttributes(p.ParameterType).ToList();
+                            foreach (var item in paramAttrs)
                             {
-                                //第一个绑定，可以不处理
-                                boundType = true;
+                                var attrBuilder = new CustomAttributeBuilder(item.Constructor, item.ConstructorArguments.Select(z => z.Value).ToArray());
+                                pb.SetCustomAttribute(attrBuilder);
                             }
-                            else
+                        }
+                        catch (Exception)
+                        {
+                            //TODO：收集错误信息
+                            //throw;
+                        }
+
+                        try
+                        {
+                            if (p.ParameterType.IsClass && !boundClassType)
                             {
-                                //第二个开始使用标签
+                                boundClassType = true;//第一个绑定，可以不处理
+                            }
+                            else if (boundClassType && !boundSourceMetadata)
+                            {
+                                //第二个开始使用标签     TODO：可以自定义更多的类型
                                 var tFromQuery = typeof(FromQueryAttribute);
                                 pb.SetCustomAttribute(new CustomAttributeBuilder(tFromQuery.GetConstructor(new Type[0]), new object[0]));
                             }
+
+                            //if (!boundSourceMetadata && p.ParameterType.IsClass)
+                            //{
+                            //    if (boundClassType == false)
+                            //    {
+                                    
+                            //    }
+                            //    else
+                            //    {
+                                    
+                            //    }
+                            //}
                         }
+                        catch (Exception)
+                        {
+                            //throw;
+                        }
+
                         try
                         {
                             //设置默认值