超精簡(jiǎn)的訂閱發(fā)布事件組件--SPEvent

概述

• 本文主要描述一個(gè)超精簡(jiǎn)的訂閱發(fā)布事件組件--SPEvent。
• 在實(shí)際開(kāi)發(fā)過(guò)程中，一個(gè)事件的產(chǎn)生會(huì)產(chǎn)生很多業(yè)務(wù)的執(zhí)行，或者多個(gè)事件都要執(zhí)行同一個(gè)業(yè)務(wù)的執(zhí)行。在這種場(chǎng)景下有兩種做法：

1. 將同一個(gè)事件的業(yè)務(wù)放在一個(gè)函數(shù)中，然后事件產(chǎn)生的時(shí)候執(zhí)行對(duì)應(yīng)的函數(shù)。
2. 某個(gè)業(yè)務(wù)需要哪個(gè)事件，它自己監(jiān)聽(tīng)對(duì)應(yīng)事件并執(zhí)行。

• 顯然，第一種策略會(huì)將業(yè)務(wù)與業(yè)務(wù)之間耦合在一起，對(duì)后期維護(hù)是非常痛苦的；第二種顯然會(huì)更加有優(yōu)勢(shì)，不同業(yè)務(wù)完全解耦，獨(dú)立完成事件的業(yè)務(wù)。
• 第二種策略的方式，實(shí)際在軟件架構(gòu)中經(jīng)?？吹?，比如MQTT的通信(通過(guò)訂閱對(duì)應(yīng)的topic去監(jiān)聽(tīng)對(duì)應(yīng)內(nèi)容)。
• 有了上述的需求，作者做了一個(gè)超精簡(jiǎn)的訂閱發(fā)布事件組件。整個(gè)邏輯很簡(jiǎn)單。

超精簡(jiǎn)的SPEvent組件，實(shí)現(xiàn)方法

1. 整個(gè)訂閱發(fā)布事件機(jī)制，引入兩個(gè)東西：EventHub和EventNode。

• EventHub：每一個(gè)事件類(lèi)型都為一個(gè)EventHub，然后掛在HubList中。
• EventNode：每一個(gè)訂閱事件的業(yè)務(wù)為一個(gè)EventNode，然后掛在對(duì)應(yīng)的EventHub中。

• 整個(gè)訂閱發(fā)布事件機(jī)制圍繞著EventHub和EventNode，特點(diǎn)：

• 資源占用極小，接口操作簡(jiǎn)單
• 事件支持動(dòng)態(tài)訂閱，動(dòng)態(tài)注銷(xiāo)。

• SPEvent采用雙向鏈表進(jìn)行維護(hù)整個(gè)訂閱-發(fā)布邏輯

• SPEvent一定存在一個(gè)EventHubList鏈表來(lái)維護(hù)事件類(lèi)型，它默認(rèn)是沒(méi)有任何EventHub節(jié)點(diǎn)，
• 訂閱事件流程：當(dāng)訂閱者訂閱事件之后，如果事件不存在，則申請(qǐng)一個(gè)EventHub，并將EventHub掛在到EventHubList鏈表中；然后申請(qǐng)一個(gè)EventNode，及將對(duì)應(yīng)EventNode掛在EventNodeList鏈表。
• 發(fā)布事件流程：當(dāng)發(fā)布者發(fā)布事件時(shí)，會(huì)從EventHubList中查詢(xún)有沒(méi)有對(duì)應(yīng)的EventHub，如果EventHub存在，則將事件消息發(fā)布給對(duì)應(yīng)EventHub下所有EventNode。
• 注銷(xiāo)事件訂閱流程：當(dāng)訂閱者注銷(xiāo)已經(jīng)訂閱的事件，會(huì)從EventHubList中查詢(xún)有沒(méi)有對(duì)應(yīng)的EventHub，如果EventHub存在，則將對(duì)應(yīng)EventNode從EventHub中刪除。

超精簡(jiǎn)的SPEvent組件，接口說(shuō)明：

超精簡(jiǎn)的SPEvent組件，代碼實(shí)現(xiàn)

