mirror of
https://github.com/GeWuYou/GFramework.git
synced 2026-05-06 16:16:44 +08:00
6d619b9a1f
- 修复 benchmark workflow 过滤器输入的 shell 注入风险 - 统一 request 与 stream invoker 基准中 MediatR handler 的生命周期基线 - 更新 request pipeline benchmark 的缓存清理与空行为类型声明 - 压缩 cqrs-rewrite active 跟踪与 trace，记录本轮 PR review 收尾结论
282 lines
11 KiB
C#
282 lines
11 KiB
C#
// 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.Collections.Generic;
|
||
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;
|
||
|
||
[assembly: GFramework.Cqrs.CqrsHandlerRegistryAttribute(
|
||
typeof(GFramework.Cqrs.Benchmarks.Messaging.GeneratedStreamInvokerBenchmarkRegistry))]
|
||
|
||
namespace GFramework.Cqrs.Benchmarks.Messaging;
|
||
|
||
/// <summary>
|
||
/// 对比 stream 完整枚举在 direct handler、GFramework 反射路径、GFramework generated invoker 路径与 MediatR 之间的开销差异。
|
||
/// </summary>
|
||
[Config(typeof(Config))]
|
||
public class StreamInvokerBenchmarks
|
||
{
|
||
private MicrosoftDiContainer _reflectionContainer = null!;
|
||
private ICqrsRuntime _reflectionRuntime = null!;
|
||
private MicrosoftDiContainer _generatedContainer = null!;
|
||
private ICqrsRuntime _generatedRuntime = null!;
|
||
private ServiceProvider _serviceProvider = null!;
|
||
private IMediator _mediatr = null!;
|
||
private ReflectionBenchmarkStreamHandler _baselineHandler = null!;
|
||
private ReflectionBenchmarkStreamRequest _reflectionRequest = null!;
|
||
private GeneratedBenchmarkStreamRequest _generatedRequest = null!;
|
||
private MediatRBenchmarkStreamRequest _mediatrRequest = null!;
|
||
|
||
/// <summary>
|
||
/// 配置 stream invoker benchmark 的公共输出格式。
|
||
/// </summary>
|
||
private sealed class Config : ManualConfig
|
||
{
|
||
public Config()
|
||
{
|
||
AddJob(Job.Default);
|
||
AddColumnProvider(DefaultColumnProviders.Instance);
|
||
AddColumn(new CustomColumn("Scenario", static (_, _) => "StreamInvoker"));
|
||
AddDiagnoser(MemoryDiagnoser.Default);
|
||
WithOrderer(new DefaultOrderer(SummaryOrderPolicy.FastestToSlowest, MethodOrderPolicy.Declared));
|
||
}
|
||
}
|
||
|
||
/// <summary>
|
||
/// 构建 reflection / generated / MediatR 三组 stream dispatch 对照宿主。
|
||
/// </summary>
|
||
[GlobalSetup]
|
||
public void Setup()
|
||
{
|
||
LoggerFactoryResolver.Provider = new ConsoleLoggerFactoryProvider
|
||
{
|
||
MinLevel = LogLevel.Fatal
|
||
};
|
||
Fixture.Setup("StreamInvoker", handlerCount: 1, pipelineCount: 0);
|
||
BenchmarkDispatcherCacheHelper.ClearDispatcherCaches();
|
||
|
||
_baselineHandler = new ReflectionBenchmarkStreamHandler();
|
||
_reflectionRequest = new ReflectionBenchmarkStreamRequest(Guid.NewGuid(), 3);
|
||
_generatedRequest = new GeneratedBenchmarkStreamRequest(Guid.NewGuid(), 3);
|
||
_mediatrRequest = new MediatRBenchmarkStreamRequest(Guid.NewGuid(), 3);
|
||
|
||
_reflectionContainer = BenchmarkHostFactory.CreateFrozenGFrameworkContainer(static container =>
|
||
{
|
||
container.RegisterTransient<GFramework.Cqrs.Abstractions.Cqrs.IStreamRequestHandler<ReflectionBenchmarkStreamRequest, ReflectionBenchmarkResponse>, ReflectionBenchmarkStreamHandler>();
|
||
});
|
||
_reflectionRuntime = GFramework.Cqrs.CqrsRuntimeFactory.CreateRuntime(
|
||
_reflectionContainer,
|
||
LoggerFactoryResolver.Provider.CreateLogger(nameof(StreamInvokerBenchmarks) + ".Reflection"));
|
||
|
||
_generatedContainer = BenchmarkHostFactory.CreateFrozenGFrameworkContainer(container =>
|
||
{
|
||
container.RegisterCqrsHandlersFromAssembly(typeof(StreamInvokerBenchmarks).Assembly);
|
||
});
|
||
_generatedRuntime = GFramework.Cqrs.CqrsRuntimeFactory.CreateRuntime(
|
||
_generatedContainer,
|
||
LoggerFactoryResolver.Provider.CreateLogger(nameof(StreamInvokerBenchmarks) + ".Generated"));
|
||
|
||
_serviceProvider = BenchmarkHostFactory.CreateMediatRServiceProvider(
|
||
configure: null,
|
||
typeof(StreamInvokerBenchmarks),
|
||
static candidateType => candidateType == typeof(MediatRBenchmarkStreamHandler),
|
||
ServiceLifetime.Transient);
|
||
_mediatr = _serviceProvider.GetRequiredService<IMediator>();
|
||
}
|
||
|
||
/// <summary>
|
||
/// 释放 MediatR 对照组使用的 DI 宿主，并清理静态 dispatcher 缓存。
|
||
/// </summary>
|
||
[GlobalCleanup]
|
||
public void Cleanup()
|
||
{
|
||
_serviceProvider.Dispose();
|
||
BenchmarkDispatcherCacheHelper.ClearDispatcherCaches();
|
||
}
|
||
|
||
/// <summary>
|
||
/// 直接调用最小 stream handler 并完整枚举，作为 dispatch 额外开销 baseline。
|
||
/// </summary>
|
||
[Benchmark(Baseline = true)]
|
||
public async ValueTask Stream_Baseline()
|
||
{
|
||
await foreach (var response in _baselineHandler.Handle(_reflectionRequest, CancellationToken.None).ConfigureAwait(false))
|
||
{
|
||
_ = response;
|
||
}
|
||
}
|
||
|
||
/// <summary>
|
||
/// 通过 GFramework.CQRS 反射 stream binding 路径创建并完整枚举 stream。
|
||
/// </summary>
|
||
[Benchmark]
|
||
public async ValueTask Stream_GFrameworkReflection()
|
||
{
|
||
await foreach (var response in _reflectionRuntime.CreateStream(BenchmarkContext.Instance, _reflectionRequest, CancellationToken.None)
|
||
.ConfigureAwait(false))
|
||
{
|
||
_ = response;
|
||
}
|
||
}
|
||
|
||
/// <summary>
|
||
/// 通过 generated stream invoker provider 预热后的 GFramework.CQRS runtime 创建并完整枚举 stream。
|
||
/// </summary>
|
||
[Benchmark]
|
||
public async ValueTask Stream_GFrameworkGenerated()
|
||
{
|
||
await foreach (var response in _generatedRuntime.CreateStream(BenchmarkContext.Instance, _generatedRequest, CancellationToken.None)
|
||
.ConfigureAwait(false))
|
||
{
|
||
_ = response;
|
||
}
|
||
}
|
||
|
||
/// <summary>
|
||
/// 通过 MediatR 创建并完整枚举 stream，作为外部对照。
|
||
/// </summary>
|
||
[Benchmark]
|
||
public async ValueTask Stream_MediatR()
|
||
{
|
||
await foreach (var response in _mediatr.CreateStream(_mediatrRequest, CancellationToken.None).ConfigureAwait(false))
|
||
{
|
||
_ = response;
|
||
}
|
||
}
|
||
|
||
/// <summary>
|
||
/// Reflection runtime stream request。
|
||
/// </summary>
|
||
/// <param name="Id">请求标识。</param>
|
||
/// <param name="ItemCount">返回元素数量。</param>
|
||
public sealed record ReflectionBenchmarkStreamRequest(Guid Id, int ItemCount) :
|
||
GFramework.Cqrs.Abstractions.Cqrs.IStreamRequest<ReflectionBenchmarkResponse>;
|
||
|
||
/// <summary>
|
||
/// Reflection runtime stream response。
|
||
/// </summary>
|
||
/// <param name="Id">响应标识。</param>
|
||
public sealed record ReflectionBenchmarkResponse(Guid Id);
|
||
|
||
/// <summary>
|
||
/// Generated runtime stream request。
|
||
/// </summary>
|
||
/// <param name="Id">请求标识。</param>
|
||
/// <param name="ItemCount">返回元素数量。</param>
|
||
public sealed record GeneratedBenchmarkStreamRequest(Guid Id, int ItemCount) :
|
||
GFramework.Cqrs.Abstractions.Cqrs.IStreamRequest<GeneratedBenchmarkResponse>;
|
||
|
||
/// <summary>
|
||
/// Generated runtime stream response。
|
||
/// </summary>
|
||
/// <param name="Id">响应标识。</param>
|
||
public sealed record GeneratedBenchmarkResponse(Guid Id);
|
||
|
||
/// <summary>
|
||
/// MediatR stream request。
|
||
/// </summary>
|
||
/// <param name="Id">请求标识。</param>
|
||
/// <param name="ItemCount">返回元素数量。</param>
|
||
public sealed record MediatRBenchmarkStreamRequest(Guid Id, int ItemCount) :
|
||
MediatR.IStreamRequest<MediatRBenchmarkResponse>;
|
||
|
||
/// <summary>
|
||
/// MediatR stream response。
|
||
/// </summary>
|
||
/// <param name="Id">响应标识。</param>
|
||
public sealed record MediatRBenchmarkResponse(Guid Id);
|
||
|
||
/// <summary>
|
||
/// Reflection runtime 的最小 stream request handler。
|
||
/// </summary>
|
||
public sealed class ReflectionBenchmarkStreamHandler :
|
||
GFramework.Cqrs.Abstractions.Cqrs.IStreamRequestHandler<ReflectionBenchmarkStreamRequest, ReflectionBenchmarkResponse>
|
||
{
|
||
/// <summary>
|
||
/// 处理 reflection benchmark stream request。
|
||
/// </summary>
|
||
public IAsyncEnumerable<ReflectionBenchmarkResponse> Handle(
|
||
ReflectionBenchmarkStreamRequest request,
|
||
CancellationToken cancellationToken)
|
||
{
|
||
return EnumerateAsync(
|
||
request.Id,
|
||
request.ItemCount,
|
||
static id => new ReflectionBenchmarkResponse(id),
|
||
cancellationToken);
|
||
}
|
||
}
|
||
|
||
/// <summary>
|
||
/// Generated runtime 的最小 stream request handler。
|
||
/// </summary>
|
||
public sealed class GeneratedBenchmarkStreamHandler :
|
||
GFramework.Cqrs.Abstractions.Cqrs.IStreamRequestHandler<GeneratedBenchmarkStreamRequest, GeneratedBenchmarkResponse>
|
||
{
|
||
/// <summary>
|
||
/// 处理 generated benchmark stream request。
|
||
/// </summary>
|
||
public IAsyncEnumerable<GeneratedBenchmarkResponse> Handle(
|
||
GeneratedBenchmarkStreamRequest request,
|
||
CancellationToken cancellationToken)
|
||
{
|
||
return EnumerateAsync(
|
||
request.Id,
|
||
request.ItemCount,
|
||
static id => new GeneratedBenchmarkResponse(id),
|
||
cancellationToken);
|
||
}
|
||
}
|
||
|
||
/// <summary>
|
||
/// MediatR 对照组的最小 stream request handler。
|
||
/// </summary>
|
||
public sealed class MediatRBenchmarkStreamHandler :
|
||
MediatR.IStreamRequestHandler<MediatRBenchmarkStreamRequest, MediatRBenchmarkResponse>
|
||
{
|
||
/// <summary>
|
||
/// 处理 MediatR benchmark stream request。
|
||
/// </summary>
|
||
public IAsyncEnumerable<MediatRBenchmarkResponse> Handle(
|
||
MediatRBenchmarkStreamRequest request,
|
||
CancellationToken cancellationToken)
|
||
{
|
||
return EnumerateAsync(
|
||
request.Id,
|
||
request.ItemCount,
|
||
static id => new MediatRBenchmarkResponse(id),
|
||
cancellationToken);
|
||
}
|
||
}
|
||
|
||
/// <summary>
|
||
/// 为三组 stream benchmark 构造相同形状的低噪声异步枚举，避免枚举体差异干扰 invoker 对照。
|
||
/// </summary>
|
||
private static async IAsyncEnumerable<TResponse> EnumerateAsync<TResponse>(
|
||
Guid id,
|
||
int itemCount,
|
||
Func<Guid, TResponse> responseFactory,
|
||
[System.Runtime.CompilerServices.EnumeratorCancellation] CancellationToken cancellationToken)
|
||
{
|
||
for (var index = 0; index < itemCount; index++)
|
||
{
|
||
cancellationToken.ThrowIfCancellationRequested();
|
||
yield return responseFactory(id);
|
||
await Task.CompletedTask.ConfigureAwait(false);
|
||
}
|
||
}
|
||
}
|