动手造轮子：实现一个简单的 EventBus

最新推荐文章于 2025-07-14 08:22:07 发布
转载 最新推荐文章于 2025-07-14 08:22:07 发布 · 280 阅读 · 1

本文介绍了一种简单的EventBus实现方案，通过该方案可以有效地实现微服务间的解耦，提高系统的可扩展性和性能。文章详细展示了EventBus的设计原理、核心组件及其实现细节，并通过一个具体的项目案例说明如何在实际应用中使用EventBus。


动手造轮子：实现一个简单的 EventBus

Intro

EventBus 是一种事件发布订阅模式，通过 EventBus 我们可以很方便的实现解耦，将事件的发起和事件的处理的很好的分隔开来，很好的实现解耦。微软官方的示例项目 EShopOnContainers 也有在使用 EventBus 。

这里的 EventBus 实现也是参考借鉴了微软 eShopOnContainers 项目。

EventBus 处理流程：

640?wx_fmt=png

微服务间使用 EventBus 实现系统间解耦：

640?wx_fmt=png

借助 EventBus 我们可以很好的实现组件之间，服务之间，系统之间的解耦以及相互通信的问题。

起初觉得 EventBus 和 MQ 其实差不多嘛，都是通过异步处理来实现解耦合，高性能。后来看到了下面这张图才算明白为什么要用 EventBus 以及 EventBus 和 MQ 之间的关系，EventBus 是抽象的，可以用 MQ 来实现 EventBus。

640?wx_fmt=png

为什么要使用 EventBus

  1. 解耦合(轻松的实现系统间解耦)

  2. 高性能可扩展（每一个事件都是简单独立且不可更改的对象，只需要保存新增的事件，不涉及其他的变更删除操作）

  3. 系统审计（每一个事件都是不可变更的，每一个事件都是可追溯的）

  4. ...

EventBus 整体架构：

  • IEventBase :所有的事件应该实现这个接口，这个接口定义了事件的唯一id EventId 和事件发生的事件 EventAt

640?wx_fmt=png

  • IEventHandler：定义了一个 Handle 方法来处理相应的事件

640?wx_fmt=png

  • IEventStore：所有的事件的处理存储，保存事件的 IEventHandler，一般不会直接操作，通过 EventBus 的订阅和取消订阅来操作 EventStore

640?wx_fmt=png

  • IEventBus：用来发布/订阅/取消订阅事件，并将事件的某一个 IEventHandler 保存到 EventStore 或从 EventStore 中移除

640?wx_fmt=png

使用示例

来看一个使用示例，完整代码示例：

internal class EventTest	
{	
    public static void MainTest()	
    {	
        var eventBus = DependencyResolver.Current.ResolveService<IEventBus>();	
        eventBus.Subscribe<CounterEvent, CounterEventHandler1>();	
        eventBus.Subscribe<CounterEvent, CounterEventHandler2>();	
        eventBus.Subscribe<CounterEvent, DelegateEventHandler<CounterEvent>>();	
        eventBus.Publish(new CounterEvent { Counter = 1 });	
        eventBus.Unsubscribe<CounterEvent, CounterEventHandler1>();	
        eventBus.Unsubscribe<CounterEvent, DelegateEventHandler<CounterEvent>>();	
        eventBus.Publish(new CounterEvent { Counter = 2 });	
    }	
}	
internal class CounterEvent : EventBase	
{	
    public int Counter { get; set; }	
}	
internal class CounterEventHandler1 : IEventHandler<CounterEvent>	
{	
    public Task Handle(CounterEvent @event)	
    {	
        LogHelper.GetLogger<CounterEventHandler1>().Info($"Event Info: {@event.ToJson()}, Handler Type:{GetType().FullName}");	
        return Task.CompletedTask;	
    }	
}	
internal class CounterEventHandler2 : IEventHandler<CounterEvent>	
{	
    public Task Handle(CounterEvent @event)	
    {	
        LogHelper.GetLogger<CounterEventHandler2>().Info($"Event Info: {@event.ToJson()}, Handler Type:{GetType().FullName}");	
        return Task.CompletedTask;	
    }	
}

具体实现

EventStoreInMemory 实现：

EventStoreInMemory 是 IEventStore 将数据放在内存中的实现，使用了 ConcurrentDictionary 以及 HashSet 来尽可能的保证高效，具体实现代码如下：