1. 整個(gè)代碼接口存在3個(gè)文件：spevent.c、spevent.h、spevent_def.h。其中：
2. spevent_def.h文件說(shuō)明：定義了屏蔽平臺(tái)相關(guān)接口的宏和定義了雙向量表操作的宏定義。雙向量表在SPEvent中式至關(guān)重要數(shù)據(jù)結(jié)構(gòu)：

#ifndef__SPEVENT_DEF_H__
#define__SPEVENT_DEF_H__



#include
#include
#include
#include
#include
#include
#include

#defineSPEVENT_INLINEstatic__inline
#defineSPEVENT_EVENT_NAME_LEN16

#ifndefSPEVENT_MALLOC
#defineSPEVENT_MALLOCmalloc
#endif

#ifndefSPEVENT_FREE
#defineSPEVENT_FREEfree
#endif

#ifndefSPEVENT_PRINT
#defineSPEVENT_PRINTprintf
#endif

structSPEventListNode
{
structSPEventListNode*next;
structSPEventListNode*prev;
};
typedefstructSPEventListNodeSPEventList;

SPEVENT_INLINEvoidSPEVENT_LIST_INIT(SPEventList*l)
{
l->next=l->prev=l;
}

SPEVENT_INLINEvoidSPEVENT_LIST_INSERT_AFTER(SPEventList*l,SPEventList*n)
{
l->next->prev=n;
n->next=l->next;
l->next=n;
n->prev=l;
}

SPEVENT_INLINEvoidSPEVENT_LIST_INSERT_BEFORE(SPEventList*l,SPEventList*n)
{
l->prev->next=n;
n->prev=l->prev;
l->prev=n;
n->next=l;
}

SPEVENT_INLINEvoidSPEVENT_LIST_REMOVE(SPEventList*n)
{
n->next->prev=n->prev;
n->prev->next=n->next;
n->next=n->prev=n;
}

SPEVENT_INLINEintSPEVENT_LIST_LEN(constSPEventList*l)
{
intlen=0;
constSPEventList*p=l;
while(p->next!=l){
p=p->next;
len++;
}
returnlen;
}

#defineSPEVENT_CONTAINER_OF(ptr,type,member)
((type*)((char*)(ptr)-(unsignedlong)(&((type*)0)->member)))

#defineSPEVENT_LIST_OBJ_INIT(obj){&(obj),&(obj)}

#defineSPEVENT_LIST_ENTRY(node,type,member)
SPEVENT_CONTAINER_OF(node,type,member)

#defineSPEVENT_LIST_FOR_EACH(pos,head)
for(pos=(head)->next;pos!=(head);pos=pos->next)

#defineSPEVENT_LIST_FOR_EACH_SAFE(pos,n,head)
for(pos=(head)->next,n=pos->next;pos!=(head);
pos=n,n=pos->next)

#defineSPEVENT_LIST_FOR_EACH_ENTRY(pos,head,member)
for(pos=SPEVENT_LIST_ENTRY((head)->next,typeof(*pos),member);
&pos->member!=(head);
pos=SPEVENT_LIST_ENTRY(pos->member.next,typeof(*pos),member))

#defineSPEVENT_LIST_FOR_EACH_ENTRY_SAFE(pos,n,head,member)
for(pos=SPEVENT_LIST_ENTRY((head)->next,typeof(*pos),member),
n=SPEVENT_LIST_ENTRY(pos->member.next,typeof(*pos),member);
&pos->member!=(head);
pos=n,n=SPEVENT_LIST_ENTRY(n->member.next,typeof(*n),member))

#defineSPEVENT_LIST_FIRST_ENTRY(ptr,type,member)
SPEVENT_LIST_ENTRY((ptr)->next,type,member)

#endif

3. spevent.c文件說(shuō)明：SPEvent的接口實(shí)現(xiàn)；整個(gè)邏輯通過(guò)鏈表的嵌套，實(shí)現(xiàn)了事件的管理，事件的訂閱，事件的發(fā)布。

#include"spevent.h"

staticSPEventListg_hublist={0};

staticSPEventHubNode*SPEventFindHubNode(SPEventList*list,constchar*event)
{
SPEventHubNode*hubNode=NULL;
SPEventList*node=NULL;

SPEVENT_LIST_FOR_EACH(node,list){
hubNode=SPEVENT_LIST_ENTRY(node,SPEventHubNode,hubList);
if(hubNode!=NULL&&strcmp(hubNode->event,event)==0){
returnhubNode;
}
}
returnNULL;
}

