mirror of
https://github.com/GeWuYou/GFramework.git
synced 2026-05-07 00:39:00 +08:00
7cf0a75568
- 优化 generated registry 激活流程，使用缓存工厂委托优先替代 ConstructorInfo.Invoke\n- 补充私有无参构造 registry 的回归测试，保持生成器产物兼容性\n- 更新 CQRS ai-plan 恢复点与验证记录，指向新的 Phase 8 下一步
532 lines
22 KiB
C#
532 lines
22 KiB
C#
using GFramework.Core.Abstractions.Ioc;
|
||
using GFramework.Core.Abstractions.Logging;
|
||
using GFramework.Cqrs.Abstractions.Cqrs;
|
||
using System.Reflection.Emit;
|
||
|
||
namespace GFramework.Cqrs.Internal;
|
||
|
||
/// <summary>
|
||
/// 在架构初始化期间扫描并注册 CQRS 处理器。
|
||
/// 运行时会优先尝试使用源码生成的程序集级注册器，以减少冷启动阶段的反射开销；
|
||
/// 当目标程序集没有生成注册器，或注册器不可用时，再回退到运行时反射扫描。
|
||
/// </summary>
|
||
internal static class CqrsHandlerRegistrar
|
||
{
|
||
// 卸载安全的进程级缓存：程序集元数据只按弱键复用。
|
||
// 若程序集来自 collectible AssemblyLoadContext，被回收后会重新分析，而不会被静态缓存永久钉住。
|
||
private static readonly WeakKeyCache<Assembly, AssemblyRegistrationMetadata> AssemblyMetadataCache =
|
||
new();
|
||
|
||
// 卸载安全的进程级缓存：registry 类型的构造分析可跨容器复用，但不应阻止类型卸载。
|
||
private static readonly WeakKeyCache<Type, RegistryActivationMetadata> RegistryActivationMetadataCache =
|
||
new();
|
||
|
||
// 卸载安全的进程级缓存：可加载类型列表只在程序集存活期间保留；
|
||
// 若程序集卸载，后续重新加载后的首次注册会重新执行 GetTypes()/恢复逻辑。
|
||
private static readonly WeakKeyCache<Assembly, IReadOnlyList<Type>> LoadableTypesCache =
|
||
new();
|
||
|
||
/// <summary>
|
||
/// 扫描指定程序集并注册所有 CQRS 请求/通知/流式处理器。
|
||
/// </summary>
|
||
/// <param name="container">目标容器。</param>
|
||
/// <param name="assemblies">要扫描的程序集集合。</param>
|
||
/// <param name="logger">日志记录器。</param>
|
||
public static void RegisterHandlers(
|
||
IIocContainer container,
|
||
IEnumerable<Assembly> 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);
|
||
}
|
||
}
|
||
|
||
/// <summary>
|
||
/// 优先使用程序集级源码生成注册器完成 CQRS 映射注册。
|
||
/// </summary>
|
||
/// <param name="services">目标服务集合。</param>
|
||
/// <param name="assembly">当前要处理的程序集。</param>
|
||
/// <param name="logger">日志记录器。</param>
|
||
/// <returns>生成注册器的使用结果。</returns>
|
||
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<ICqrsHandlerRegistry>(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();
|
||
}
|
||
}
|
||
|
||
/// <summary>
|
||
/// 注册单个程序集里的所有 CQRS 处理器映射。
|
||
/// </summary>
|
||
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}.");
|
||
}
|
||
}
|
||
}
|
||
|
||
/// <summary>
|
||
/// 根据生成器提供的 fallback 清单或整程序集扫描结果，获取本轮要注册的候选处理器类型。
|
||
/// </summary>
|
||
private static IReadOnlyList<Type> GetCandidateHandlerTypes(
|
||
Assembly assembly,
|
||
ILogger logger,
|
||
ReflectionFallbackMetadata? reflectionFallbackMetadata)
|
||
{
|
||
return reflectionFallbackMetadata is { HasExplicitTypes: true }
|
||
? reflectionFallbackMetadata.Types
|
||
: GetLoadableTypes(assembly, logger);
|
||
}
|
||
|
||
/// <summary>
|
||
/// 获取生成注册器要求运行时继续补充反射扫描的 handler 元数据。
|
||
/// </summary>
|
||
private static ReflectionFallbackMetadata? GetReflectionFallbackMetadata(
|
||
Assembly assembly,
|
||
ILogger logger)
|
||
{
|
||
var assemblyName = GetAssemblySortKey(assembly);
|
||
var fallbackAttributes = assembly
|
||
.GetCustomAttributes(typeof(CqrsReflectionFallbackAttribute), inherit: false)
|
||
.OfType<CqrsReflectionFallbackAttribute>()
|
||
.ToList();
|
||
|
||
if (fallbackAttributes.Count == 0)
|
||
return null;
|
||
|
||
var resolvedTypes = new List<Type>();
|
||
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());
|
||
}
|
||
|
||
/// <summary>
|
||
/// 安全获取程序集中的可加载类型，并在部分类型加载失败时保留其余处理器注册能力。
|
||
/// </summary>
|
||
private static IReadOnlyList<Type> GetLoadableTypes(Assembly assembly, ILogger logger)
|
||
{
|
||
return LoadableTypesCache.GetOrAdd(
|
||
assembly,
|
||
key => LoadAndSortTypes(key, logger));
|
||
}
|
||
|
||
/// <summary>
|
||
/// 分析并缓存指定程序集上的 generated-registry 与 fallback 元数据。
|
||
/// </summary>
|
||
private static AssemblyRegistrationMetadata AnalyzeAssemblyRegistrationMetadata(
|
||
Assembly assembly,
|
||
ILogger logger)
|
||
{
|
||
var registryTypes = assembly
|
||
.GetCustomAttributes(typeof(CqrsHandlerRegistryAttribute), inherit: false)
|
||
.OfType<CqrsHandlerRegistryAttribute>()
|
||
.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);
|
||
}
|
||
|
||
/// <summary>
|
||
/// 分析并缓存 registry 类型的可激活性，避免每次注册都重复检查接口实现与构造函数。
|
||
/// </summary>
|
||
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,
|
||
CreateRegistryFactory(registryType, constructor));
|
||
}
|
||
|
||
/// <summary>
|
||
/// 为生成注册器创建可复用的激活工厂，优先使用一次性编译的动态方法，
|
||
/// 避免后续每次命中缓存时仍走 <see cref="ConstructorInfo" /> 的反射激活路径。
|
||
/// </summary>
|
||
/// <param name="registryType">生成注册器类型。</param>
|
||
/// <param name="constructor">已解析的无参构造函数。</param>
|
||
/// <returns>可直接实例化注册器的工厂委托。</returns>
|
||
private static Func<ICqrsHandlerRegistry> CreateRegistryFactory(
|
||
Type registryType,
|
||
ConstructorInfo constructor)
|
||
{
|
||
ArgumentNullException.ThrowIfNull(registryType);
|
||
ArgumentNullException.ThrowIfNull(constructor);
|
||
|
||
try
|
||
{
|
||
// 生成器产物通常是稳定的无参 registry；这里把构造反射收敛为一次性 IL 工厂，
|
||
// 这样同一 registry 类型在多个容器间复用缓存时不会重复付出 ConstructorInfo.Invoke 成本。
|
||
var dynamicMethod = new DynamicMethod(
|
||
$"Create_{registryType.Name}_CqrsHandlerRegistry",
|
||
typeof(ICqrsHandlerRegistry),
|
||
Type.EmptyTypes,
|
||
registryType.Module,
|
||
skipVisibility: true);
|
||
var il = dynamicMethod.GetILGenerator();
|
||
il.Emit(OpCodes.Newobj, constructor);
|
||
|
||
if (registryType.IsValueType)
|
||
{
|
||
il.Emit(OpCodes.Box, registryType);
|
||
}
|
||
|
||
il.Emit(OpCodes.Castclass, typeof(ICqrsHandlerRegistry));
|
||
il.Emit(OpCodes.Ret);
|
||
|
||
return (Func<ICqrsHandlerRegistry>)dynamicMethod.CreateDelegate(typeof(Func<ICqrsHandlerRegistry>));
|
||
}
|
||
catch
|
||
{
|
||
// 某些受限运行环境若不允许动态方法，仍保留原有的反射激活语义，避免阻塞 generated registry 路径。
|
||
return () => (ICqrsHandlerRegistry)constructor.Invoke(null);
|
||
}
|
||
}
|
||
|
||
/// <summary>
|
||
/// 首次命中未生成 registry 的程序集时加载并排序全部可扫描类型，后续复用缓存结果。
|
||
/// </summary>
|
||
private static IReadOnlyList<Type> 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);
|
||
}
|
||
}
|
||
|
||
/// <summary>
|
||
/// 记录部分类型加载失败，并返回仍然可用的类型集合。
|
||
/// </summary>
|
||
private static IReadOnlyList<Type> 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<Type>()
|
||
.OrderBy(GetTypeSortKey, StringComparer.Ordinal)
|
||
.ToList();
|
||
}
|
||
|
||
/// <summary>
|
||
/// 判断指定类型是否可作为可实例化处理器。
|
||
/// </summary>
|
||
private static bool IsConcreteHandlerType(Type type)
|
||
{
|
||
return type is { IsAbstract: false, IsInterface: false } && !type.ContainsGenericParameters;
|
||
}
|
||
|
||
/// <summary>
|
||
/// 判断接口是否为当前运行时支持的 CQRS 处理器接口。
|
||
/// </summary>
|
||
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<,>);
|
||
}
|
||
|
||
/// <summary>
|
||
/// 判断同一 handler 映射是否已经由生成注册器或先前扫描步骤写入服务集合。
|
||
/// </summary>
|
||
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);
|
||
}
|
||
|
||
/// <summary>
|
||
/// 生成程序集排序键，保证跨运行环境的处理器注册顺序稳定。
|
||
/// </summary>
|
||
private static string GetAssemblySortKey(Assembly assembly)
|
||
{
|
||
return assembly.FullName ?? assembly.GetName().Name ?? assembly.ToString();
|
||
}
|
||
|
||
/// <summary>
|
||
/// 生成类型排序键，保证同一程序集内的处理器与接口映射顺序稳定。
|
||
/// </summary>
|
||
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<Type> types)
|
||
{
|
||
public IReadOnlyList<Type> Types { get; } = types ?? throw new ArgumentNullException(nameof(types));
|
||
|
||
public bool HasExplicitTypes => Types.Count > 0;
|
||
}
|
||
|
||
private sealed class AssemblyRegistrationMetadata(
|
||
IReadOnlyList<Type> registryTypes,
|
||
ReflectionFallbackMetadata? reflectionFallbackMetadata)
|
||
{
|
||
public IReadOnlyList<Type> RegistryTypes { get; } =
|
||
registryTypes ?? throw new ArgumentNullException(nameof(registryTypes));
|
||
|
||
public ReflectionFallbackMetadata? ReflectionFallbackMetadata { get; } = reflectionFallbackMetadata;
|
||
}
|
||
|
||
private sealed class RegistryActivationMetadata(
|
||
bool implementsRegistryContract,
|
||
bool isAbstract,
|
||
Func<ICqrsHandlerRegistry>? factory)
|
||
{
|
||
public bool ImplementsRegistryContract { get; } = implementsRegistryContract;
|
||
|
||
public bool IsAbstract { get; } = isAbstract;
|
||
|
||
public Func<ICqrsHandlerRegistry>? Factory { get; } = factory;
|
||
}
|
||
}
|