using GFramework.Core.Abstractions.Ioc; using GFramework.Core.Abstractions.Logging; using GFramework.Cqrs.Abstractions.Cqrs; namespace GFramework.Cqrs.Internal; /// /// 在架构初始化期间扫描并注册 CQRS 处理器。 /// 运行时会优先尝试使用源码生成的程序集级注册器,以减少冷启动阶段的反射开销; /// 当目标程序集没有生成注册器,或注册器不可用时,再回退到运行时反射扫描。 /// internal static class CqrsHandlerRegistrar { // 卸载安全的进程级缓存:程序集元数据只按弱键复用。 // 若程序集来自 collectible AssemblyLoadContext,被回收后会重新分析,而不会被静态缓存永久钉住。 private static readonly WeakKeyCache AssemblyMetadataCache = new(); // 卸载安全的进程级缓存:registry 类型的构造分析可跨容器复用,但不应阻止类型卸载。 private static readonly WeakKeyCache RegistryActivationMetadataCache = new(); // 卸载安全的进程级缓存:可加载类型列表只在程序集存活期间保留; // 若程序集卸载,后续重新加载后的首次注册会重新执行 GetTypes()/恢复逻辑。 private static readonly WeakKeyCache> LoadableTypesCache = new(); /// /// 扫描指定程序集并注册所有 CQRS 请求/通知/流式处理器。 /// /// 目标容器。 /// 要扫描的程序集集合。 /// 日志记录器。 public static void RegisterHandlers( IIocContainer container, IEnumerable assemblies, ILogger logger) { ArgumentNullException.ThrowIfNull(container); ArgumentNullException.ThrowIfNull(assemblies); ArgumentNullException.ThrowIfNull(logger); foreach (var assembly in assemblies .Where(static assembly => assembly is not null) .Distinct() .OrderBy(GetAssemblySortKey, StringComparer.Ordinal)) { var generatedRegistrationResult = TryRegisterGeneratedHandlers(container.GetServicesUnsafe, assembly, logger); if (generatedRegistrationResult is { UsedGeneratedRegistry: true, RequiresReflectionFallback: false }) continue; RegisterAssemblyHandlers( container.GetServicesUnsafe, assembly, logger, generatedRegistrationResult.ReflectionFallbackMetadata); } } /// /// 优先使用程序集级源码生成注册器完成 CQRS 映射注册。 /// /// 目标服务集合。 /// 当前要处理的程序集。 /// 日志记录器。 /// 生成注册器的使用结果。 private static GeneratedRegistrationResult TryRegisterGeneratedHandlers( IServiceCollection services, Assembly assembly, ILogger logger) { var assemblyName = GetAssemblySortKey(assembly); try { var assemblyMetadata = AssemblyMetadataCache.GetOrAdd( assembly, key => AnalyzeAssemblyRegistrationMetadata(key, logger)); var registryTypes = assemblyMetadata.RegistryTypes; if (registryTypes.Count == 0) return GeneratedRegistrationResult.NoGeneratedRegistry(); var registries = new List(registryTypes.Count); foreach (var registryType in registryTypes) { var activationMetadata = RegistryActivationMetadataCache.GetOrAdd( registryType, AnalyzeRegistryActivation); if (!activationMetadata.ImplementsRegistryContract) { logger.Warn( $"Ignoring generated CQRS handler registry {registryType.FullName} in assembly {assemblyName} because it does not implement {typeof(ICqrsHandlerRegistry).FullName}."); return GeneratedRegistrationResult.NoGeneratedRegistry(); } if (activationMetadata.IsAbstract) { logger.Warn( $"Ignoring generated CQRS handler registry {registryType.FullName} in assembly {assemblyName} because it is abstract."); return GeneratedRegistrationResult.NoGeneratedRegistry(); } if (activationMetadata.Factory is null) { logger.Warn( $"Ignoring generated CQRS handler registry {registryType.FullName} in assembly {assemblyName} because it does not expose an accessible parameterless constructor."); return GeneratedRegistrationResult.NoGeneratedRegistry(); } var registry = activationMetadata.Factory(); registries.Add(registry); } foreach (var registry in registries) { logger.Debug( $"Registering CQRS handlers for assembly {assemblyName} via generated registry {registry.GetType().FullName}."); registry.Register(services, logger); } var reflectionFallbackMetadata = assemblyMetadata.ReflectionFallbackMetadata; if (reflectionFallbackMetadata is not null) { if (reflectionFallbackMetadata.HasExplicitTypes) { logger.Debug( $"Generated CQRS registry for assembly {assemblyName} requested targeted reflection fallback for {reflectionFallbackMetadata.Types.Count} unsupported handler type(s)."); } else { logger.Debug( $"Generated CQRS registry for assembly {assemblyName} requested full reflection fallback for unsupported handlers."); } return GeneratedRegistrationResult.WithReflectionFallback(reflectionFallbackMetadata); } return GeneratedRegistrationResult.FullyHandled(); } catch (Exception exception) { logger.Warn( $"Generated CQRS handler registry discovery failed for assembly {assemblyName}. Falling back to reflection scan."); logger.Warn( $"Failed to use generated CQRS handler registry for assembly {assemblyName}: {exception.Message}"); return GeneratedRegistrationResult.NoGeneratedRegistry(); } } /// /// 注册单个程序集里的所有 CQRS 处理器映射。 /// private static void RegisterAssemblyHandlers( IServiceCollection services, Assembly assembly, ILogger logger, ReflectionFallbackMetadata? reflectionFallbackMetadata) { foreach (var implementationType in GetCandidateHandlerTypes(assembly, logger, reflectionFallbackMetadata) .Where(IsConcreteHandlerType)) { var handlerInterfaces = implementationType .GetInterfaces() .Where(IsSupportedHandlerInterface) .OrderBy(GetTypeSortKey, StringComparer.Ordinal) .ToList(); if (handlerInterfaces.Count == 0) continue; foreach (var handlerInterface in handlerInterfaces) { if (IsHandlerMappingAlreadyRegistered(services, handlerInterface, implementationType)) { logger.Debug( $"Skipping duplicate CQRS handler {implementationType.FullName} as {handlerInterface.FullName}."); continue; } // Request/notification handlers receive context injection before every dispatch. // Transient registration avoids sharing mutable Context across concurrent requests. services.AddTransient(handlerInterface, implementationType); logger.Debug( $"Registered CQRS handler {implementationType.FullName} as {handlerInterface.FullName}."); } } } /// /// 根据生成器提供的 fallback 清单或整程序集扫描结果,获取本轮要注册的候选处理器类型。 /// private static IReadOnlyList GetCandidateHandlerTypes( Assembly assembly, ILogger logger, ReflectionFallbackMetadata? reflectionFallbackMetadata) { return reflectionFallbackMetadata is { HasExplicitTypes: true } ? reflectionFallbackMetadata.Types : GetLoadableTypes(assembly, logger); } /// /// 获取生成注册器要求运行时继续补充反射扫描的 handler 元数据。 /// private static ReflectionFallbackMetadata? GetReflectionFallbackMetadata( Assembly assembly, ILogger logger) { var assemblyName = GetAssemblySortKey(assembly); var fallbackAttributes = assembly .GetCustomAttributes(typeof(CqrsReflectionFallbackAttribute), inherit: false) .OfType() .ToList(); if (fallbackAttributes.Count == 0) return null; var resolvedTypes = new List(); foreach (var fallbackType in fallbackAttributes .SelectMany(static attribute => attribute.FallbackHandlerTypes) .Where(static type => type is not null) .Distinct() .OrderBy(GetTypeSortKey, StringComparer.Ordinal)) { if (!string.Equals( GetAssemblySortKey(fallbackType.Assembly), assemblyName, StringComparison.Ordinal)) { logger.Warn( $"Generated CQRS reflection fallback type {fallbackType.FullName} was declared on assembly {assemblyName} but belongs to assembly {GetAssemblySortKey(fallbackType.Assembly)}. Skipping mismatched fallback entry."); continue; } resolvedTypes.Add(fallbackType); } foreach (var typeName in fallbackAttributes .SelectMany(static attribute => attribute.FallbackHandlerTypeNames) .Where(static name => !string.IsNullOrWhiteSpace(name)) .Distinct(StringComparer.Ordinal) .OrderBy(static name => name, StringComparer.Ordinal)) { try { var type = assembly.GetType(typeName, throwOnError: false, ignoreCase: false); if (type is null) { logger.Warn( $"Generated CQRS reflection fallback type {typeName} could not be resolved in assembly {assemblyName}. Skipping targeted fallback entry."); continue; } resolvedTypes.Add(type); } catch (Exception exception) { logger.Warn( $"Generated CQRS reflection fallback type {typeName} failed to load in assembly {assemblyName}: {exception.Message}"); } } return new ReflectionFallbackMetadata( resolvedTypes .Distinct() .OrderBy(GetTypeSortKey, StringComparer.Ordinal) .ToArray()); } /// /// 安全获取程序集中的可加载类型,并在部分类型加载失败时保留其余处理器注册能力。 /// private static IReadOnlyList GetLoadableTypes(Assembly assembly, ILogger logger) { return LoadableTypesCache.GetOrAdd( assembly, key => LoadAndSortTypes(key, logger)); } /// /// 分析并缓存指定程序集上的 generated-registry 与 fallback 元数据。 /// private static AssemblyRegistrationMetadata AnalyzeAssemblyRegistrationMetadata( Assembly assembly, ILogger logger) { var registryTypes = assembly .GetCustomAttributes(typeof(CqrsHandlerRegistryAttribute), inherit: false) .OfType() .Select(static attribute => attribute.RegistryType) .Where(static type => type is not null) .Distinct() .OrderBy(GetTypeSortKey, StringComparer.Ordinal) .ToArray(); var reflectionFallbackMetadata = GetReflectionFallbackMetadata(assembly, logger); return new AssemblyRegistrationMetadata(registryTypes, reflectionFallbackMetadata); } /// /// 分析并缓存 registry 类型的可激活性,避免每次注册都重复检查接口实现与构造函数。 /// private static RegistryActivationMetadata AnalyzeRegistryActivation(Type registryType) { var implementsRegistryContract = typeof(ICqrsHandlerRegistry).IsAssignableFrom(registryType); if (!implementsRegistryContract) return new RegistryActivationMetadata(false, registryType.IsAbstract, null); if (registryType.IsAbstract) return new RegistryActivationMetadata(true, true, null); var constructor = registryType.GetConstructor( BindingFlags.Instance | BindingFlags.Public | BindingFlags.NonPublic, binder: null, Type.EmptyTypes, modifiers: null); return constructor is null ? new RegistryActivationMetadata(true, false, null) : new RegistryActivationMetadata( true, false, () => (ICqrsHandlerRegistry)constructor.Invoke(null)); } /// /// 首次命中未生成 registry 的程序集时加载并排序全部可扫描类型,后续复用缓存结果。 /// private static IReadOnlyList LoadAndSortTypes(Assembly assembly, ILogger logger) { try { return assembly.GetTypes() .Where(static type => type is not null) .OrderBy(GetTypeSortKey, StringComparer.Ordinal) .ToArray(); } catch (ReflectionTypeLoadException exception) { return RecoverLoadableTypes(assembly, exception, logger); } } /// /// 记录部分类型加载失败,并返回仍然可用的类型集合。 /// private static IReadOnlyList RecoverLoadableTypes( Assembly assembly, ReflectionTypeLoadException exception, ILogger logger) { var assemblyName = GetAssemblySortKey(assembly); logger.Warn( $"CQRS handler scan partially failed for assembly {assemblyName}. Continuing with loadable types."); foreach (var loaderException in exception.LoaderExceptions.Where(static ex => ex is not null)) { logger.Warn( $"Failed to load one or more types while scanning {assemblyName}: {loaderException!.Message}"); } return exception.Types .Where(static type => type is not null) .Cast() .OrderBy(GetTypeSortKey, StringComparer.Ordinal) .ToList(); } /// /// 判断指定类型是否可作为可实例化处理器。 /// private static bool IsConcreteHandlerType(Type type) { return type is { IsAbstract: false, IsInterface: false } && !type.ContainsGenericParameters; } /// /// 判断接口是否为当前运行时支持的 CQRS 处理器接口。 /// private static bool IsSupportedHandlerInterface(Type type) { if (!type.IsGenericType) return false; var definition = type.GetGenericTypeDefinition(); return definition == typeof(IRequestHandler<,>) || definition == typeof(INotificationHandler<>) || definition == typeof(IStreamRequestHandler<,>); } /// /// 判断同一 handler 映射是否已经由生成注册器或先前扫描步骤写入服务集合。 /// private static bool IsHandlerMappingAlreadyRegistered( IServiceCollection services, Type handlerInterface, Type implementationType) { // 这里保持线性扫描,避免为常见的小到中等规模程序集长期维护额外索引。 // 若未来大型服务集合出现热点,可在更高层批处理中引入 HashSet<(Type, Type)> 做 O(1) 去重。 return services.Any(descriptor => descriptor.ServiceType == handlerInterface && descriptor.ImplementationType == implementationType); } /// /// 生成程序集排序键,保证跨运行环境的处理器注册顺序稳定。 /// private static string GetAssemblySortKey(Assembly assembly) { return assembly.FullName ?? assembly.GetName().Name ?? assembly.ToString(); } /// /// 生成类型排序键,保证同一程序集内的处理器与接口映射顺序稳定。 /// private static string GetTypeSortKey(Type type) { return type.FullName ?? type.Name; } private readonly record struct GeneratedRegistrationResult( bool UsedGeneratedRegistry, bool RequiresReflectionFallback, ReflectionFallbackMetadata? ReflectionFallbackMetadata) { public static GeneratedRegistrationResult NoGeneratedRegistry() { return new GeneratedRegistrationResult( UsedGeneratedRegistry: false, RequiresReflectionFallback: false, ReflectionFallbackMetadata: null); } public static GeneratedRegistrationResult FullyHandled() { return new GeneratedRegistrationResult( UsedGeneratedRegistry: true, RequiresReflectionFallback: false, ReflectionFallbackMetadata: null); } public static GeneratedRegistrationResult WithReflectionFallback( ReflectionFallbackMetadata reflectionFallbackMetadata) { ArgumentNullException.ThrowIfNull(reflectionFallbackMetadata); return new GeneratedRegistrationResult( UsedGeneratedRegistry: true, RequiresReflectionFallback: true, ReflectionFallbackMetadata: reflectionFallbackMetadata); } } private sealed class ReflectionFallbackMetadata(IReadOnlyList types) { public IReadOnlyList Types { get; } = types ?? throw new ArgumentNullException(nameof(types)); public bool HasExplicitTypes => Types.Count > 0; } private sealed class AssemblyRegistrationMetadata( IReadOnlyList registryTypes, ReflectionFallbackMetadata? reflectionFallbackMetadata) { public IReadOnlyList RegistryTypes { get; } = registryTypes ?? throw new ArgumentNullException(nameof(registryTypes)); public ReflectionFallbackMetadata? ReflectionFallbackMetadata { get; } = reflectionFallbackMetadata; } private sealed class RegistryActivationMetadata( bool implementsRegistryContract, bool isAbstract, Func? factory) { public bool ImplementsRegistryContract { get; } = implementsRegistryContract; public bool IsAbstract { get; } = isAbstract; public Func? Factory { get; } = factory; } }