public class EventStoreInMemory : IEventStore	
{	
    private readonly ConcurrentDictionary<string, HashSet<Type>> _eventHandlers = new ConcurrentDictionary<string, HashSet<Type>>();	
    public bool AddSubscription<TEvent, TEventHandler>()	
        where TEvent : IEventBase	
        where TEventHandler : IEventHandler<TEvent>	
    {	
        var eventKey = GetEventKey<TEvent>();	
        if (_eventHandlers.ContainsKey(eventKey))	
        {	
            return _eventHandlers[eventKey].Add(typeof(TEventHandler));	
        }	
        else	
        {	
            return _eventHandlers.TryAdd(eventKey, new HashSet<Type>()	
            {	
                typeof(TEventHandler)	
            });	
        }	
    }	
    public bool Clear()	
    {	
        _eventHandlers.Clear();	
        return true;	
    }	
    public ICollection<Type> GetEventHandlerTypes<TEvent>() where TEvent : IEventBase	
    {	
        if(_eventHandlers.Count == 0)	
            return  new Type[0];	
        var eventKey = GetEventKey<TEvent>();	
        if (_eventHandlers.TryGetValue(eventKey, out var handlers))	
        {	
            return handlers;	
        }	
        return new Type[0];	
    }	
    public string GetEventKey<TEvent>()	
    {	
        return typeof(TEvent).FullName;	
    }	
    public bool HasSubscriptionsForEvent<TEvent>() where TEvent : IEventBase	
    {	
        if(_eventHandlers.Count == 0)	
            return false;	
        var eventKey = GetEventKey<TEvent>();	
        return _eventHandlers.ContainsKey(eventKey);	
    }	
    public bool RemoveSubscription<TEvent, TEventHandler>()	
        where TEvent : IEventBase	
        where TEventHandler : IEventHandler<TEvent>	
    {	
        if(_eventHandlers.Count == 0)	
            return false;	
        var eventKey = GetEventKey<TEvent>();	
        if (_eventHandlers.ContainsKey(eventKey))	
        {	
            return _eventHandlers[eventKey].Remove(typeof(TEventHandler));	
        }	
        return false;	
    }	
}

EventBusInMemory 的实现，从上面可以看到 EventStore 保存的是 IEventHandler 对应的 Type，在 Publish 的时候根据 Type 从 IoC 容器中取得相应的 Handler 即可，如果没有在 IoC 容器中找到对应的类型，则会尝试创建一个类型实例，然后调用 IEventHandler 的 Handle 方法，代码如下：

/// <summary>	
/// EventBus in memory	
/// </summary>	
public class EventBus : IEventBus	
{	
    private static readonly ILogHelperLogger Logger = Helpers.LogHelper.GetLogger<EventBus>();	
    private readonly IEventStore _eventStore;	
    private readonly IServiceProvider _serviceProvider;	
    public EventBus(IEventStore eventStore, IServiceProvider serviceProvider = null)	
    {	
        _eventStore = eventStore;	
        _serviceProvider = serviceProvider ?? DependencyResolver.Current;	
    }	
    public bool Publish<TEvent>(TEvent @event) where TEvent : IEventBase	
    {	
        if (!_eventStore.HasSubscriptionsForEvent<TEvent>())	
        {	
            return false;	
        }	
        var handlers = _eventStore.GetEventHandlerTypes<TEvent>();	
        if (handlers.Count > 0)	
        {	
            var handlerTasks = new List<Task>();	
            foreach (var handlerType in handlers)	
            {	
                try	
                {	
                    if (_serviceProvider.GetServiceOrCreateInstance(handlerType) is IEventHandler<TEvent> handler)	
                    {	
                        handlerTasks.Add(handler.Handle(@event));	
                    }	
                }	
                catch (Exception ex)	
                {	
                    Logger.Error(ex, $"handle event [{_eventStore.GetEventKey<TEvent>()}] error, eventHandlerType:{handlerType.FullName}");	
                }	
            }	
            handlerTasks.WhenAll().ConfigureAwait(false);	
            return true;	
        }	
        return false;	
    }	
    public bool Subscribe<TEvent, TEventHandler>()	
        where TEvent : IEventBase	
        where TEventHandler : IEventHandler<TEvent>	
    {	
        return _eventStore.AddSubscription<TEvent, TEventHandler>();	
    }	
    public bool Unsubscribe<TEvent, TEventHandler>()	
        where TEvent : IEventBase	
        where TEventHandler : IEventHandler<TEvent>	
    {	
        return _eventStore.RemoveSubscription<TEvent, TEventHandler>();	
    }	
}

项目实例

来看一个实际的项目中的使用，在我的活动室预约项目中有一个公告的模块，访问公告详情页面，这个公告的访问次数加1，把这个访问次数加1改成了用 EventBus 来实现，实际项目代码：https://github.com/WeihanLi/ActivityReservation/blob/67e2cb8e92876629a7af6dc051745dd8c7e9faeb/ActivityReservation/Startup.cs

0. 定义 Event 以及 EventHandler


public class NoticeViewEvent : EventBase	
{	
    public Guid NoticeId { get; set; }	
    // UserId	
    // IP	
    // ...	
}	
public class NoticeViewEventHandler : IEventHandler<NoticeViewEvent>	
{	
    public async Task Handle(NoticeViewEvent @event)	
    {	
        await DependencyResolver.Current.TryInvokeServiceAsync<ReservationDbContext>(async dbContext =>	
        {	
            var notice = await dbContext.Notices.FindAsync(@event.NoticeId);	
            notice.NoticeVisitCount += 1;	
            await dbContext.SaveChangesAsync();	
        });	
    }	
}

