結合 AOP 輕鬆處理事件釋出處理日誌
Intro
前段時間，實現了 EventBus 以及 EventQueue 基於 Event 的事件處理，但是沒有做日誌（EventLog）相關的部分，原本想增加兩個介面， 處理事件釋出日誌和事件處理日誌，最近用了 AOP 的思想處理了 EntityFramework 的資料變更自動審計，於是想著事件日誌也用 AOP 的思想來實現，而且可能用 AOP 來處理可能會更好一些，最近自己造了一個 AOP 的輪子 —— FluentAspects，下面的示例就以它來演示了，你也可以換成自己喜歡的 AOP 元件，思想是類似的
事件日誌示例
事件釋出日誌
事件釋出日誌只需要攔截事件釋出的方法呼叫即可，在釋出事件時進行攔截，在攔截器中根據需要進行日誌記錄即可
事件釋出者介面定義：
public interface IEventPublisher
{
/// <summary>
/// publish an event
/// </summary>
/// <typeparam name="TEvent">event type</typeparam>
/// <param name="event">event data</param>
/// <returns>whether the operation succeed</returns>
bool Publish<TEvent>(TEvent @event) where TEvent : class, IEventBase;
/// <summary>
/// publish an event async
/// </summary>
/// <typeparam name="TEvent">event type</typeparam>
/// <param name="event">event data</param>
/// <returns>whether the operation succeed</returns>
Task<bool> PublishAsync<TEvent>(TEvent @event) where TEvent : class, IEventBase;
}
事件釋出日誌攔截器：
public class EventPublishLogInterceptor : AbstractInterceptor
{
public override async Task Invoke(IInvocation invocation, Func<Task> next)
{
Console.WriteLine("-------------------------------");
Console.WriteLine($"Event publish begin, eventData:{invocation.Arguments.ToJson()}");
var watch = Stopwatch.StartNew();
try
{
await next();
}
catch (Exception ex)
{
Console.WriteLine($"Event publish exception({ex})");
}
finally
{
watch.Stop();
Console.WriteLine($"Event publish complete, elasped:{watch.ElapsedMilliseconds} ms");
}
Console.WriteLine("-------------------------------");
}
}
事件處理日誌
事件處理器介面定義：
public interface IEventHandler
{
Task Handle(object eventData);
}
事件處理日誌攔截器定義：
public class EventHandleLogInterceptor : IInterceptor
{
public async Task Invoke(IInvocation invocation, Func<Task> next)
{
Console.WriteLine("-------------------------------");
Console.WriteLine($"Event handle begin, eventData:{invocation.Arguments.ToJson()}");
var watch = Stopwatch.StartNew();
try
{
await next();
}
catch (Exception ex)
{
Console.WriteLine($"Event handle exception({ex})");
}
finally
{
watch.Stop();
Console.WriteLine($"Event handle complete, elasped:{watch.ElapsedMilliseconds} ms");
}
Console.WriteLine("-------------------------------");
}
}
AOP 配置
Host.CreateDefaultBuilder(args)
.ConfigureWebHostDefaults(builder =>
{
builder.UseStartup<Startup>();
})
.UseFluentAspectsServiceProviderFactory(options =>
{
// 攔截器配置
// 攔截 `IEventPublisher` 日誌，註冊事件釋出日誌攔截器
options
.InterceptType<IEventPublisher>()
.With<EventPublishLogInterceptor>();
// 攔截 `IEventHandler`，註冊事件處理日誌攔截器
options.InterceptType<IEventHandler>()
.With<EventHandleLogInterceptor>();
}, builder =>
{
// 預設使用預設實現來生成代理，現在提供了 Castle 和 AspectCore 的擴充套件，也可以自己擴充套件實現自定義代理生成方式
// 取消註釋使用 Castle 來生成代理
//builder.UseCastleProxy();
}, t => t.Namespace?.StartsWith("WeihanLi") == false // 要忽略的型別斷言
)
.Build()
.Run();
More
事件釋出示例，定義了一個釋出事件的中介軟體：
// pageView middleware
app.Use((context, next) =>
{
var eventPublisher = context.RequestServices
.GetRequiredService<IEventPublisher>();
eventPublisher.Publish(new PageViewEvent()
{
Path = context.Request.Path.Value,
});
return next();
});
事件處理示例是用一個訊息佇列的模式來處理的，示例和前面的事件的文章類似，EventConsumer 是一個後臺任務，完整程式碼示例如下：
public class EventConsumer : BackgroundService
{
private readonly IEventQueue _eventQueue;
private readonly IEventHandlerFactory _eventHandlerFactory;
public EventConsumer(IEventQueue eventQueue, IEventHandlerFactory eventHandlerFactory)
{
_eventQueue = eventQueue;
_eventHandlerFactory = eventHandlerFactory;
}
protected override async Task ExecuteAsync(CancellationToken stoppingToken)
{
while (!stoppingToken.IsCancellationRequested)
{
var queues = await _eventQueue.GetQueuesAsync();
if (queues.Count > 0)
{
await queues.Select(async q =>
{
var @event = await _eventQueue.DequeueAsync(q);
if (null != @event)
{
var handlers = _eventHandlerFactory.GetHandlers(@event.GetType());
if (handlers.Count > 0)
{
await handlers
.Select(h => h.Handle(@event))
.WhenAll()
;
}
}
})
.WhenAll()
;
}
await Task.Delay(1000, stoppingToken);
}
}
}
完整的示例程式碼可以從https://github.com/WeihanLi/WeihanLi.Common/blob/dev/samples/AspNetCoreSample 獲取
OverMore
之前在微軟的 EShopOnContainers 專案裡又看到類似下面這樣的程式碼，在釋出事件的時候包裝一層 try ... catch 來記錄事件釋出日誌，相比之下，本文示例中的這種方式更為簡潔，程式碼更清爽