staticSPEventEventNode*SPEventFindEventNode(SPEventList*eventList,SPEventHandlehandle)
{
SPEventEventNode*eventNode=NULL;
SPEventList*node=NULL;

SPEVENT_LIST_FOR_EACH(node,eventList){
eventNode=SPEVENT_LIST_ENTRY(node,SPEventEventNode,list);
if(eventNode!=NULL&&handle==eventNode->handle){
returneventNode;
}
}
returnNULL;
}

SPEventEventNode*SPEventSubscribe(constchar*event,SPEventHandlehandle)
{
SPEventHubNode*hubNode=NULL;
SPEventEventNode*eventNode=NULL;

hubNode=SPEventFindHubNode(&g_hublist,event);
if(hubNode==NULL){
hubNode=(SPEventHubNode*)SPEVENT_MALLOC(sizeof(SPEventHubNode));
if(hubNode==NULL){
SPEVENT_PRINT("SPEVENThub(%s)mallocfailedrn",event);
returnNULL;
}
memset(hubNode->event,0,SPEVENT_EVENT_NAME_LEN);
memcpy(hubNode->event,event,strlen(event));
SPEVENT_LIST_INSERT_AFTER(&g_hublist,&(hubNode->hubList));
SPEVENT_LIST_INIT(&(hubNode->eventList));
}

eventNode=(SPEventEventNode*)SPEVENT_MALLOC(sizeof(SPEventEventNode));
if(eventNode==NULL){
SPEVENT_PRINT("SPEVENTevent(%s)mallocfailedrn",event);
returnNULL;
}
eventNode->handle=handle;
SPEVENT_LIST_INSERT_AFTER(&hubNode->eventList,&(eventNode->list));

SPEVENT_PRINT("SPEVENTevent(%s)Subscribesuccessrn",event);
returneventNode;
}

boolSPEventUnsubscribe(constchar*event,SPEventEventNode*node)
{
SPEventHubNode*hubNode=NULL;
SPEventEventNode*eventNode=NULL;

hubNode=SPEventFindHubNode(&g_hublist,event);
if(hubNode==NULL){
SPEVENT_PRINT("SPEVENThub(%s)findfailedrn",event);
returnfalse;
}
eventNode=SPEventFindEventNode(&(hubNode->eventList),node->handle);
if(eventNode==NULL){
SPEVENT_PRINT("SPEVENTevent(%s)findfailedrn",event);
returnfalse;
}
SPEVENT_LIST_REMOVE(&(eventNode->list));
SPEVENT_FREE(eventNode);
eventNode=NULL;

SPEVENT_PRINT("SPEVENTevent(%s)Unsubscribesuccessrn",event);
returntrue;
}

boolSPEventPublish(constchar*event,void*payload)
{
SPEventHubNode*hubNode=NULL;
SPEventEventNode*eventNode=NULL;
SPEventList*node=NULL;

hubNode=SPEventFindHubNode(&g_hublist,event);
if(hubNode==NULL){
SPEVENT_PRINT("SPEVENThub(%s)findfailedrn");
returnfalse;
}
SPEVENT_LIST_FOR_EACH(node,&(hubNode->eventList)){
eventNode=SPEVENT_LIST_ENTRY(node,SPEventEventNode,list);
if(eventNode->handle){
eventNode->handle(event,payload);
}
}

SPEVENT_PRINT("SPEVENTevent(%s)Publishsuccessrn",event);
returntrue;
}

voidSPEventClear(void)
{
SPEventHubNode*hubNode=NULL;
SPEventEventNode*eventNode=NULL;
SPEventList*hubList=NULL;
SPEventList*eventList=NULL;

SPEVENT_LIST_FOR_EACH(hubList,&g_hublist){
hubNode=SPEVENT_LIST_ENTRY(hubList,SPEventHubNode,hubList);
if(hubNode==NULL){
continue;
}
SPEVENT_LIST_FOR_EACH(eventList,&(hubNode->eventList)){
eventNode=SPEVENT_LIST_ENTRY(eventList,SPEventEventNode,list);
if(eventNode==NULL){
continue;
}
SPEVENT_LIST_REMOVE(&(eventNode->list));
SPEVENT_FREE(eventNode);
eventNode=NULL;
}

SPEVENT_LIST_REMOVE(&(hubNode->hubList));
SPEVENT_FREE(hubNode);
hubNode=NULL;
}
}