这里的 Event 只定义了一个 NoticeId ，其实也可以把请求信息如IP/UA等信息加进去，在 EventHandler里处理以便日后数据分析。

1. 注册 EventBus 相关服务以及 EventHandlers

services.AddSingleton<IEventBus, EventBus>();	
services.AddSingleton<IEventStore, EventStoreInMemory>();	
//register EventHandlers	
services.AddSingleton<NoticeViewEventHandler>();


2. 订阅事件


public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory, IEventBus eventBus)	
{	
    eventBus.Subscribe<NoticeViewEvent, NoticeViewEventHandler>(); 	
    // ...	
}

3. 发布事件


eventBus.Publish(new NoticeViewEvent { NoticeId = notice.NoticeId });

Reference

  • https://github.com/dotnet-architecture/eShopOnContainers

  • https://docs.microsoft.com/zh-cn/previous-versions/msp-n-p/jj591559(v=pandp.10)

  • https://docs.microsoft.com/en-us/dotnet/standard/microservices-architecture/multi-container-microservice-net-applications/integration-event-based-microservice-communications

  • https://docs.microsoft.com/en-us/dotnet/standard/microservices-architecture/multi-container-microservice-net-applications/subscribe-events

  • https://github.com/sheng-jie/EventBus

  • https://github.com/WeihanLi/ActivityReservation

动手实现一个EventBus
hefrankeleyn的博客
10-23 633
根据Google Guava中的EventBus，动手实现一个简单的EventBus，深入理解其原理。
Android | EventBus使用详解
热门推荐
cyc的专栏
12-30 5万+
EventBus是一种用于Android的发布/订阅事件总线。它有很多优点：简化应用组件间的通信；解耦事件的发送者和接收者；避免复杂和容易出错的依赖和生命周期的问题；很快，专门为高性能优化过等等。
自己实现简单的EventBus部分功能
06-06
自己实现简单的EventBus功能，包括线程间的切换
Android EventBus使用方法与底层原理详解
最新发布
JMY_2016的博客
07-14 1456
创建一个简单的 Java 类来表示你想要传递的数据或通知。
.NET版本EventBus事件总线实例源码
03-21
.NET版本EventBus事件总线实例源码
Android中EventBus原理及用法详情
移动开发Android
09-09 876
EventBus概述EventBus是一款针对Android优化的发布/订阅（publish/subscribe）事件总线。主要功能是替代Intent,Handler,BroadCast在Fragment，Activity，Service，线程之间传递消息。简化了应用程序内各组件间、组件与后台线程间的通信。优点是开销小，代码更优雅。以及将发送者和接收者解耦。比如请求网络，等网络返回时通过Handle
EventBus
weixin_30654419的博客
02-11 129
EventBus使得组件之间的发布-订阅式的通信，而无需组件与另一个（因此要注意对方的），明确登记。它的设计完全使用明确的登记，以取代传统的Java过程中的事件分发。它是不是一个通用的发布-订阅系统中，也不旨在用于进程间通信。 //类通常由注册 地方在初始化过程中 eventBus 。注册（新 EventBusChangeRecorder （））; /...
轻松掌握EventBus: 一个简单的EventBusDemo教程
- **史上最简单EventBusDemo**：此标题表明提供的代码示例是一个非常基础的EventBus使用教程。EventBus是一个发布/订阅事件总线，主要适用于Android开发中，用于解耦组件间的直接依赖关系。标题中的“史上最简单”...
深入C#：实现设计模式与EventBus事件总线
1. **C#版本EventBus事件总线实例源码__0525.rar**：这部分信息表明，在压缩包中存在一个有关EventBus事件总线的C#版本实现的实例代码。EventBus是一个在软件工程中常用的组件，用于实现应用程序内或应用程序间的...
bcly:简单的 spring、Eventbus、REST 工作示例
06-18
####Simple application with Spring boot 使用可配置的嵌入式/外部 DB 数据源和 RESTful 调用，演示如何使用 Guava Eventbus 拦截调用。 这里 对 localhost:8080/customer/ 的 POST 调用 使用 json 数据，如 {"id...
Apollo:R RxJava的Awesome EventBus
05-17
EventBus by RxJava 基于RxJava 基于编译时注解技术，编译时生成绑定代码，非反射，性能0损耗 支持进程间通信 支持@Tag注解，支持多重Tag 支持@Sticky注解 支持@Take注解,接收指定次数事件 支持@SubscribeOn注解，...
eventBus
Azadoo的博客
04-16 181
配置 在build.gradle中 implementation 'org.greenrobot:eventbus:3.2.0' 其他更多
【转】EventBus 3.0使用详解
weixin_30856965的博客
03-10 126
原文：https://www.jianshu.com/p/f9ae5691e1bb 01 前言 当我们进行项目开发的时候，往往是需要应用程序的各组件、组件与后台线程间进行通信，比如在子线程中进行请求数据，当数据请求完毕后通过Handler或者是广播通知UI，而两个Fragment之家可以通过Listener进行通信等等。当我们的项目越来越复杂，使用Intent、Handl...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值