SourceGenerator方法排序问题修复

xljiulang · xljiulang · commit 8239a6475c72 · 2022-10-15T22:50:21.000+08:00
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -1,7 +1,7 @@
 <Project>	
 	<PropertyGroup>
-		<Version>2.0.2</Version>
-		<Copyright>Copyright © laojiu 2017-2021</Copyright>
+		<Version>2.0.3</Version>
+		<Copyright>Copyright © laojiu 2017-2022</Copyright>
 		<NoWarn>IDE0057</NoWarn>
 	</PropertyGroup>
 
diff --git a/WebApiClientCore.Analyzers.SourceGenerator/HttpApiCodeBuilder.cs b/WebApiClientCore.Analyzers.SourceGenerator/HttpApiCodeBuilder.cs
@@ -154,7 +154,7 @@ private string BuildMethod(IMethodSymbol method, int index)
             var parametersString = string.Join(",", method.Parameters.Select(item => $"{item.Type} {item.Name}"));
             var parameterNamesString = string.Join(",", method.Parameters.Select(item => item.Name));
 
-            builder.AppendLine($"\t\t[ApiMethodIndex({index})]");
+            builder.AppendLine($"\t\t[HttpApiProxyMethod({index})]");
             builder.AppendLine($"\t\tpublic {method.ReturnType} {method.Name}( {parametersString} )");
             builder.AppendLine("\t\t{");
             builder.AppendLine($"\t\t\treturn ({method.ReturnType})this.{this.apiInterceptorFieldName}.Intercept(this.{this.actionInvokersFieldName}[{index}], new object[] {{ {parameterNamesString} }});");
diff --git a/WebApiClientCore.Extensions.SourceGenerator/HttpApiProxyMethodAttribute.cs b/WebApiClientCore.Extensions.SourceGenerator/HttpApiProxyMethodAttribute.cs
@@ -1,24 +1,25 @@
 ﻿using System;
