Golang事件系统Event Bus

本文介绍了事件总线实现。

最近在学习开源项目Grafana的代码，发现作者实现了一个事件总线的机制，在项目里面大量应用，效果也非常好，代码也比较简单，介绍给大家看看。

源码文件地址：grafana/bus.go at main · grafana/grafana · GitHub

1.注册和调用

在这个项目里面随处可见这种写法：

关键是bus.Dispatch(&query)这段代码，它的参数是一个结构体GetAlertByIdQuery，内容如下：

根据名字可以看出这个方法就是通过Id去查询Alert，其中Alert结构体就是结果对象，这里就不贴出来了。

通过查看源码可以得知，Dispatch背后是调用了GetAlertById这个方法，然后把结果赋值到query参数的Result中返回。

问题来了，这是怎么实现的呢？Dispatch到底做了哪些操作？这样做有什么好处？

下面我来一一解答：

首先，在Dispatch之前，你需要先注册这个方法，也就是调用AddHandler，在这个项目里面可以看到init函数里面有大量这样的代码：

其实这个方法的逻辑也很简单，所谓注册也就是把通过一个map把函数名和对应的函数做一个映射关系保存起来，当我们Dispatch的时候其实就是通过参数名查找之前注册过的函数，然后通过反射调用该函数。

Bus结构体里面有几个map成员，在这个项目里面作者定义了3种不同类型的handler，一种是普通的handler，也就是刚才展示的那种，第二种是带上下文的handler，还有一种则是事件订阅用到的handler，我们给一个事件注册多个监听者，当事件触发的时候会依次调用多个监听函数，其实就是一个观察者模式。

下面就看看具体的源码，AddHandler方法内容如下：

Dispatch方法的源码如下：

对于AddHandlerCtx和DispatchCtx这个2个方法基本上是一样的，只不过多了一个上下文参数，可以拿来做超时控制或者其它用途。

2.订阅和发布

除此之外，还有2个方法AddEventListener和Publish，即事件的订阅和发布。

查看源码可以得知，可以给一个事件注册多个handler函数，而Publish的时候则是依次调用注册的函数，逻辑也不复杂。

这里面有一点不好，所有订阅函数的调用是顺序的，并没有使用协程，所以如果注册了很多个函数，这样效率也不高啊。

3.好处

可能有人会好奇，为什么明明可以直接调用函数就行，为啥非得绕个弯子，整这么复杂？

况且，每次调用都得使用反射机制，性能也不行。

我觉得主要有以下几点：

1.这种写法逻辑清晰，解耦

2.方便单元测试

3.性能不是最大考量，虽然说反射会降低性能

转自：wangbjun.site/2021/coding/golang/event-bus.html