1.  
  2. 主页
  3.  / 
  4. Go 每日一库
  5.  / 
  6. Go 每日一库之 message-bus 使用详解

Go 每日一库之 message-bus 使用详解

简介

在一个涉及多模块交互的系统中,如果模块的交互需要手动去调用对方的方法,那么代码的耦合度就太高了。所以产生了异步消息通信。

实际上,各种各样的消息队列都是基于异步消息的。不过它们大部分都有着非常复杂的设计,很多被设计成一个独立的软件来使用。

今天我们介绍一个非常小巧的异步消息通信库[message-bus](https://github.com/vardius/me…,它只能在一个进程中使用。

源代码只有一个文件,我们也简单看一下实现。

快速使用

安装:

使用:

这是官网提供的例子,message-bus承担了模块间消息分发的角色。模块 A 和 模块 B 先向message-bus订阅主题(topic),即告诉message-bus对什么样的消息感兴趣。其他模块 C 产生某个主题的消息,通知message-bus,由message-bus分发到对此感兴趣的模块。这样就实现了模块之间的解耦,模块 A、B 和 C 之间不需要知道彼此。

上面的例子中:

  • 首先,调用messagebuss.New()创建一个消息管理器;
  • 其次调用Subscribe()方法向管理器订阅主题;
  • 调用Publish()向管理器发布主题消息,这样订阅该主题的模块就会收到通知。

更复杂的例子

其实很多人会对何时使用这个库产生疑问,message-bus GitHub 仓库中 issue 中至今还躺着这个问题,https://github.com/vardius/message-bus/issues/4。我是做游戏后端开发的,在一个游戏中会涉及各种各样的功能模块,它们需要了解其他模块产生的事件。例如每日任务有玩家升多少级的任务、成就系统有等级的成就、其他系统还可能根据玩家等级执行其他操作…如果硬写的话,最后可能是这样:

需求一直在新增和迭代,如果新增一个模块,也需要在玩家升级时进行一些处理,除了实现模块自身的OnPlayerLevelUp方法,还必须在玩家的LevelUp()方法调用。这样玩家模块必须清楚地知道其他模块的情况。如果功能模块再多一点,而且由不同的人开发的,那么情况会更复杂。使用异步消息可有效解决这个问题:在升级时我们只需要向消息管理器发布这个升级“消息”,由消息管理器通知订阅该消息的模块。

我们设计的目录结构如下:

其中manager.go负责message-bus的创建:

player.go对应玩家结构(为了简便起见,很多字段省略了):

achievement.godaily_mission.go分别是成就和每日任务(也是省略了很多无关细节):

在创建这两个功能的对象时,我们订阅了UserLevelUp主题。玩家在升级时会发布这个主题。

最后main.go驱动整个程序:

注意,由于message-bus是异步通信,为了能看到结果我特意加了time.Sleep,实际开发中不太可能使用Sleep

最后我们运行整个程序:

因为要运行的是一个多文件程序,不能使用go run main.go

实际上,当年我因为苦于模块之间调来调去太麻烦了,自己用 C++ 撸了一个event-managerhttps://github.com/darjun/event-manager。思路是一样的。

缺点

message-bus订阅主题时传入一个函数,函数的参数可任意设置,发布时必须使用相同数量的参数,这个限制感觉有点勉强。如果我们传入的参数个数不一致,程序就panic了。我认为可以只用一个参数interface{},传入对象即可。例如,上面的升级事件可以使用EventUserLevelUp的对象:

对应地修改一下PlayerLevelUp方法:

和处理方法:

这样一来,我们似乎用不上反射了,订阅者都是func (interface{})类型的函数或方法。感兴趣的可自己实现一下,我 fork 了message-bus,做了这个修改。改动在这里:https://github.com/darjun/message-busmessage-bus有测试和性能用例,改完跑一下????。

源码分析

message-bus的源码只有一个文件,加上注释还不到 130 行,我们简单来看一下。

MessageBus就是一个简单的接口:

PublishSubscribe都讲过了,Unsubscribe表示对某个主题不感兴趣了,取消订阅,Close直接关闭某个主题的队列,删除所有订阅者。

message-bus内部,每个主题对应一组订阅者。每个订阅者使用handler结构存储回调和参数通道:

所有订阅者都存储在一个 map 中:

messageBusMessageBus接口的实现。我们来看看各个方法是如何实现的。

调用Subscribe时传入一个函数,message-bus为每个订阅者创建一个handler对象,在该对象中创建一个带缓冲的参数通道,缓冲大小由message-bus创建时的参数指定。
同时启动一个goroutine,监听通道,每当有参数到来时就执行注册的回调。

Publish发布主题,buildHandlerArgs将传入的参数转为[]reflect.Value,以便反射调用回调时传入。发送参数到该主题下所有handler的通道中。由Subscribe时创建的goroutine读取并触发回调。

Unsubscribe将某个订阅者从message-bus中移除,移除时需要关闭通道,否则会造成订阅者的 goroutine 泄露。

Close关闭某主题下所有的订阅者参数通道,并删除该主题。

注意,为了保证并发安全,每个方法都加了锁,分析实现时先忽略锁和错误处理。

为了更直观的理解,我画了一个message-bus内部结构图:

Go 每日一库之 message-bus 使用详解

总结

message-bus是一个小巧的异步通信库,实际使用可能不多,但却是学习源码的好资源。

大家如果发现好玩、好用的 Go 语言库,欢迎到 Go 每日一库 GitHub 上提交 issue。

参考

  1. message-bus GitHub:https://github.com/vardius/message-bus
  2. Go 每日一库 GitHub:https://github.com/darjun/go-daily-lib
这篇文章对您有用吗?

我们要如何帮助您?

发表评论

您的电子邮箱地址不会被公开。 必填项已用*标注