C# 是面向對象的程序設計語言。它提供了 interface 關鍵字來直接定義接口。同時，System.Reflection 命名空間也提供了訪問外部程序集的一系列相關對象。這就為我們在 C# 中實現插件構架打下了堅實的基礎。

C#插件構架設計過程

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

C#插件構架——接口設計

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

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

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

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

///   
/// 編輯器對象必須實現這個接口   
///   
 
public interface IDocumentObject {   
　// 這些屬性是 RichTextBox 控件的相應的屬性映射   
　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();   
}  

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

再然后，根據插件在其生命周期里的行為，設計插件的接口。

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

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

 C#插件構架——加載插件

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

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

至此，C#插件構架的設計過程就完成了，現在，你就可以撰寫測試代碼了。

【編輯推薦】

1. C#調用SQL存儲過程示例演示
2. C#與SQL連接:GridView控件操作
3. ASP調用C# DLL發送郵件方法共享
4. VC6.0和VS2005：C++和C#編寫調用COM組件
5. C#中調用dll庫（VC編寫）