voidRecvtInfoDump(void)
{
SPEventHubNode*hubNode=NULL;
SPEventEventNode*eventNode=NULL;
SPEventList*hubList=NULL;
SPEventList*eventList=NULL;
inteventNodeCount=0;

SPEVENT_PRINT("SPEVENTlist:rn");

SPEVENT_LIST_FOR_EACH(hubList,&g_hublist){
hubNode=SPEVENT_LIST_ENTRY(hubList,SPEventHubNode,hubList);
if(hubNode==NULL){
continue;
}
SPEVENT_PRINT("SPEVENTevent(%s):",hubNode->event);
eventNodeCount=0;
SPEVENT_LIST_FOR_EACH(eventList,&(hubNode->eventList)){
eventNode=SPEVENT_LIST_ENTRY(eventList,SPEventEventNode,list);
if(eventNode==NULL){
continue;
}
eventNodeCount++;
}
SPEVENT_PRINT("%drn",eventNodeCount);
}
}

voidSPEventInit(void)
{
SPEVENT_LIST_INIT(&g_hublist);
}

voidSPEventDeinit(void)
{
SPEventClear();
}

3. spevent.h文件說(shuō)明：SPEvent的接口申明及SPEvent相關(guān)接口體的定義。

#ifndef__SPEVENT_H__
#define__SPEVENT_H__

#include"spevent_def.h"
typedefvoid(*SPEventHandle)(constchar*event,void*payload);

typedefstruct
{
SPEventHandlehandle;
SPEventListlist;
}SPEventEventNode;

typedefstruct
{
charevent[SPEVENT_EVENT_NAME_LEN];
SPEventListeventList;
SPEventListhubList;
}SPEventHubNode;

voidSPEventInit(void);

voidSPEventDeinit(void);

SPEventEventNode*SPEventSubscribe(constchar*event,SPEventHandlehandle);

boolSPEventUnsubscribe(constchar*event,SPEventEventNode*node);

boolSPEventPublish(constchar*event,void*payload);

voidSPEventClear(void);

voidRecvtInfoDump(void);

#endif

超精簡(jiǎn)的SPEvent組件，實(shí)例：

#include
voidSPEventHandle1(constchar*event,void*payload)
{
SPEVENT_PRINT("Event1:%s,payload:%s",event,payload);
}

voidSPEventHandle2(constchar*event,void*payload)
{
SPEVENT_PRINT(ent2:%s,payload:%s",event,payload);
}

intmain()
{
SPEventInit();

SPEventEventNode*eventNode1=SPEventSubscribe("Rice",SPEventHandle1);
if(eventNode1!=NULL)
{
SPEventPublish("Rice","hello");
}else{
rlog_e("SPEVENTsubscribeeventfailed");
}

SPEventEventNode*eventNode2=SPEventSubscribe("Rice",SPEventHandle2);
if(eventNode2!=NULL)
{
SPEventPublish("Rice","world");
}else{
rlog_e("SPEVENTsubscribeeventfailed");
}

RecvtInfoDump();

SPEventUnsubscribe("Rice",eventNode1);

SPEventPublish("Rice","Hello world");

RecvtInfoDump();
return0;
}

• 結(jié)果：

SPEVENTevent(Rice)Subscribesuccess
Event1:Rice,payload:hello
SPEVENTevent(Rice)Publishsuccess
SPEVENTevent(Rice)Subscribesuccess
Event2:Rice,payload:world
Event1:Rice,payload:world
SPEVENTevent(Rice)Publishsuccess
SPEVENTlist:
SPEVENTevent(Rice):2
SPEVENTevent(Rice)Unsubscribesuccess
Event2:Rice,payload:Hello world
SPEVENTevent(Rice)Publishsuccess
SPEVENTlist:
SPEVENTevent(Rice):1