CN108920358A - 消息总线的路由表生成方法、装置、存储介质及电子设备 - Google Patents

Abstract

本公开涉及一种消息总线的路由表生成方法、装置、存储介质及电子设备，所述方法包括：获取消息总线的各预设订阅注解，所述订阅注解是订阅者在所述消息总线上注册所订阅的事件时定义的，所述订阅注解包括该订阅者所订阅的事件信息；根据各所述订阅注解建立各订阅者与所述消息总线上的各事件之间的关联关系；根据所述关联关系生成所述消息总线的路由表。通过本公开的技术方案，可以方便、快捷地查看订阅者的相关信息，便于开发人员对订阅者进行静态分析和业务逻辑跟踪以及对应用程序进行调试。

Description

消息总线的路由表生成方法、装置、存储介质及电子设备

技术领域

本公开涉及软件开发技术领域，具体地，涉及一种消息总线的路由表生成方法、装置、存储介质及电子设备。

背景技术

在进行软件开发时，往往需要应用程序的各组件、组件与后台线程间进行通信，这将导致代码量大且事件的发布者和订阅者高度耦合。消息总线EventBus提供了一种观察者模式实现消息发布和订阅，能够简化应用程序内各组件间、组件与后台线程间的通信，其具有开销小、能将事件的发布者和订阅者解耦的优点。

如图1所示，消息总线EventBus通常包括三个要素，即事件(Event)、事件的订阅者(Subscriber)和事件的发布者(Publisher)。事件的订阅者在消息总线EventBus上注册其所要订阅的事件，事件的发布者将事件发布到消息总线EventBus上，若该事件为订阅者所订阅的事件，则由订阅者触发该事件，并由消息总线EventBus调用该事件。

然而，由于订阅者分布在应用程序的各处，很难对订阅者进行静态分析和业务逻辑跟踪，且在应用程序的调试过程中，无法定位订阅者的处理逻辑位置。

发明内容

为了克服现有技术中存在的问题，本公开提供一种消息总线的路由表生成方法、装置、存储介质及电子设备。

为了实现上述目的，本公开提供一种消息总线的路由表生成方法，包括：

获取消息总线的各预设订阅注解，所述订阅注解是订阅者在所述消息总线上注册所订阅的事件时定义的，所述订阅注解包括该订阅者所订阅的事件信息；

根据各所述订阅注解建立各订阅者与所述消息总线上的各事件之间的关联关系；

根据所述关联关系生成所述消息总线的路由表。

可选地，所述订阅注解是通过预设注解标签定义的；

所述获取消息总线上的各预设订阅注解，包括：

通过Android系统的预设程序搜索所述消息总线中的各预设注解标签；

所述根据各所述订阅注解建立各订阅者与所述消息总线上的各事件之间的关联关系，包括：

针对搜索到的每一预设注解标签，获取该预设注解标签中的事件信息和该预设注解标签对应的订阅者，并将该事件信息和该订阅者关联。

可选地，所述路由表为javadoc文档或xml文档。

可选地，所述方法还包括：

将所述路由表中的每一事件以及订阅者作为目标对象，针对每一目标对象，建立用于跳转到与该目标对象相关联的所有订阅者或者所有事件的处理逻辑位置的链接。

本公开还提供一种消息总线的路由表生成装置，包括：

订阅注解获取模块，被配置为获取消息总线的各预设订阅注解，所述订阅注解是订阅者在所述消息总线上注册所订阅的事件时定义的，所述订阅注解包括该订阅者所订阅的事件信息；

关联模块，被配置为根据各所述订阅注解建立各订阅者与所述消息总线上的各事件之间的关联关系；

路由表生成模块，被配置为根据所述关联关系生成所述消息总线的路由表。

可选地，所述订阅注解是通过预设注解标签定义的；

所述订阅注解获取模块包括：

搜索子模块，被配置为通过Android系统的预设程序搜索所述消息总线中的各预设注解标签；

所述关联模块包括：

关联子模块，被配置为针对搜索到的每一预设注解标签，获取该预设注解标签中的事件信息和该预设注解标签对应的订阅者，并将该事件信息和该订阅者关联。

可选地，所述路由表为javadoc文档或xml文档。

可选地，所述装置还包括：

链接模块，被配置为将所述路由表中的每一事件以及订阅者作为目标对象，针对每一目标对象，建立用于跳转到与该目标对象相关联的所有订阅者或者所有事件的处理逻辑位置的链接。

本公开还提供一种计算机可读存储介质，其上存储有计算机程序，该程序被处理器执行时实现本发明提供的消息总线的路由表生成方法的步骤。

本公开还提供一种电子设备，包括：

存储器，其上存储有计算机程序；

处理器，用于执行所述存储器中的所述计算机程序，以实现本公开提供的消息总线的路由表生成方法的步骤。

