// Copyright (c) 2025-2026 GeWuYou // SPDX-License-Identifier: Apache-2.0 using BenchmarkDotNet.Attributes; using BenchmarkDotNet.Columns; using BenchmarkDotNet.Configs; using BenchmarkDotNet.Diagnosers; using BenchmarkDotNet.Jobs; using BenchmarkDotNet.Order; using System; using System.Threading; using System.Threading.Tasks; using GFramework.Core.Abstractions.Logging; using GFramework.Core.Ioc; using GFramework.Core.Logging; using GFramework.Cqrs.Abstractions.Cqrs; using MediatR; using Microsoft.Extensions.DependencyInjection; namespace GFramework.Cqrs.Benchmarks.Messaging; /// /// 对比单处理器 notification publish 在不同 handler 生命周期下的额外开销。 /// /// /// 当前矩阵覆盖 SingletonScopedTransient。 /// 其中 Scoped 会在每次 notification publish 前显式创建并释放真实的 DI 作用域, /// 避免把 scoped handler 错误地压到根容器解析而扭曲生命周期对照。 /// [Config(typeof(Config))] public class NotificationLifetimeBenchmarks { private MicrosoftDiContainer _container = null!; private ICqrsRuntime? _runtime; private ScopedBenchmarkContainer? _scopedContainer; private ICqrsRuntime? _scopedRuntime; private ServiceProvider _serviceProvider = null!; private IPublisher? _publisher; private BenchmarkNotificationHandler _baselineHandler = null!; private BenchmarkNotification _notification = null!; private ILogger _runtimeLogger = null!; /// /// 控制当前 benchmark 使用的 handler 生命周期。 /// [Params(HandlerLifetime.Singleton, HandlerLifetime.Scoped, HandlerLifetime.Transient)] public HandlerLifetime Lifetime { get; set; } /// /// 可公平比较的 benchmark handler 生命周期集合。 /// public enum HandlerLifetime { /// /// 复用单个 handler 实例。 /// Singleton, /// /// 每次 publish 在显式作用域内解析并复用 handler 实例。 /// Scoped, /// /// 每次 publish 都重新解析新的 handler 实例。 /// Transient } /// /// 配置 notification lifetime benchmark 的公共输出格式。 /// private sealed class Config : ManualConfig { public Config() { AddJob(Job.Default); AddColumnProvider(DefaultColumnProviders.Instance); AddColumn(new CustomColumn("Scenario", static (_, _) => "NotificationLifetime")); AddDiagnoser(MemoryDiagnoser.Default); WithOrderer(new DefaultOrderer(SummaryOrderPolicy.FastestToSlowest, MethodOrderPolicy.Declared)); } } /// /// 构建当前生命周期下的 GFramework 与 MediatR notification 对照宿主。 /// [GlobalSetup] public void Setup() { LoggerFactoryResolver.Provider = new ConsoleLoggerFactoryProvider { MinLevel = LogLevel.Fatal }; Fixture.Setup($"NotificationLifetime/{Lifetime}", handlerCount: 1, pipelineCount: 0); BenchmarkDispatcherCacheHelper.ClearDispatcherCaches(); _baselineHandler = new BenchmarkNotificationHandler(); _notification = new BenchmarkNotification(Guid.NewGuid()); _runtimeLogger = LoggerFactoryResolver.Provider.CreateLogger(nameof(NotificationLifetimeBenchmarks) + "." + Lifetime); _container = BenchmarkHostFactory.CreateFrozenGFrameworkContainer(container => { RegisterGFrameworkHandler(container, Lifetime); }); if (Lifetime != HandlerLifetime.Scoped) { _runtime = GFramework.Cqrs.CqrsRuntimeFactory.CreateRuntime(_container, _runtimeLogger); } else { _scopedContainer = new ScopedBenchmarkContainer(_container); _scopedRuntime = GFramework.Cqrs.CqrsRuntimeFactory.CreateRuntime(_scopedContainer, _runtimeLogger); } _serviceProvider = BenchmarkHostFactory.CreateMediatRServiceProvider( configure: null, typeof(NotificationLifetimeBenchmarks), static candidateType => candidateType == typeof(BenchmarkNotificationHandler), ResolveMediatRLifetime(Lifetime)); if (Lifetime != HandlerLifetime.Scoped) { _publisher = _serviceProvider.GetRequiredService(); } } /// /// 释放当前生命周期矩阵持有的 benchmark 宿主资源。 /// [GlobalCleanup] public void Cleanup() { try { BenchmarkCleanupHelper.DisposeAll(_scopedContainer, _container, _serviceProvider); } finally { BenchmarkDispatcherCacheHelper.ClearDispatcherCaches(); } } /// /// 直接调用 handler,作为不同生命周期矩阵下的 publish 额外开销 baseline。 /// /// 代表基线 handler 完成当前 notification 处理的值任务。 [Benchmark(Baseline = true)] public ValueTask PublishNotification_Baseline() { return _baselineHandler.Handle(_notification, CancellationToken.None); } /// /// 通过 GFramework.CQRS runtime 发布 notification。 /// /// 代表当前 GFramework.CQRS publish 完成的值任务。 [Benchmark] public ValueTask PublishNotification_GFrameworkCqrs() { if (Lifetime == HandlerLifetime.Scoped) { return PublishScopedGFrameworkNotificationAsync( _scopedRuntime!, _scopedContainer!, _notification, CancellationToken.None); } return _runtime!.PublishAsync(BenchmarkContext.Instance, _notification, CancellationToken.None); } /// /// 通过 MediatR 发布 notification,作为外部对照。 /// /// 代表当前 MediatR publish 完成的任务。 [Benchmark] public Task PublishNotification_MediatR() { if (Lifetime == HandlerLifetime.Scoped) { return PublishScopedMediatRNotificationAsync(_serviceProvider, _notification, CancellationToken.None); } return _publisher!.Publish(_notification, CancellationToken.None); } /// /// 按生命周期把 benchmark notification handler 注册到 GFramework 容器。 /// /// 当前 benchmark 拥有并负责释放的容器。 /// 待比较的 handler 生命周期。 private static void RegisterGFrameworkHandler(MicrosoftDiContainer container, HandlerLifetime lifetime) { ArgumentNullException.ThrowIfNull(container); switch (lifetime) { case HandlerLifetime.Singleton: container.RegisterSingleton, BenchmarkNotificationHandler>(); return; case HandlerLifetime.Scoped: container.RegisterScoped, BenchmarkNotificationHandler>(); return; case HandlerLifetime.Transient: container.RegisterTransient, BenchmarkNotificationHandler>(); return; default: throw new ArgumentOutOfRangeException(nameof(lifetime), lifetime, "Unsupported benchmark handler lifetime."); } } /// /// 将 benchmark 生命周期映射为 MediatR 组装所需的 。 /// /// 待比较的 handler 生命周期。 private static ServiceLifetime ResolveMediatRLifetime(HandlerLifetime lifetime) { return lifetime switch { HandlerLifetime.Singleton => ServiceLifetime.Singleton, HandlerLifetime.Scoped => ServiceLifetime.Scoped, HandlerLifetime.Transient => ServiceLifetime.Transient, _ => throw new ArgumentOutOfRangeException(nameof(lifetime), lifetime, "Unsupported benchmark handler lifetime.") }; } /// /// 在真实的 publish 级作用域内执行一次 GFramework.CQRS notification 分发。 /// /// 复用的 scoped benchmark runtime。 /// 负责为每次 publish 激活独立作用域的只读容器适配层。 /// 要发布的 notification。 /// 取消令牌。 /// 代表当前 publish 完成的值任务。 /// /// notification lifetime benchmark 只关心 handler 解析和 publish 本身的热路径, /// 因此这里复用同一个 runtime,但在每次调用前后显式创建并释放新的 DI 作用域, /// 让 scoped handler 真正绑定到 publish 边界。 /// private static async ValueTask PublishScopedGFrameworkNotificationAsync( ICqrsRuntime runtime, ScopedBenchmarkContainer scopedContainer, BenchmarkNotification notification, CancellationToken cancellationToken) { ArgumentNullException.ThrowIfNull(runtime); ArgumentNullException.ThrowIfNull(scopedContainer); ArgumentNullException.ThrowIfNull(notification); using var scopeLease = scopedContainer.EnterScope(); await runtime.PublishAsync(BenchmarkContext.Instance, notification, cancellationToken).ConfigureAwait(false); } /// /// 在真实的 publish 级作用域内执行一次 MediatR notification 分发。 /// /// 当前 benchmark 的根 。 /// 要发布的 notification。 /// 取消令牌。 /// 代表当前 publish 完成的任务。 /// /// 这里显式从新的 scope 解析 ,确保 Scoped handler 与依赖绑定到 publish 边界。 /// private static async Task PublishScopedMediatRNotificationAsync( ServiceProvider rootServiceProvider, BenchmarkNotification notification, CancellationToken cancellationToken) { ArgumentNullException.ThrowIfNull(rootServiceProvider); ArgumentNullException.ThrowIfNull(notification); using var scope = rootServiceProvider.CreateScope(); var publisher = scope.ServiceProvider.GetRequiredService(); await publisher.Publish(notification, cancellationToken).ConfigureAwait(false); } /// /// Benchmark notification。 /// /// 通知标识。 public sealed record BenchmarkNotification(Guid Id) : GFramework.Cqrs.Abstractions.Cqrs.INotification, MediatR.INotification; /// /// 同时实现 GFramework.CQRS 与 MediatR 契约的最小 notification handler。 /// public sealed class BenchmarkNotificationHandler : GFramework.Cqrs.Abstractions.Cqrs.INotificationHandler, MediatR.INotificationHandler { /// /// 处理 GFramework.CQRS notification。 /// /// 当前要处理的 notification。 /// 取消令牌。 /// 代表当前 notification 处理完成的值任务。 public ValueTask Handle(BenchmarkNotification notification, CancellationToken cancellationToken) { ArgumentNullException.ThrowIfNull(notification); cancellationToken.ThrowIfCancellationRequested(); return ValueTask.CompletedTask; } /// /// 处理 MediatR notification。 /// Task MediatR.INotificationHandler.Handle( BenchmarkNotification notification, CancellationToken cancellationToken) { ArgumentNullException.ThrowIfNull(notification); cancellationToken.ThrowIfCancellationRequested(); return Task.CompletedTask; } } }