C#插件構(gòu)架實(shí)例分析

這篇文章主要介紹“C#插件構(gòu)架實(shí)例分析”，在日常操作中，相信很多人在C#插件構(gòu)架實(shí)例分析問題上存在疑惑，小編查閱了各式資料，整理出簡單好用的操作方法，希望對大家解答”C#插件構(gòu)架實(shí)例分析”的疑惑有所幫助！接下來，請跟著小編一起來學(xué)習(xí)吧！

C# 是面向?qū)ο蟮某绦蛟O(shè)計語言。它提供了 interface 關(guān)鍵字來直接定義接口。同時，System.Reflection 命名空間也提供了訪問外部程序集的一系列相關(guān)對象。這就為我們在 C# 中實(shí)現(xiàn)插件構(gòu)架打下了堅(jiān)實(shí)的基礎(chǔ)。

C#插件構(gòu)架設(shè)計過程

好了，現(xiàn)在我們準(zhǔn)備把所有的核心代碼都放在 CSPluginKernel 命名空間中。用VSIDE建立一個C#類庫工程。在命名空間 CSPluginKernel 中開始我們的代碼。

C#插件構(gòu)架——接口設(shè)計

我們的程序編輯器會向插件開放正在編輯的文檔對象。程序啟動后，就枚舉每一個插件并把它連接到主程序，同時傳遞主程序?qū)ο蟮慕涌?。插件可以通過這個接口來請求主程序?qū)ο蠡蛟L問主程序功能 。

根據(jù)上面的需求，我們首先需要一個主程序接口：

public interface IApplicationObject {   　void Alert( string msg ); // 產(chǎn)生一條信息   　void ShowInStatusBar( string msg ); // 將指定的信息顯示在狀態(tài)欄   　IDocumentObject QueryCurrentDocument(); // 獲取當(dāng)前使用的文檔對象   　IDocumentObject[] QueryDocuments(); // 獲取所有的文檔對象   　// 設(shè)置事件處理器   　void SetDelegate( Delegates whichOne , EventHandler targer );   }    // 目前只需要這一個事件    public enum Delegates {   　Delegate_ActiveDocumentChanged ,   }

然后是 IDocumentObject 接口。插件通過這個接口訪問編輯器對象。

///   /// 編輯器對象必須實(shí)現(xiàn)這個接口   ///    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();   }

這個接口不需要過多解釋。這里我只實(shí)現(xiàn)了RichTextBox控件少數(shù)的幾個方法，其他可能用得到的，讀者自行添加即可。

再然后，根據(jù)插件在其生命周期里的行為，設(shè)計插件的接口。

///   /// 本程序的插件必須實(shí)現(xiàn)這個接口   ///    public interface IPlugin {   　ConnectionResult Connect( IApplicationObject app );   　void OnDestory();   　void OnLoad();   　void Run();   }    ///   /// 表示插件與主程序連接的結(jié)果   ///   public enum ConnectionResult {   　Connection_Success ,   　Connection_Failed   }

主程序會首先調(diào)用 Connect() 方法，并傳遞 IApplicationObject 給插件。插件在這個過程中做一些初始化工作。然后，插件的 OnLoad() 方法被調(diào)用。在這之后，當(dāng)主程序接收到調(diào)用插件的信號時（鍵盤、鼠標(biāo)響應(yīng)）就會調(diào)用插件的 Run() 方法來啟動這個插件。程序結(jié)束時，調(diào)用其 OnDestory() 方法。這樣，插件的生命才宣告結(jié)束。

C#插件構(gòu)架——加載插件

現(xiàn)在就得用到 System.Refelction 命名空間了。程序在啟動時會搜索 plugins 目錄下的每一個文件。對于每一個文件，如果它是一個插件，就用 Assembly 對象加載它。然后枚舉程序集中的每一個對象。判斷一個程序集是否為我們的插件的方法是判斷它是否直接或間接實(shí)現(xiàn)自 IPlugin。用下面的函數(shù),傳遞從程序集枚舉的對象的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() 就會返回 true 。接著程序就會創(chuàng)建這個對象并把它存于一個 ArrayList 中。

plugins.Add( pluginAssembly.CreateInstance( plugingType.FullName ) );

到此，關(guān)于“C#插件構(gòu)架實(shí)例分析”的學(xué)習(xí)就結(jié)束了，希望能夠解決大家的疑惑。理論與實(shí)踐的搭配能更好的幫助大家學(xué)習(xí)，快去試試吧！若想繼續(xù)學(xué)習(xí)更多相關(guān)知識，請繼續(xù)關(guān)注億速云網(wǎng)站，小編會繼續(xù)努力為大家?guī)砀鄬?shí)用的文章！