C#插件構(gòu)架實(shí)例詳解
C# 是面向?qū)ο蟮某绦蛟O(shè)計(jì)語言。它提供了 interface 關(guān)鍵字來直接定義接口。同時(shí),System.Reflection 命名空間也提供了訪問外部程序集的一系列相關(guān)對(duì)象。這就為我們?cè)?C# 中實(shí)現(xiàn)插件構(gòu)架打下了堅(jiān)實(shí)的基礎(chǔ)。
C#插件構(gòu)架設(shè)計(jì)過程
好了,現(xiàn)在我們準(zhǔn)備把所有的核心代碼都放在 CSPluginKernel 命名空間中。用VSIDE建立一個(gè)C#類庫工程。在命名空間 CSPluginKernel 中開始我們的代碼。
C#插件構(gòu)架——接口設(shè)計(jì)
我們的程序編輯器會(huì)向插件開放正在編輯的文檔對(duì)象。程序啟動(dòng)后,就枚舉每一個(gè)插件并把它連接到主程序,同時(shí)傳遞主程序?qū)ο蟮慕涌凇2寮梢酝ㄟ^這個(gè)接口來請(qǐng)求主程序?qū)ο蠡蛟L問主程序功能 。
根據(jù)上面的需求,我們首先需要一個(gè)主程序接口:
- public interface IApplicationObject {
- void Alert( string msg ); // 產(chǎn)生一條信息
- void ShowInStatusBar( string msg ); // 將指定的信息顯示在狀態(tài)欄
- IDocumentObject QueryCurrentDocument(); // 獲取當(dāng)前使用的文檔對(duì)象
- IDocumentObject[] QueryDocuments(); // 獲取所有的文檔對(duì)象
- // 設(shè)置事件處理器
- void SetDelegate( Delegates whichOne , EventHandler targer );
- }
- // 目前只需要這一個(gè)事件
- public enum Delegates {
- Delegate_ActiveDocumentChanged ,
- }
然后是 IDocumentObject 接口。插件通過這個(gè)接口訪問編輯器對(duì)象。
- ///
- /// 編輯器對(duì)象必須實(shí)現(xiàn)這個(gè)接口
- ///
- public interface IDocumentObject {
- // 這些屬性是 RichTextBox 控件的相應(yīng)的屬性映射
- string SelectionText { get ; set ; }
- Color SelectionColor { get ; set ; }
- Font SelectionFont { get ; set ; }
- int SelectionStart { get ; set ; }
- int SelectionLength { get ; set ; }
- string SelectionRTF { get ; set ; }
- bool HasChanges { get ; }
- void Select( int start , int length );
- void AppendText( string str );
- void SaveFile( string fileName );
- void SaveFile();
- void OpenFile( string fileName );
- void CloseFile();
- }
這個(gè)接口不需要過多解釋。這里我只實(shí)現(xiàn)了RichTextBox控件少數(shù)的幾個(gè)方法,其他可能用得到的,讀者自行添加即可。
再然后,根據(jù)插件在其生命周期里的行為,設(shè)計(jì)插件的接口。
- ///
- /// 本程序的插件必須實(shí)現(xiàn)這個(gè)接口
- ///
- public interface IPlugin {
- ConnectionResult Connect( IApplicationObject app );
- void OnDestory();
- void OnLoad();
- void Run();
- }
- ///
- /// 表示插件與主程序連接的結(jié)果
- ///
- public enum ConnectionResult {
- Connection_Success ,
- Connection_Failed
- }
主程序會(huì)首先調(diào)用 Connect() 方法,并傳遞 IApplicationObject 給插件。插件在這個(gè)過程中做一些初始化工作。然后,插件的 OnLoad() 方法被調(diào)用。在這之后,當(dāng)主程序接收到調(diào)用插件的信號(hào)時(shí)(鍵盤、鼠標(biāo)響應(yīng))就會(huì)調(diào)用插件的 Run() 方法來啟動(dòng)這個(gè)插件。程序結(jié)束時(shí),調(diào)用其 OnDestory() 方法。這樣,插件的生命才宣告結(jié)束。
C#插件構(gòu)架——加載插件
現(xiàn)在就得用到 System.Refelction 命名空間了。程序在啟動(dòng)時(shí)會(huì)搜索 plugins 目錄下的每一個(gè)文件。對(duì)于每一個(gè)文件,如果它是一個(gè)插件,就用 Assembly 對(duì)象加載它。然后枚舉程序集中的每一個(gè)對(duì)象。判斷一個(gè)程序集是否為我們的插件的方法是判斷它是否直接或間接實(shí)現(xiàn)自 IPlugin。用下面的函數(shù),傳遞從程序集枚舉的對(duì)象的System.Type。
- private bool IsValidPlugin( Type t ) {
- bool ret = false ;
- Type[] interfaces = t.GetInterfaces();
- foreach ( Type theInterface in interfaces ) {
- if ( theInterface.FullName == "CSPluginKernel.IPlugin" ) {
- ret = true ;
- break ;
- }
- }
- return ret;
- }
若條件都滿足,IsValidPlugin() 就會(huì)返回 true 。接著程序就會(huì)創(chuàng)建這個(gè)對(duì)象并把它存于一個(gè) ArrayList 中。
plugins.Add( pluginAssembly.CreateInstance( plugingType.FullName ) );
至此,C#插件構(gòu)架的設(shè)計(jì)過程就完成了,現(xiàn)在,你就可以撰寫測(cè)試代碼了。
【編輯推薦】