+using System.ComponentModel;
 
 namespace WebApiClientCore
 {
     /// <summary>
-    /// 指示Api方法的索引特性
-    /// 当生成代理类型使用该特性后，运行时HttpApi.FindApiMethods(Type)遵循这个方法索引
+    /// 表示HttpApi代理方法的特性 
     /// </summary>
     [AttributeUsage(AttributeTargets.Method, AllowMultiple = false)]
-    public sealed class ApiMethodIndexAttribute : Attribute
+    [EditorBrowsable(EditorBrowsableState.Never)]
+    public sealed class HttpApiProxyMethodAttribute : Attribute
     {
         /// <summary>
         /// 获取索引值
         /// </summary>
         public int Index { get; }
 
         /// <summary>
-        /// Api方法的索引特性
+        /// 方法的索引特性
         /// </summary>
         /// <param name="index">索引值，确保连续且不重复</param>
-        public ApiMethodIndexAttribute(int index)
+        public HttpApiProxyMethodAttribute(int index)
         {
             this.Index = index;
         }
diff --git a/WebApiClientCore.Extensions.SourceGenerator/Implementations/MethodFeature.cs b/WebApiClientCore.Extensions.SourceGenerator/Implementations/MethodFeature.cs
@@ -0,0 +1,59 @@
+﻿using System;
+using System.Linq;
+using System.Reflection;
+
+namespace WebApiClientCore.Implementations
+{
+    /// <summary>
+    /// 表示MethodInfo的特征
+    /// </summary>
+    sealed class MethodFeature : IEquatable<MethodFeature>
+    {
+        private readonly MethodInfo method;
+
+        /// <summary>
+        /// MethodInfo的特征
+        /// </summary>
+        /// <param name="method"></param>
+        public MethodFeature(MethodInfo method)
+        {
+            this.method = method;
+        }
+
+        /// <summary>
+        /// 比较方法原型是否相等
+        /// </summary>
+        /// <param name="other"></param>
+        /// <returns></returns>
+        public bool Equals(MethodFeature other)
+        {
+            var x = this.method;
+            var y = other.method;
+
+            if (x.Name != y.Name || x.ReturnType != y.ReturnType)
+            {
+                return false;
+            }
+
+            var xParameterTypes = x.GetParameters().Select(p => p.ParameterType);
+            var yParameterTypes = y.GetParameters().Select(p => p.ParameterType);
+            return xParameterTypes.SequenceEqual(yParameterTypes);
+        }
+
+        /// <summary>
+        /// 获取哈希
+        /// </summary>
+        /// <returns></returns>
+        public override int GetHashCode()
+        {
+            var hashCode = new HashCode();
+            hashCode.Add(this.method.Name);
+            hashCode.Add(this.method.ReturnType);
+            foreach (var parameter in this.method.GetParameters())
+            {
+                hashCode.Add(parameter.ParameterType);
+            }
+            return hashCode.ToHashCode();
+        }
+    }
+}
diff --git a/WebApiClientCore.Extensions.SourceGenerator/Implementations/SourceGeneratorHttpApiActivator.cs b/WebApiClientCore.Extensions.SourceGenerator/Implementations/SourceGeneratorHttpApiActivator.cs
@@ -13,6 +13,11 @@ namespace WebApiClientCore.Implementations
     /// <typeparam name="THttpApi"></typeparam>
     public class SourceGeneratorHttpApiActivator<THttpApi> : HttpApiActivator<THttpApi>
     {
+        /// <summary>
+        /// 代理类型
+        /// </summary>
+        private static readonly Type? proxyType = FindProxyTypeFromAssembly();
+
         /// <summary>
         /// 通过查找类型代理类型创建实例
         /// </summary>
@@ -25,30 +30,54 @@ public SourceGeneratorHttpApiActivator(IApiActionDescriptorProvider apiActionDes
         {
         }
 
+        /// <summary>
+        /// 查找接口的Api方法
+        /// 用于创建代理对象的ApiActionInvoker
+        /// </summary>
+        /// <returns></returns>
+        protected override MethodInfo[] FindApiMethods()
+        {
+            if (proxyType != null)
+            {
+                var apiMethods = base.FindApiMethods();
+                var proxyMethods = proxyType.GetMethods();
+                var methods = from a in apiMethods
+                              join p in proxyMethods
+                              on new MethodFeature(a) equals new MethodFeature(p)
+                              let attr = p.GetCustomAttribute<HttpApiProxyMethodAttribute>()
+                              let index = attr == null ? 0 : attr.Index
+                              orderby index
+                              select a;
+
+                return methods.ToArray();
+            }
+
+            return base.FindApiMethods();
+        }
+
         /// <summary>
         /// 创建实例工厂
         /// </summary>
         /// <exception cref="ProxyTypeCreateException"></exception>
         /// <returns></returns>
         protected override Func<IHttpApiInterceptor, ApiActionInvoker[], THttpApi> CreateFactory()
         {
-            var proxyType = FindProxyType(typeof(THttpApi));
             if (proxyType != null)
             {
                 return LambdaUtil.CreateCtorFunc<IHttpApiInterceptor, ApiActionInvoker[], THttpApi>(proxyType);
             }
 
             var message = $"找不到{typeof(THttpApi)}的代理类：{GetErrorReason()}";
             throw new ProxyTypeCreateException(typeof(THttpApi), message);
-        }       
+        }
 
         /// <summary>
         /// 从接口所在程序集查找代理类
-        /// </summary>
-        /// <param name="interfaceType">接口类型</param>
+        /// </summary> 
         /// <returns></returns>
-        private static Type? FindProxyType(Type interfaceType)
+        private static Type? FindProxyTypeFromAssembly()
         {
+            var interfaceType = typeof(THttpApi);
             var httpApiType = interfaceType.IsGenericType
                 ? interfaceType.GetGenericTypeDefinition()
                 : interfaceType;
diff --git a/WebApiClientCore/HttpApi.cs b/WebApiClientCore/HttpApi.cs
@@ -102,8 +102,6 @@ public static MethodInfo[] FindApiMethods(Type httpApiType)
                 .Append(httpApiType)
                 .SelectMany(item => item.GetMethods())
                 .Select(item => item.EnsureApiMethod())
-                .OrderBy(item => item.Index)
-                .Select(item => item.Method)
                 .ToArray();
         }
 
@@ -112,7 +110,7 @@ public static MethodInfo[] FindApiMethods(Type httpApiType)
         /// </summary>
         /// <exception cref="NotSupportedException"></exception>
         /// <returns></returns>
-        private static (MethodInfo Method, int Index) EnsureApiMethod(this MethodInfo method)
+        private static MethodInfo EnsureApiMethod(this MethodInfo method)
         {
             if (method.IsGenericMethod == true)
             {
@@ -138,10 +136,7 @@ private static (MethodInfo Method, int Index) EnsureApiMethod(this MethodInfo me
                     throw new NotSupportedException(message);
                 }
             }
-
-            var indexAttribute = method.GetCustomAttribute<ApiMethodIndexAttribute>();
-            var index = indexAttribute == null ? 0 : indexAttribute.Index;
-            return (method, index);
+            return method;
         }
 
         /// <summary>
diff --git a/WebApiClientCore/Implementations/HttpApiActivator.cs b/WebApiClientCore/Implementations/HttpApiActivator.cs
@@ -34,17 +34,26 @@ public abstract class HttpApiActivator<THttpApi> : IHttpApiActivator<THttpApi>
         /// <exception cref="NotSupportedException"></exception>
         public HttpApiActivator(IApiActionDescriptorProvider actionDescriptorProvider, IApiActionInvokerProvider actionInvokerProvider)
         {
-            var interfaceType = typeof(THttpApi);
-            this.ApiMethods = HttpApi.FindApiMethods(interfaceType);
+            this.ApiMethods = this.FindApiMethods();
             this.actionInvokers = this.ApiMethods
-                 .Select(item => actionDescriptorProvider.CreateActionDescriptor(item, interfaceType))
+                 .Select(item => actionDescriptorProvider.CreateActionDescriptor(item, typeof(THttpApi)))
                  .Select(item => actionInvokerProvider.CreateActionInvoker(item))
                  .ToArray();
 
             // 最后一步创建工厂
             this.factory = this.CreateFactory();
         }
 
+        /// <summary>
+        /// 查找接口的Api方法
+        /// 用于创建代理对象的ApiActionInvoker
+        /// </summary>
+        /// <returns></returns>
+        protected virtual MethodInfo[] FindApiMethods()
+        {
+            return HttpApi.FindApiMethods(typeof(THttpApi));
+        }
+
         /// <summary>
         /// 创建实例工厂
         /// </summary>

Original file line number	Diff line number	Diff line change
`@@ -102,8 +102,6 @@ public static MethodInfo[] FindApiMethods(Type httpApiType)`
`102`	`102`	`.Append(httpApiType)`
`103`	`103`	`.SelectMany(item => item.GetMethods())`
`104`	`104`	`.Select(item => item.EnsureApiMethod())`
`105`		`- .OrderBy(item => item.Index)`
`106`		`- .Select(item => item.Method)`
`107`	`105`	`.ToArray();`
`108`	`106`	`}`
`109`	`107`
`@@ -112,7 +110,7 @@ public static MethodInfo[] FindApiMethods(Type httpApiType)`
`112`	`110`	`/// </summary>`
`113`	`111`	`/// <exception cref="NotSupportedException"></exception>`
`114`	`112`	`/// <returns></returns>`
`115`		`- private static (MethodInfo Method, int Index) EnsureApiMethod(this MethodInfo method)`
	`113`	`+ private static MethodInfo EnsureApiMethod(this MethodInfo method)`
`116`	`114`	`{`
`117`	`115`	`if (method.IsGenericMethod == true)`
`118`	`116`	`{`
`@@ -138,10 +136,7 @@ private static (MethodInfo Method, int Index) EnsureApiMethod(this MethodInfo me`
`138`	`136`	`throw new NotSupportedException(message);`
`139`	`137`	`}`
`140`	`138`	`}`
`141`		`-`
`142`		`- var indexAttribute = method.GetCustomAttribute<ApiMethodIndexAttribute>();`
`143`		`- var index = indexAttribute == null ? 0 : indexAttribute.Index;`
`144`		`- return (method, index);`
	`139`	`+ return method;`
`145`	`140`	`}`
`146`	`141`
`147`	`142`	`/// <summary>`