通过上述技术方案，通过获取消息总线的各预设订阅注解，根据各预设订阅注解建立各订阅者与消息总线上的各事件之间的关联关系，并根据关联关系生成消息总线的路由表，可以方便、快捷地查看订阅者的相关信息，便于开发人员对订阅者进行静态分析和业务逻辑跟踪以及对应用程序进行调试。

本公开的其他特征和优点将在随后的具体实施方式部分予以详细说明。

附图说明

附图是用来提供对本公开的进一步理解，并且构成说明书的一部分，与下面的具体实施方式一起用于解释本公开，但并不构成对本公开的限制。在附图中：

图1是现有技术中的一种消息总线的示意图；

图2是本公开实施例提供的一种消息总线的路由表生成方法的流程图；

图3是本公开实施例提供的另一种消息总线的路由表生成方法的流程图；

图4是本公开实施例提供的一种消息总线的路由表生成装置的框图；

图5是本公开实施例提供的另一种消息总线的路由表生成装置的框图；

图6是本公开实施例提供的一种电子设备的框图。

具体实施方式

以下结合附图对本公开的具体实施方式进行详细说明。应当理解的是，此处所描述的具体实施方式仅用于说明和解释本公开，并不用于限制本公开。

为了使本领域的技术人员更容易理解本公开实施例的技术方案，对消息总线EventBus的使用过程进行简单介绍。

消息总线EventBus的使用过程主要包括如下几步：

导入组件：引入EventBus。示例地，代码如下：

compile‘org.greenrobot:eventbus:3.0.0’

定义事件类：事件类是应用程序的各组件以及组件与后台线程进行通信的过程中数据的载体，用于传递数据。示例地，可以通过如下代码定义事件类：

注册事件：对于需要订阅事件的订阅者，可通过EventBus.getDefault().register(this)在消息总线中进行注册。示例地，可通过如下代码注册事件：

订阅事件：在注册事件后，可添加函数注解@Subscribe并写上接收事件类型，以表明该订阅者会接收这类事件的消息，使得当发布者发出消息后，添加该注解的函数会被调用。示例地，订阅事件的代码如下：

发送事件：最后，消息的发布者通过post()发送事件。示例地，发送事件的代码如下：

EventBus.getDefault().post(messageEvent)；

由上述描述可知，订阅者可能遍布应用程序的各处，使得应用程序的架构混乱，且对于开发人员来说，不易查找订阅者，影响应用程序的调试。为了解决上述技术问题，本公开实施例提供一种消息总线的路由表生成方法，如图2所示，该方法包括以下步骤：

在步骤S201中，获取消息总线的各预设订阅注解，订阅注解是订阅者在消息总线上注册所订阅的事件时定义的，订阅注解包括该订阅者所订阅的事件信息。

在本公开的一种可能的实现方式中，订阅注解可以是通过预设注解标签定义的，通过Android系统的预设程序可以搜索消息总线中的各预设注解标签。

其中，预设注解标签可以是@EventRouter标签，可在其中添加订阅者所订阅的事件信息并在下方添加订阅者。示例地，预设注解标签的代码如下所示，其表示TestRouter下的onEvent函数(订阅者)订阅了事件Event1和Event2：

