在不使用ExportServicesAttribute指定导出类型时，尝试自动获取导出类型

stratosblue · stratosblue · commit 0d4c898bfe7d · 2022-01-03T21:43:39.000+08:00
diff --git a/samples/SampleModule5/SRRProvider.cs b/samples/SampleModule5/SRRProvider.cs
@@ -5,7 +5,8 @@
 namespace SampleModule5
 {
     //使用Scoped确保每个请求不一样
-    [ExportScopedServices(typeof(IRequestRandomProvider))]
+    [ExportScopedServices]
+    //[ExportScopedServices(typeof(IRequestRandomProvider))]
     public class SRRProvider : IRequestRandomProvider
     {
         public int Random()
diff --git a/samples/SampleModule5/TRProvider.cs b/samples/SampleModule5/TRProvider.cs
@@ -5,7 +5,8 @@
 namespace SampleModule5
 {
     //使用Transient确保每次获取不一样
-    [ExportTransientServices(typeof(IRandomProvider))]
+    [ExportTransientServices]
+    //[ExportTransientServices(typeof(IRandomProvider))]
     public class TRProvider : IRandomProvider
     {
         public int Random()
diff --git a/src/Cuture.Extensions.Modularity/Attributes/ExportScopedServicesAttribute.cs b/src/Cuture.Extensions.Modularity/Attributes/ExportScopedServicesAttribute.cs
@@ -12,10 +12,7 @@ public class ExportScopedServicesAttribute : ExportServicesAttribute
     {
         #region Public 构造函数
 
-        /// <summary>
-        /// <inheritdoc cref="ExportScopedServicesAttribute"/>
-        /// </summary>
-        /// <param name="exportTypes"></param>
+        /// <inheritdoc cref="ExportScopedServicesAttribute(AddDIMode, Type[])"/>
         public ExportScopedServicesAttribute(params Type[] exportTypes) : base(ServiceLifetime.Scoped, exportTypes)
         {
         }
@@ -24,7 +21,7 @@ public ExportScopedServicesAttribute(params Type[] exportTypes) : base(ServiceLi
         /// <inheritdoc cref="ExportScopedServicesAttribute"/>
         /// </summary>
         /// <param name="addMode">添加到DI容器的方式</param>
-        /// <param name="exportTypes"></param>
+        /// <param name="exportTypes"><inheritdoc cref="ExportServicesAttribute(byte)"/></param>
         public ExportScopedServicesAttribute(AddDIMode addMode, params Type[] exportTypes) : base(ServiceLifetime.Scoped, addMode, exportTypes)
         {
         }
diff --git a/src/Cuture.Extensions.Modularity/Attributes/ExportServicesAttribute.cs b/src/Cuture.Extensions.Modularity/Attributes/ExportServicesAttribute.cs
@@ -51,25 +51,19 @@ public class ExportServicesAttribute : Attribute, IExportServicesProvider
 
         #region Public 构造函数
 
-        /// <summary>
-        /// <inheritdoc cref="ExportServicesAttribute"/>
-        /// </summary>
-        /// <param name="lifetime">导出服务的生命周期</param>
-        /// <param name="exportTypes"></param>
+        /// <inheritdoc cref="ExportServicesAttribute(ServiceLifetime, AddDIMode, Type[])"/>
         public ExportServicesAttribute(ServiceLifetime lifetime, params Type[] exportTypes)
         {
             Lifetime = lifetime;
-            ExportTypes = exportTypes.IsNullOrEmpty()
-                            ? throw new ArgumentOutOfRangeException(nameof(exportTypes), 0, "exportTypes cannot be less than 1 item.")
-                            : exportTypes;
+            ExportTypes = exportTypes;
         }
 
         /// <summary>
         /// <inheritdoc cref="ExportServicesAttribute"/>
         /// </summary>
         /// <param name="lifetime">导出服务的生命周期</param>
         /// <param name="addMode">添加到DI容器的方式</param>
-        /// <param name="exportTypes"></param>
+        /// <param name="exportTypes"><inheritdoc cref="ExportServicesAttribute(byte)"/></param>
         public ExportServicesAttribute(ServiceLifetime lifetime, AddDIMode addMode, params Type[] exportTypes) : this(lifetime, exportTypes)
         {
             AddDIMode = addMode;
@@ -97,6 +91,24 @@ public ExportServicesAttribute(ServiceLifetime lifetime, Type exportTypeDiscover
             AddDIMode = addMode;
         }
 
+        /// <summary>
+        ///
+        /// </summary>
+        /// <param name="exportTypes">
+        /// 导出的服务类型<para/>
+        /// 未明确指定时，将会尝试自动获取接口类型（排除IDisposable、IAsyncDisposable）<para/>
+        /// 如果自动获取到的接口类型数量不等于 1 个，则会抛出异常<para/>
+        /// 自动获取方法参见 <see cref="CutureExtensionsModularityTypeReflectionExtensions.GetMostLikelyDirectInterfaces"/><para/>
+        /// ------------------<para/>
+        /// Note!!! 使用自动导出时，务必测试是否符合预期。<para/>
+        /// </param>
+        /// <exception cref="NotImplementedException"></exception>
+        protected ExportServicesAttribute(byte exportTypes)
+        {
+            //此构造函数仅用于引用文档
+            throw new NotImplementedException();
+        }
+
         #endregion Public 构造函数
 
         #region Public 方法
@@ -108,7 +120,21 @@ public virtual IEnumerable<Type> GetExportServiceTypes(Type targetType)
 
             if (ExportTypeDiscovererType is null)
             {
-                return ExportTypes;
+                if (!ExportTypes.IsNullOrEmpty())
+                {
+                    return ExportTypes;
+                }
+                var types = targetType.GetMostLikelyDirectInterfacesExcludeDefaults()?.ToArray();
+                if (types is null
+                    || !types.Any())
+                {
+                    throw new ModularityException($"Can not get export service for type {targetType} automatically . Must use {nameof(ExportServicesAttribute)} define it clearly .");
+                }
+                else if (types.Length > 1)
+                {
+                    throw new ModularityException($"More than one interface was got by automatically get the export service interface for type {targetType} . Must use {nameof(ExportServicesAttribute)} define it clearly .");
+                }
+                return types.Take(1);
             }
             else
             {
diff --git a/src/Cuture.Extensions.Modularity/Attributes/ExportSingletonServicesAttribute.cs b/src/Cuture.Extensions.Modularity/Attributes/ExportSingletonServicesAttribute.cs
@@ -12,10 +12,7 @@ public class ExportSingletonServicesAttribute : ExportServicesAttribute
     {
         #region Public 构造函数
 
-        /// <summary>
-        /// <inheritdoc cref="ExportSingletonServicesAttribute"/>
-        /// </summary>
-        /// <param name="exportTypes"></param>
+        /// <inheritdoc cref="ExportSingletonServicesAttribute(AddDIMode, Type[])"/>
         public ExportSingletonServicesAttribute(params Type[] exportTypes) : base(ServiceLifetime.Singleton, exportTypes)
         {
         }
@@ -24,7 +21,7 @@ public ExportSingletonServicesAttribute(params Type[] exportTypes) : base(Servic
         /// <inheritdoc cref="ExportSingletonServicesAttribute"/>
         /// </summary>
         /// <param name="addMode">添加到DI容器的方式</param>
-        /// <param name="exportTypes"></param>
+        /// <param name="exportTypes"><inheritdoc cref="ExportServicesAttribute(byte)"/></param>
         public ExportSingletonServicesAttribute(AddDIMode addMode, params Type[] exportTypes) : base(ServiceLifetime.Singleton, addMode, exportTypes)
         {
         }
diff --git a/src/Cuture.Extensions.Modularity/Attributes/ExportTransientServicesAttribute.cs b/src/Cuture.Extensions.Modularity/Attributes/ExportTransientServicesAttribute.cs
@@ -12,10 +12,7 @@ public class ExportTransientServicesAttribute : ExportServicesAttribute
     {
         #region Public 构造函数
 
-        /// <summary>
-        /// <inheritdoc cref="ExportTransientServicesAttribute"/>
-        /// </summary>
-        /// <param name="exportTypes"></param>
+        /// <inheritdoc cref="ExportTransientServicesAttribute(AddDIMode, Type[])"/>
         public ExportTransientServicesAttribute(params Type[] exportTypes) : base(ServiceLifetime.Transient, exportTypes)
         {
         }
@@ -24,7 +21,7 @@ public ExportTransientServicesAttribute(params Type[] exportTypes) : base(Servic
         /// <inheritdoc cref="ExportTransientServicesAttribute"/>
         /// </summary>
         /// <param name="addMode">添加到DI容器的方式</param>
-        /// <param name="exportTypes"></param>
+        /// <param name="exportTypes"><inheritdoc cref="ExportServicesAttribute(byte)"/></param>
         public ExportTransientServicesAttribute(AddDIMode addMode, params Type[] exportTypes) : base(ServiceLifetime.Transient, addMode, exportTypes)
         {
         }
diff --git a/src/Cuture.Extensions.Modularity/Extensions/TypeReflectionExtensions.cs b/src/Cuture.Extensions.Modularity/Extensions/TypeReflectionExtensions.cs
@@ -0,0 +1,31 @@
+﻿using System.Collections.Generic;
+using System.Linq;
+
+namespace System
+{
+    /// <summary>
+    ///
+    /// </summary>
+    public static class CutureExtensionsModularityTypeReflectionExtensions
+    {
+        #region Public 方法
+
+        /// <summary>
+        /// 获取类型最有可能的直接接口<para/>
+        /// C#反射不能只获取代码中的直接继承接口，会获取间接继承的接口。通过一些简单的排除方法获取最有可能的接口，但不太能保证符合意图<para/>
+        /// https://stackoverflow.com/questions/5318685/get-only-direct-interface-instead-of-all <para/>
+        /// https://stackoverflow.com/questions/1613867/how-do-i-know-when-an-interface-is-directly-implemented-in-a-type-ignoring-inheri <para/>
+        /// </summary>
+        /// <param name="type"></param>
+        /// <returns></returns>
+        public static IEnumerable<Type> GetMostLikelyDirectInterfaces(this Type type)
+        {
+            var interfaces = type.BaseType is null
+                             ? type.GetInterfaces()
+                             : type.GetInterfaces().Except(type.BaseType.GetInterfaces());
+            return interfaces.Except(interfaces.SelectMany(t => t.GetInterfaces()));
+        }
+
+        #endregion Public 方法
+    }
+}
diff --git a/src/Cuture.Extensions.Modularity/Internal/Extensions/TypeExtensions.cs b/src/Cuture.Extensions.Modularity/Internal/Extensions/TypeExtensions.cs
@@ -143,6 +143,66 @@ public static void ThrowIfNotStandardAppModule(this Type type)
             }
         }
 
+        #region MostLikelyDirectInterfaces
+
+        private static WeakReference<Type[]?> s_defaultExcludeTypes = new(null);
+
+        /// <summary>
+        /// <inheritdoc cref="CutureExtensionsModularityTypeReflectionExtensions.GetMostLikelyDirectInterfaces"/>
+        /// </summary>
+        /// <param name="type"></param>
+        /// <param name="excludeTypes">要排除的类型</param>
+        /// <returns></returns>
+        public static IEnumerable<Type> GetMostLikelyDirectInterfaces(this Type? type, IEnumerable<Type> excludeTypes)
+        {
+            if (type is null)
+            {
+                return Array.Empty<Type>();
+            }
+            var types = type.GetMostLikelyDirectInterfaces().Except(excludeTypes).ToArray();
+            return types.Length > 0 ? types : GetMostLikelyDirectInterfaces(type.BaseType, excludeTypes);
+        }
+
+        /// <summary>
+        /// <inheritdoc cref="CutureExtensionsModularityTypeReflectionExtensions.GetMostLikelyDirectInterfaces"/>
+        /// 排除默认的类型 IDisposable IAsyncDisposable
+        /// </summary>
+        /// <param name="type"></param>
+        /// <returns></returns>
+        public static IEnumerable<Type> GetMostLikelyDirectInterfacesExcludeDefaults(this Type? type)
+        {
+            if (type is null)
+            {
+                return Array.Empty<Type>();
+            }
+            return type.GetMostLikelyDirectInterfaces(GetDefaultExcludeTypes());
+        }
+
+        private static Type[] GetDefaultExcludeTypes()
+        {
+            if (s_defaultExcludeTypes.TryGetTarget(out var types))
+            {
+                return types ?? Array.Empty<Type>();
+            }
+            lock (s_defaultExcludeTypes)
+            {
+                if (s_defaultExcludeTypes.TryGetTarget(out types))
+                {
+                    return types ?? Array.Empty<Type>();
+                }
+                types = new[] {
+                    typeof(IDisposable),
+#if NETCOREAPP3_0_OR_GREATER || NETSTANDARD2_1_OR_GREATER
+		            typeof(IAsyncDisposable)
+#endif
+                };
+                s_defaultExcludeTypes.SetTarget(types);
+                return types;
+            }
+        }
+
+        #endregion MostLikelyDirectInterfaces
+
         #endregion Public 方法
     }
 }
diff --git a/src/Directory.Build.props b/src/Directory.Build.props
@@ -29,7 +29,7 @@
 
   <!--Package Info-->
   <PropertyGroup>
-    <VersionPrefix>1.1.4</VersionPrefix>
+    <VersionPrefix>1.1.5</VersionPrefix>
 
     <PackageIdPrefix>Cuture.Extensions</PackageIdPrefix>
     <Authors>Stratos</Authors>

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,8 @@`
`5`	`5`	`namespace SampleModule5`
`6`	`6`	`{`
`7`	`7`	`//使用Scoped确保每个请求不一样`
`8`		`- [ExportScopedServices(typeof(IRequestRandomProvider))]`
	`8`	`+ [ExportScopedServices]`
	`9`	`+ //[ExportScopedServices(typeof(IRequestRandomProvider))]`
`9`	`10`	`public class SRRProvider : IRequestRandomProvider`
`10`	`11`	`{`
`11`	`12`	`public int Random()`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,8 @@`
`5`	`5`	`namespace SampleModule5`
`6`	`6`	`{`
`7`	`7`	`//使用Transient确保每次获取不一样`
`8`		`- [ExportTransientServices(typeof(IRandomProvider))]`
	`8`	`+ [ExportTransientServices]`
	`9`	`+ //[ExportTransientServices(typeof(IRandomProvider))]`
`9`	`10`	`public class TRProvider : IRandomProvider`
`10`	`11`	`{`
`11`	`12`	`public int Random()`
Original file line number	Diff line number	Diff line change
`@@ -12,10 +12,7 @@ public class ExportScopedServicesAttribute : ExportServicesAttribute`
`12`	`12`	`{`
`13`	`13`	`#region Public 构造函数`
`14`	`14`
`15`		`- /// <summary>`
`16`		`- /// <inheritdoc cref="ExportScopedServicesAttribute"/>`
`17`		`- /// </summary>`
`18`		`- /// <param name="exportTypes"></param>`
	`15`	`+ /// <inheritdoc cref="ExportScopedServicesAttribute(AddDIMode, Type[])"/>`
`19`	`16`	`public ExportScopedServicesAttribute(params Type[] exportTypes) : base(ServiceLifetime.Scoped, exportTypes)`
`20`	`17`	`{`
`21`	`18`	`}`
`@@ -24,7 +21,7 @@ public ExportScopedServicesAttribute(params Type[] exportTypes) : base(ServiceLi`
`24`	`21`	`/// <inheritdoc cref="ExportScopedServicesAttribute"/>`
`25`	`22`	`/// </summary>`
`26`	`23`	`/// <param name="addMode">添加到DI容器的方式</param>`
`27`		`- /// <param name="exportTypes"></param>`
	`24`	`+ /// <param name="exportTypes"><inheritdoc cref="ExportServicesAttribute(byte)"/></param>`
`28`	`25`	`public ExportScopedServicesAttribute(AddDIMode addMode, params Type[] exportTypes) : base(ServiceLifetime.Scoped, addMode, exportTypes)`
`29`	`26`	`{`
`30`	`27`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,10 +12,7 @@ public class ExportTransientServicesAttribute : ExportServicesAttribute`
`12`	`12`	`{`
`13`	`13`	`#region Public 构造函数`
`14`	`14`
`15`		`- /// <summary>`
`16`		`- /// <inheritdoc cref="ExportTransientServicesAttribute"/>`
`17`		`- /// </summary>`
`18`		`- /// <param name="exportTypes"></param>`
	`15`	`+ /// <inheritdoc cref="ExportTransientServicesAttribute(AddDIMode, Type[])"/>`
`19`	`16`	`public ExportTransientServicesAttribute(params Type[] exportTypes) : base(ServiceLifetime.Transient, exportTypes)`
`20`	`17`	`{`
`21`	`18`	`}`
`@@ -24,7 +21,7 @@ public ExportTransientServicesAttribute(params Type[] exportTypes) : base(Servic`
`24`	`21`	`/// <inheritdoc cref="ExportTransientServicesAttribute"/>`
`25`	`22`	`/// </summary>`
`26`	`23`	`/// <param name="addMode">添加到DI容器的方式</param>`
`27`		`- /// <param name="exportTypes"></param>`
	`24`	`+ /// <param name="exportTypes"><inheritdoc cref="ExportServicesAttribute(byte)"/></param>`
`28`	`25`	`public ExportTransientServicesAttribute(AddDIMode addMode, params Type[] exportTypes) : base(ServiceLifetime.Transient, addMode, exportTypes)`
`29`	`26`	`{`
`30`	`27`	`}`