許多軟體的構成是插件機制比如eclipse像這樣的軟體,動態加載插件也能夠理解,反射機制也能夠理解,只是不明白這些插件是如何能夠在運行時候得到識別反饋的,比如加載插件后如何跟原有的功能進行通信?是通過回呼機制嗎?訊息機制,有沒有代碼演示一下呢?
uj5u.com熱心網友回復:
每個支持所謂“插件”功能的程式,具體實作肯定都不會是一樣的,這個沒有統一標準。自己想怎么實作就怎么實作。比如你自己想實作一套插件機制可以這樣設計:
1、規定插件以怎樣的形式存在,dll or exe?
2、規定插件必須實作一系列事先就定義好的介面,你不實作,我就不理你
3、這一系列介面你自己可以隨意定義,這就很靈活了,你想要插件能做到什么程度,就定義到什么程度,只要最后給出檔案,讓插件開發者可以按檔案開發就行。當然你的介面設計的好不好那就另說了。
4、定義插件安裝機制,簡單點的話,就一股腦放到你主程式的某個目錄里,程式啟動的時候掃描所有,把所有符合自己標準的(實作了我規定的所有介面)插件加載進來就好。當然,你也可以讓用戶自己在界面上選擇需要加載哪些插件或者在程式運行時動態加載,如何識別還是一個道理。
關鍵的就是你如何定義介面了。以dll形式的插件為例,舉個簡單的例子:
插件初始化:
/** @fn typedef int (MODULE_API *Module_Init)()
* @brief 初始化模塊;
* @param szPath [in] 模塊目錄;
* @return 成功回傳0,否則回傳其他值;
*/
typedef int (MODULE_API *Module_Init)(const char* szPath);
插件反初始化:
/** @fn typedef int (MODULE_API *Module_Uninit)()
* @brief 反初始化模塊;
* @param void
* @return 成功回傳0,否則回傳其他值;
*/
typedef int (MODULE_API *Module_Uninit)();
其他需要實作的介面可以統一由一個Module_Proc定義.
功能介面Module_Proc的定義:
/** @brief 功能介面呼叫完成通知;
* @param error [in] 錯誤碼;
* @param data [in] 資料結果;
* @param size [in] 資料長度;
* @param usr [in] 用戶資料;
* @return 成功回傳0,失敗回傳其他值;
*/
typedef int (SRPC_API *COMPLETIONPROC)(unsigned int error,const void* data,unsigned int size,void* usr);
//************************************
// Method: Module_Proc
// Brief: 功能程序;
// Returns: int
// Parameter: void* data_in 資料(引數);
// Parameter: unsigned int size_in 資料大小;
// Parameter: COMPLETIONPROC proc 完成回呼;
// Parameter: void* usr 框架內部資料,需要用戶傳給proc;
//note:
// 注意:一般情況下,proc 和 usr 只能在該函式之內使用以同步回傳結果!;除非用戶回傳100;
// 這意味著,如果該函式回傳了100,框架內部結構usr的生存權將轉移給用戶,其不會被釋放直到用戶呼叫了proc;
//************************************
typedef int (MODULE_API *Module_Proc)( const void* data_in, unsigned int size_in, COMPLETIONPROC proc,void* usr);
然后,插件庫內部就可以定義 Module_Proc 形式的功能函式地址了。功能可以有很多個,一般來講,我們需要插件提供的功能都是接收我們主程式的通知,比如:程式啟動通知,程式退出通知,用戶干了啥啥啥通知,等等等等。我們可以只定義一個介面,讓插件實作,以便我們一次性去獲取插件提供的所有功能,那么可以這樣定義一個Module_GetAllExportProc介面:
/** @struct _PROCINFO
* @brief 程序資訊表;用key表示功能的名稱字串,pAddr為功能函式的地址
* 比如key可以是“onProgamStartEnd”表示我們的主程式啟動完畢了,如果插件在這個時候想做什么,就去實作這個介面。
* 比如key可以是“onReportStatus”表示我們的主程式想要獲取插件的運行狀態,插件如果想報告運行狀態,就去實作這個介面。
*/
typedef struct _PROCINFO
{
char szKey[MODULE_KEY_MAXLENTH];
Module_Proc pAddr;
}PROCINFO;
/** @fn typedef int (MODULE_API *Module_RegisterProc)(const PROCINFO* procedures,unsigned int count,void* usr);
* @brief 注冊程序資訊;
* @param const PROCINFO* [in] 程序資訊表;
* @param unsigned int [in] 注冊數量;
* @param void* [in] 用戶資料;
* @return 成功回傳0,否則回傳其他值;
*/
typedef int (MODULE_API *Module_RegisterProc)(const PROCINFO* procedures,unsigned int count,void* usr);
/** @fn typedef int (MODULE_API *Module_GetAllExportProc)(Module_FnInfo fnReg);
* @brief 獲取所有匯出的程序地址;
* @param Module_RegisterProc [in] 程序注冊地址;
* @param void* [in] 用戶資料;
* @return 成功回傳0,否則回傳其他值;
*/
typedef int (MODULE_API *Module_GetAllExportProc)(Module_RegisterProc regAddr,void* usr);
Module_GetAllExportProc 接收兩個引數,都是由我們的主程式在加載后,來呼叫傳入的,一個引數是Module_RegisterProc函式地址,使插件開發者可以呼叫它來匯出自己所有的功能函式,另一個引數usr是Module_RegisterProc所需要的引數。
那么以插件實作者的角度,簡單給一個實作Module_GetAllExportProc形式的例子:
假設,我們的插件有兩個功能要實作,分別是onProgamStartEnd接收程式啟動完畢通知、onReportStatus報告插件運行狀態:
int MODULE_API Plugin_OnProgamStartEnd(const void* data_in, unsigned int size_in, COMPLETIONPROC fn,void* usr)
{
//這里就可以做一些程式啟動完畢時要做的處理
//...
return 0;
}
int MODULE_API Plugin_OnReportStatus( const void* data_in, unsigned int size_in, COMPLETIONPROC fn,void* usr)
{
//使用fn向我們主程式報告運行狀態
if (fn)
{
fn(0,"這里可以是任何內容表示當前的運行狀態,比如用json", 內容長度, usr);
}
return 0;
}
匯出這兩個功能地址,以便主程式呼叫
int MODULE_API GetAllExportProcName(Module_RegisterProc regAddr,void* usr)
{
if(regAddr)
{
const PROCINFO proc_info_t[] =
{
{"onProgamStartEnd", &Plugin_OnProgamStartEnd},
{"onReportStatus", &Plugin_OnReportStatus},
{NULL,NULL}
};
unsigned int count = sizeof(proc_info_t) / sizeof(PROCINFO);
return regAddr(proc_info_t,count,usr);
}
return -1;
}
到目前為止,我們定義了1、插件的初始化介面,2、插件的反初始化介面,3、插件的所有功能獲取介面。同時給了介面3的實作例子。
插件確實可以被動接收我們主程式的通知或者呼叫了,那么插件如何主動呼叫主程式的功能呢?
那其實也可以通過類似Module_GetAllExportProc的定義方式,來獲取主程式的所有功能,只不過這一次,Module_GetAllExportProc實作在我們的主程式中,并將它的地址通過某種方式告訴插件,讓插件去獲取主程式的所有功能地址。
這個“某種方式”可以是:
a、在Module_Init中新加一個引數接收
b、新定義的一個介面要求插件實作
c、直接讓插件在上面例子的GetAllExportProcName函式中匯出一個叫onProgamAllProcs的功能來接收主程式的所有功能名及功能函式地址。
這里我們先以最簡單的a方法重新定義一下初始化函式:
/** @fn typedef int (MODULE_API *Module_Init)()
* @brief 初始化模塊;
* @param szPath [in] 模塊目錄;
* @param getAllProgamProcs [in] 主程式所有功能獲取介面;
* @return 成功回傳0,否則回傳其他值;
*/
typedef int (MODULE_API *Module_Init)(const char* szPath , Module_GetAllExportProc getAllProgamProcs);
實作之:
int MODULE_API Plugin_Init(const char* szPath, Module_GetAllExportProc getAllProgamProcs)
{
// do something Init first.....
//...
//獲取主程式的所有功能
if(getAllProgamProcs)
{
getAllProgamProcs(&RegisterProcCallback, NULL);
}
return 0;
}
int MODULE_API RegisterProcCallback(const PROCINFO* procedures,unsigned int count,void* usr)
{
for (unsigned int i = 0; i < count; i++)
{
if (procedures[i].pAddr)
{
//處理,比如將主程式的所有功能及對應地址保存起來,供后續呼叫...
//addFnInterface(procedures[i].szKey, procedures[i].pAddr);
//...
//比如主程式有個功能是打開一個檔案,那我們把這個功能名叫做 ProgamOpenFile
//這里就會有一個procedures[i].szKey 等于"ProgamOpenFile",其功能函式地址就是procedures[i].pAddr
//當插件想要使用這個功能就呼叫它就完事了: procedures[i].pAddr(...);
//當然主程式有哪些功能,叫什么名字,接受的引數格式什么樣的,那就要我們寫好的檔案供插件開發者查閱了。
}
}
return 0;
}
如果用b方法,重新定義一個介面要求插件實作,也是一樣的,就不演示了。
如果用c方法也是可以的,也是多實作一個插件功能用來接收主程式的所有功能通知。
int MODULE_API Plugin_OnProgamAllProcs(const void* data_in, unsigned int size_in, COMPLETIONPROC fn,void* usr)
{
//這里data_in內容其實可以任意定義,如果是dll插件,簡單點可以直接將內容定義成Module_GetAllExportProc函式指標,那么size_in就是指標長度
// Module_GetAllExportProc* pGetAllProgamProcs = (Module_GetAllExportProc*)data_in;
// 等同于 memcpy(pGetAllProgamProcs, data_in, sizeof(Module_GetAllExportProc));
// 之后就和上面Plugin_Init例子里一樣了:
// if(*pGetAllProgamProcs)
// {
// (*pGetAllProgamProcs)(&RegisterProcCallback, NULL);
// }
//...
//或者為了更通用,以適用于exe插件,data_in可以是json,包含所有主程式的功能名。這里就不作展開了。
return 0;
}
//修改GetAllExportProcName 增加onProgamAllProcs通知接收
int MODULE_API GetAllExportProcName(Module_RegisterProc regAddr,void* usr)
{
if(regAddr)
{
const PROCINFO proc_info_t[] =
{
{"onProgamAllProcs", &Plugin_OnProgamAllProcs},
{"onProgamStartEnd", &Plugin_OnProgamStartEnd},
{"onReportStatus", &Plugin_OnReportStatus},
{NULL,NULL}
};
unsigned int count = sizeof(proc_info_t) / sizeof(PROCINFO);
return regAddr(proc_info_t,count,usr);
}
return -1;
}
另外,我們還可以把定義的3個介面(Module_Init,Module_Uninit,Module_GetAllExportProc)合并成一個Module_GetMEAT,這樣我們加載插件后,只要檢查這一個介面有沒有實作就可以判斷它是否為合法插件了。具體方法原理還是一樣的,可以參考Module_GetAllExportProc
//----------- 模塊庫必須匯出的介面; ------------//
/*
*
* 模塊內部必須實作 _MODULE_EXPORT_ADDR_T 定義的一系列介面;
* 框架通過這些介面與模塊進行互動;
*
* 模塊庫必須匯出下面宣告的介面,框架通過該介面識別動態庫是否為合法模塊;
* MODULE_EXTERN int MODULE_API MODULE_GetMEAT(Module_ExportAddr eFunc,void* usr)
*
*
*/
/** @struct _MODULE_EXPORT_ADDR_T
* @brief 模塊與框架互動的介面地址表;
*/
typedef struct _MODULE_EXPORT_ADDR_T
{
Module_Init Init; ///< 模塊初始化介面地址;
Module_Uninit Uninit; ///< 模塊反初始化介面地址;
Module_GetAllExportProc GetAllProc; ///< 獲取所有暴露程序介面地址;
}MEAT;
/** @fn typedef int (MODULE_API *Module_ExportAddr)(MEAT* pMEAT);
* @brief 匯出介面地址表;
* @param MEAT* [in] 地址表;
* @param void* [in] 用戶資料;
* @return 成功回傳0,否則回傳其他值;
*/
typedef int (MODULE_API *Module_ExportAddr)(const MEAT* pMEAT,void* usr);
/** @fn typedef int (MODULE_API *Module_GetMEAT)();
* @brief 獲取模塊與框架互動的介面地址表;
* @param Module_ExportAddr [in] 匯出介面地址表的函式地址;
* @param void* [in] 用戶資料;
* @return 成功回傳0,否則回傳其他值;
*/
typedef int (*Module_GetMEAT)(Module_ExportAddr eFunc,void* usr);
這樣,插件只要實作這個介面,并匯出這唯一的一個介面就可以了:
MODULE_EXTERN int Plugin_GetMEAT(Module_ExportAddr eFunc,void* usr)
{
if(eFunc)
{
const MEAT export_addr_t = {
Plugin_Init,
Plugin_Uninit,
GetAllExportProcName
};
return eFunc(&export_addr_t,usr);
}
return -1;
}
相關宏:
#if (defined(_WIN32) || defined(_WIN64))
# define MODULE_EXTERN extern "C" __declspec(dllexport)
# define MODULE_API __stdcall
#elif defined(__linux__)
# define MODULE_EXTERN extern "C"
# define MODULE_API
#else
# define MODULE_EXTERN
# define MODULE_API
#endif
以上,其實就是本人以前設計的一個模塊化開發方案的一部分。不光支持dll、so形式的動態庫模塊,也可以是exe這樣的可執行模塊。不僅適用于是同行程內的通信,也適用于不同行程甚至不同主機間的通信。這也解釋了為什么我將“功能介面”形式統一成了這樣的固定形式,又將它與一個字串名字關聯起來。就是為了方便不同行程間的通信。
那么將它用在“插件開發”上其實也是綽綽有余的。
總之,插件機制的實作可以有很多種,我舉的這個例子只是其中一種,至于它怎么樣,就見仁見智了。僅供參考。
uj5u.com熱心網友回復:
對大師的膜拜,是我等凡人的榮幸。這里面體現了很多思維是我這些渣渣所學習不到的。請教一下大神,除了大量的代碼經驗積累之外,有沒有權威的代碼庫或者是書籍推薦一下,為寫這些良好架構設計的軟體提供一些思路指引?uj5u.com熱心網友回復:
還有一個疑問,如果UI也以插件的形式設計,在某個功能表單上實作新的子功能表單,這樣是不是需要提前確定了功能表單的介面規范了,如果子功能表單不知道的目標功能表單,該如何去設計這樣的規范?轉載請註明出處,本文鏈接:https://www.uj5u.com/houduan/76001.html
標籤:模式及實現
上一篇:語言中使用全域變數int**a,能否在一個void型別的函式中完成動態記憶體分配?以及,相應地在其它void型別的函式中完成賦值,釋放記憶體的操作
下一篇:求幫忙
