// 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; using GeneratedMediator = Mediator.Mediator; namespace GFramework.Cqrs.Benchmarks.Messaging; /// /// 对比 request steady-state dispatch 在不同 handler 生命周期下的额外开销。 /// /// /// 当前矩阵覆盖 `Singleton`、`Scoped` 与 `Transient`。 /// 其中 `Scoped` 会在每次 request 分发时显式创建并释放真实的 DI 作用域, /// 避免把 scoped handler 错误地压到根容器解析而扭曲生命周期对照。 /// [Config(typeof(Config))] public class RequestLifetimeBenchmarks { private MicrosoftDiContainer _container = null!; private ICqrsRuntime? _runtime; private ScopedBenchmarkContainer? _scopedContainer; private ICqrsRuntime? _scopedRuntime; private ServiceProvider _serviceProvider = null!; private ServiceProvider _mediatorServiceProvider = null!; private IMediator? _mediatr; private GeneratedMediator? _mediator; private BenchmarkRequestHandler _baselineHandler = null!; private BenchmarkRequest _request = 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, /// /// 每次 request 在显式作用域内解析并复用 handler 实例。 /// Scoped, /// /// 每次分发都重新解析新的 handler 实例。 /// Transient } /// /// 配置 request lifetime benchmark 的公共输出格式。 /// private sealed class Config : ManualConfig { public Config() { AddJob(Job.Default); AddColumnProvider(DefaultColumnProviders.Instance); AddColumn(new CustomColumn("Scenario", static (_, _) => "RequestLifetime")); AddDiagnoser(MemoryDiagnoser.Default); WithOrderer(new DefaultOrderer(SummaryOrderPolicy.FastestToSlowest, MethodOrderPolicy.Declared)); } } /// /// 构建当前生命周期下的 GFramework、NuGet `Mediator` 与 MediatR request 对照宿主。 /// [GlobalSetup] public void Setup() { LoggerFactoryResolver.Provider = new ConsoleLoggerFactoryProvider { MinLevel = LogLevel.Fatal }; Fixture.Setup($"RequestLifetime/{Lifetime}", handlerCount: 1, pipelineCount: 0); BenchmarkDispatcherCacheHelper.ClearDispatcherCaches(); _baselineHandler = new BenchmarkRequestHandler(); _request = new BenchmarkRequest(Guid.NewGuid()); _runtimeLogger = LoggerFactoryResolver.Provider.CreateLogger(nameof(RequestLifetimeBenchmarks) + "." + Lifetime); _container = BenchmarkHostFactory.CreateFrozenGFrameworkContainer(container => { BenchmarkHostFactory.RegisterGeneratedBenchmarkRegistry(container); RegisterGFrameworkHandler(container, Lifetime); }); // 容器内已提前保留默认 runtime 以支撑 generated registry 接线; // 这里额外创建带生命周期后缀的 runtime,只是为了区分不同 benchmark 矩阵的 dispatcher 日志。 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(RequestLifetimeBenchmarks), static candidateType => candidateType == typeof(BenchmarkRequestHandler), ResolveMediatRLifetime(Lifetime)); if (Lifetime != HandlerLifetime.Scoped) { _mediatr = _serviceProvider.GetRequiredService(); } _mediatorServiceProvider = CreateMediatorServiceProvider(Lifetime); if (Lifetime != HandlerLifetime.Scoped) { _mediator = _mediatorServiceProvider.GetRequiredService(); } } /// /// 释放当前生命周期矩阵持有的 benchmark 宿主资源。 /// [GlobalCleanup] public void Cleanup() { try { BenchmarkCleanupHelper.DisposeAll(_container, _serviceProvider, _mediatorServiceProvider); } finally { BenchmarkDispatcherCacheHelper.ClearDispatcherCaches(); } } /// /// 直接调用 handler,作为不同生命周期矩阵下的 dispatch 额外开销 baseline。 /// /// 代表基线 request handler 完成当前 request 处理的值任务。 [Benchmark(Baseline = true)] public ValueTask SendRequest_Baseline() { return _baselineHandler.Handle(_request, CancellationToken.None); } /// /// 通过 GFramework.CQRS runtime 发送 request。 /// /// 代表当前 GFramework.CQRS request dispatch 完成的值任务。 [Benchmark] public ValueTask SendRequest_GFrameworkCqrs() { if (Lifetime == HandlerLifetime.Scoped) { return BenchmarkHostFactory.SendScopedGFrameworkRequestAsync( _scopedRuntime!, _scopedContainer!, BenchmarkContext.Instance, _request, CancellationToken.None); } return _runtime!.SendAsync(BenchmarkContext.Instance, _request, CancellationToken.None); } /// /// 通过 MediatR 发送 request,作为外部对照。 /// /// 代表当前 MediatR request dispatch 完成的任务。 [Benchmark] public Task SendRequest_MediatR() { if (Lifetime == HandlerLifetime.Scoped) { return BenchmarkHostFactory.SendScopedMediatRRequestAsync( _serviceProvider, _request, CancellationToken.None); } return _mediatr!.Send(_request, CancellationToken.None); } /// /// 通过 `Mediator` source-generated concrete mediator 发送 request,作为 compile-time 对照。 /// /// 代表当前 `Mediator` request dispatch 完成的值任务。 [Benchmark] public ValueTask SendRequest_Mediator() { if (Lifetime == HandlerLifetime.Scoped) { return SendScopedMediatorRequestAsync( _mediatorServiceProvider, _request, CancellationToken.None); } return _mediator!.Send(_request, CancellationToken.None); } /// /// 按生命周期把 benchmark request handler 注册到 GFramework 容器。 /// /// 当前 benchmark 拥有并负责释放的容器。 /// 待比较的 handler 生命周期。 /// /// 先通过 generated registry 提供静态 descriptor,再显式覆盖 handler 生命周期, /// 可以把比较变量收敛到 handler 解析成本,而不是 descriptor 发现路径本身。 /// private static void RegisterGFrameworkHandler(MicrosoftDiContainer container, HandlerLifetime lifetime) { ArgumentNullException.ThrowIfNull(container); switch (lifetime) { case HandlerLifetime.Singleton: container.RegisterSingleton, BenchmarkRequestHandler>(); return; case HandlerLifetime.Scoped: container.RegisterScoped, BenchmarkRequestHandler>(); return; case HandlerLifetime.Transient: container.RegisterTransient, BenchmarkRequestHandler>(); 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.") }; } /// /// 构建只承载当前 benchmark request handler 的最小 `Mediator` 对照宿主,并按生命周期切换生成器注册形状。 /// /// 待比较的 handler 生命周期。 /// 可直接解析 generated `Mediator.Mediator` 的 DI 宿主。 private static ServiceProvider CreateMediatorServiceProvider(HandlerLifetime lifetime) { return lifetime switch { HandlerLifetime.Singleton => CreateSingletonMediatorServiceProvider(), HandlerLifetime.Scoped => CreateScopedMediatorServiceProvider(), HandlerLifetime.Transient => CreateTransientMediatorServiceProvider(), _ => throw new ArgumentOutOfRangeException(nameof(lifetime), lifetime, "Unsupported benchmark handler lifetime.") }; } /// /// 在真实的 request 级作用域内执行一次 `Mediator` request 分发。 /// /// 请求响应类型。 /// 当前 benchmark 的根 。 /// 要发送的 request。 /// 取消令牌。 /// 当前 request 的响应结果。 private static async ValueTask SendScopedMediatorRequestAsync( ServiceProvider rootServiceProvider, Mediator.IRequest request, CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(rootServiceProvider); ArgumentNullException.ThrowIfNull(request); using var scope = rootServiceProvider.CreateScope(); var mediator = scope.ServiceProvider.GetRequiredService(); return await mediator.Send(request, cancellationToken).ConfigureAwait(false); } /// /// 构建 singleton 生命周期的 `Mediator` 对照宿主。 /// /// 按 singleton 形状生成 DI 注册的 `Mediator` 宿主。 private static ServiceProvider CreateSingletonMediatorServiceProvider() { var services = new ServiceCollection(); services.AddMediator(static options => options.ServiceLifetime = ServiceLifetime.Singleton); return services.BuildServiceProvider(); } /// /// 构建 scoped 生命周期的 `Mediator` 对照宿主。 /// /// 按 scoped 形状生成 DI 注册的 `Mediator` 宿主。 private static ServiceProvider CreateScopedMediatorServiceProvider() { var services = new ServiceCollection(); services.AddMediator(static options => options.ServiceLifetime = ServiceLifetime.Scoped); return services.BuildServiceProvider(); } /// /// 构建 transient 生命周期的 `Mediator` 对照宿主。 /// /// 按 transient 形状生成 DI 注册的 `Mediator` 宿主。 private static ServiceProvider CreateTransientMediatorServiceProvider() { var services = new ServiceCollection(); services.AddMediator(static options => options.ServiceLifetime = ServiceLifetime.Transient); return services.BuildServiceProvider(); } /// /// Benchmark request。 /// /// 请求标识。 public sealed record BenchmarkRequest(Guid Id) : GFramework.Cqrs.Abstractions.Cqrs.IRequest, Mediator.IRequest, MediatR.IRequest; /// /// Benchmark response。 /// /// 响应标识。 public sealed record BenchmarkResponse(Guid Id); /// /// 同时实现 GFramework.CQRS、NuGet `Mediator` 与 MediatR 契约的最小 request handler。 /// public sealed class BenchmarkRequestHandler : GFramework.Cqrs.Abstractions.Cqrs.IRequestHandler, Mediator.IRequestHandler, MediatR.IRequestHandler { /// /// 处理 GFramework.CQRS request。 /// public ValueTask Handle(BenchmarkRequest request, CancellationToken cancellationToken) { return ValueTask.FromResult(new BenchmarkResponse(request.Id)); } /// /// 处理 NuGet `Mediator` request。 /// ValueTask Mediator.IRequestHandler.Handle( BenchmarkRequest request, CancellationToken cancellationToken) { return Handle(request, cancellationToken); } /// /// 处理 MediatR request。 /// Task MediatR.IRequestHandler.Handle( BenchmarkRequest request, CancellationToken cancellationToken) { return Task.FromResult(new BenchmarkResponse(request.Id)); } } }