public class TestRouter{

@Subscribe(threadMode＝ThreadMode.MAIN)

@EventRouter(eventType＝{Event1.class,Event2.class})

public void onEvent(Event event){

if(event.getClass()＝＝Event1.class{…}

else if(event.getClass()＝＝Event2.class{…}

}

}

相应地，通过预设程序搜索@EventRouter标签来获得消息总线中的各订阅注解。

需要说明的是，在本公开的实施例中，上述预设程序可以是Android系统中的一个java面函数，其可以以脚本的方式独运行，从而不会影响应用程序的主程序，可以高效、便捷地获取消息中线中的各订阅注解。

在步骤S202中，根据各订阅注解建立各订阅者与消息总线上的各事件之间的关联关系。

在本公开的一种可能的实现方式中，针对搜索到的每一预设注解标签，可以获取该预设注解标签中的事件信息和该预设注解标签对应的订阅者，并将该事件信息和该订阅者关联，从而建立起各订阅者与消息总线上的各事件之间的关联关系。

示例地，以上述订阅注解为例，针对每一搜索到的@EventRouter标签，该@EventRouter标签所在的事件类中的onEvent函数即为该@EventRouter标签对应的订阅者且@EventRouter标签中的Event1和Event2即为该订阅者onEvent所订阅的事件，接着将订阅者onEvent和其订阅的事件Event1和Event2关联。由此，便可以建立各订阅者与消息总线中的各事件之间的关联关系。

在步骤S203中，根据关联关系生成消息总线的路由表。

其中，路由表可以为javadoc文档或xml文档，其可视化地展示了各订阅者与其订阅的事件。

在另一实施例中，如图3所示，为了方便开发人员在编码时随时查找订阅事件关系以及代码调试，上述方法还包括：

在步骤S204中，将路由表中的每一事件以及订阅者作为目标对象，针对每一目标对象，建立用于跳转到与该目标对象相关联的所有订阅者或者所有事件的处理逻辑位置的链接。

针对路由表中的每一事件，可以建立用于跳转到与该事件关联的所有订阅者的处理逻辑位置的链接；针对路由表中的每一订阅者，可以建立用于跳转到与该订阅者相关联的所有事件的处理逻辑位置的链接。这样，当开发人员点击路由表中的目标对象时，便可跳转到应用程序主程序中与该目标对象关联的位置处，进而方便开发人员对应用程序进行调试。

在本公开的一种可能的实现方式中，可以使用@see标签建立目标对象的链接(参见表1)。

表1

订阅者	订阅事件
		@see TestRouter#onEvent(Event event)	@see Event1,Event2

通过上述实施例所述的方法，可以方便、快捷地查看订阅者的相关信息，便于开发人员对订阅者进行静态分析和业务逻辑跟踪以及对应用程序进行调试。

本公开实施例还提供一种消息总线的路由表生成装置，用于实施上述方法实施例中对应的步骤，如图4所示，该装置400包括：订阅注解获取模块401、关联模块402和路由表生成模块403。

该订阅注解获取模块401被配置为获取消息总线的各预设订阅注解，所述订阅注解是订阅者在所述消息总线上注册所订阅的事件时定义的，所述订阅注解包括该订阅者所订阅的事件信息。

该关联模块402被配置为根据各所述订阅注解建立各订阅者与所述消息总线上的各事件之间的关联关系。

该路由表生成模块403被配置为根据所述关联关系生成所述消息总线的路由表。

可选地，所述订阅注解是通过预设注解标签定义的；

如图5所示，所述订阅注解获取模块401包括：

搜索子模块411，被配置为通过Android系统的预设程序搜索所述消息总线中的各预设注解标签；

所述关联模块402包括：

关联子模块421，被配置为针对搜索到的每一预设注解标签，获取该预设注解标签中的事件信息和该预设注解标签对应的订阅者，并将该事件信息和该订阅者关联。

可选地，所述路由表为javadoc文档或xml文档。

可选地，如图5所示，所述装置400还包括：

链接模块404，被配置为将所述路由表中的每一事件以及订阅者作为目标对象，针对每一目标对象，建立用于跳转到与该目标对象相关联的所有订阅者或者所有事件的处理逻辑位置的链接。

关于上述实施例所述的装置，其中各个模块执行操作的具体方式已经在有关该方法的实施例中进行了详细描述，此处将不做详细阐述说明。

通过上述实施例中的装置，可以方便、快捷地查看订阅者的相关信息，便于开发人员对订阅者进行静态分析和业务逻辑跟踪以及对应用程序进行调试。

本公开实施例还提供一种电子设备，用于实施上述方法实施例中对应的步骤。如图6所示，该电子设备600可以包括：处理器601，存储器602。该电子设备600还可以包括多媒体组件603，输入/输出(I/O)接口604，以及通信组件605中的一者或多者。

其中，处理器601用于控制该电子设备600的整体操作，以完成上述的消息总线的路由表生成方法中的全部或部分步骤。存储器602用于存储各种类型的数据以支持在该电子设备600的操作，这些数据例如可以包括用于在该电子设备600上操作的任何应用程序或方法的指令，以及应用程序相关的数据，例如联系人数据、收发的消息、图片、音频、视频等等。该存储器602可以由任何类型的易失性或非易失性存储设备或者它们的组合实现，例如静态随机存取存储器(Static Random Access Memory，简称SRAM)，电可擦除可编程只读存储器(Electrically Erasable Programmable Read-Only Memory，简称EEPROM)，可擦除可编程只读存储器(Erasable Programmable Read-Only Memory，简称EPROM)，可编程只读存储器(Programmable Read-Only Memory，简称PROM)，只读存储器(Read-Only Memory，简称ROM)，磁存储器，快闪存储器，磁盘或光盘。多媒体组件603可以包括屏幕和音频组件。其中屏幕例如可以是触摸屏，音频组件用于输出和/或输入音频信号。例如，音频组件可以包括一个麦克风，麦克风用于接收外部音频信号。所接收的音频信号可以被进一步存储在存储器602或通过通信组件605发送。音频组件还包括至少一个扬声器，用于输出音频信号。I/O接口604为处理器601和其他接口模块之间提供接口，上述其他接口模块可以是键盘，鼠标，按钮等。这些按钮可以是虚拟按钮或者实体按钮。通信组件605用于该电子设备600与其他设备之间进行有线或无线通信。无线通信，例如Wi-Fi，蓝牙，近场通信(Near FieldCommunication，简称NFC)，2G、3G或4G，或它们中的一种或几种的组合，因此相应的该通信组件605可以包括：Wi-Fi模块，蓝牙模块，NFC模块。

在一示例性实施例中，电子设备600可以被一个或多个应用专用集成电路(Application Specific Integrated Circuit，简称ASIC)、数字信号处理器(DigitalSignal Processor，简称DSP)、数字信号处理设备(Digital Signal Processing Device，简称DSPD)、可编程逻辑器件(Programmable Logic Device，简称PLD)、现场可编程门阵列(Field Programmable Gate Array，简称FPGA)、控制器、微控制器、微处理器或其他电子元件实现，用于执行上述的消息总线的路由表生成方法。

在另一示例性实施例中，还提供了一种包括程序指令的计算机可读存储介质，该程序指令被处理器执行时实现上述的消息总线的路由表生成方法的步骤。例如，该计算机可读存储介质可以为上述包括程序指令的存储器602，上述程序指令可由电子设备600的处理器601执行以完成上述的消息总线的路由表生成方法。

以上结合附图详细描述了本公开的优选实施方式，但是，本公开并不限于上述实施方式中的具体细节，在本公开的技术构思范围内，可以对本公开的技术方案进行多种简单变型，这些简单变型均属于本公开的保护范围。

另外需要说明的是，在上述具体实施方式中所描述的各个具体技术特征，在不矛盾的情况下，可以通过任何合适的方式进行组合。为了避免不必要的重复，本公开对各种可能的组合方式不再另行说明。

此外，本公开的各种不同的实施方式之间也可以进行任意组合，只要其不违背本公开的思想，其同样应当视为本公开所公开的内容。

Claims (10)

1.一种消息总线的路由表生成方法，其特征在于，包括：

获取消息总线的各预设订阅注解，所述订阅注解是订阅者在所述消息总线上注册所订阅的事件时定义的，所述订阅注解包括该订阅者所订阅的事件信息；

根据各所述订阅注解建立各订阅者与所述消息总线上的各事件之间的关联关系；

根据所述关联关系生成所述消息总线的路由表。

2.根据权利要求1所述的方法，其特征在于，所述订阅注解是通过预设注解标签定义的；

所述获取消息总线上的各预设订阅注解，包括：

通过Android系统的预设程序搜索所述消息总线中的各预设注解标签；

所述根据各所述订阅注解建立各订阅者与所述消息总线上的各事件之间的关联关系，包括：

针对搜索到的每一预设注解标签，获取该预设注解标签中的事件信息和该预设注解标签对应的订阅者，并将该事件信息和该订阅者关联。

3.根据权利要求1或2所述的方法，其特征在于，所述路由表为javadoc文档或xml文档。

4.根据权利要求1或2所述的方法，其特征在于，所述方法还包括：

将所述路由表中的每一事件以及订阅者作为目标对象，针对每一目标对象，建立用于跳转到与该目标对象相关联的所有订阅者或者所有事件的处理逻辑位置的链接。

5.一种消息总线的路由表生成装置，其特征在于，包括：

订阅注解获取模块，被配置为获取消息总线的各预设订阅注解，所述订阅注解是订阅者在所述消息总线上注册所订阅的事件时定义的，所述订阅注解包括该订阅者所订阅的事件信息；

关联模块，被配置为根据各所述订阅注解建立各订阅者与所述消息总线上的各事件之间的关联关系；

路由表生成模块，被配置为根据所述关联关系生成所述消息总线的路由表。

6.根据权利要求5所述的装置，其特征在于，所述订阅注解是通过预设注解标签定义的；

所述订阅注解获取模块包括：

搜索子模块，被配置为通过Android系统的预设程序搜索所述消息总线中的各预设注解标签；

所述关联模块包括：

关联子模块，被配置为针对搜索到的每一预设注解标签，获取该预设注解标签中的事件信息和该预设注解标签对应的订阅者，并将该事件信息和该订阅者关联。

7.根据权利要求5或6所述的装置，其特征在于，所述路由表为javadoc文档或xml文档。

8.根据权利要求5或6所述的装置，其特征在于，所述装置还包括：

链接模块，被配置为将所述路由表中的每一事件以及订阅者作为目标对象，针对每一目标对象，建立用于跳转到与该目标对象相关联的所有订阅者或者所有事件的处理逻辑位置的链接。

9.一种计算机可读存储介质，其上存储有计算机程序，其特征在于，该程序被处理器执行时实现权利要求1-4中任一项所述方法的步骤。

10.一种电子设备，其特征在于，包括：

存储器，其上存储有计算机程序；

处理器，用于执行所述存储器中的所述计算机程序，以实现权利要求1-4中任一项所述方法的步骤。