前言
在上篇Add-In運行機制解析（上）中，我分析了Add-In向導生成的代碼，從中我們知 道只要創建一個類庫，它包含實現了IDTExtensibility2接口的類，然後為其建立.addin 配置文件，就可以實現一個Add-In了。本文將更進一步，介紹Add-In的事件和生命周期， 為今後的開發打下基礎。
Add-In的事件
Add-In是事件驅動的，可以猜到的事件有加載、卸載、狀態改變等等。事實上，這些 事件都與IDTExtensibility2接口有關，也就是該接口的5個方法：
如果要了解這些方法如何執行，一個辦法是在這些方法中加一個MessageBox，然後通 過Add-In Manager進行一些操作，來觀察事件的執行。現在使用Add-In向導建立一個簡單 的Add-In，名字為LifeCycleAddin，不要選擇在Tools菜單顯示命令，也不要選擇在VS啟 動時加載。然後把Connect類的代碼簡化一下：
C# Code - Add-In事件演示
/// <summary>The object for implementing an Add- in.</summary>
public class Connect : IDTExtensibility2
{
public Connect()
{
}
/// <summary>
/// Receives notification that the Add-in is being loaded.
/// </summary>
public void OnConnection(object application,ext_ConnectMode connectMode,
object addInInst,ref Array custom)
{
_applicationObject = (DTE2)application;
_addInInstance = (AddIn)addInInst;
MessageBox.Show(string.Format("Event: OnConnection,connectMode: {0}",connectMode));
}
/// <summary>
/// Receives notification that the Add-in is being unloaded.
/// </summary>
public void OnDisconnection(ext_DisconnectMode disconnectMode,ref Array custom)
{
MessageBox.Show(string.Format("Event: OnDisconnection,connectMode: {0}",disconnectMode));
}
/// <summary>
/// Receives notification when the collection of Add-ins has changed.
/// </summary>
public void OnAddInsUpdate(ref Array custom)
{
MessageBox.Show("OnAddInsUpdate");
}
/// <summary>
/// Receives notification that the host application has completed loading.
/// </summary>
public void OnStartupComplete(ref Array custom)
{
MessageBox.Show("OnStartupComplete");
}
/// <summary>
/// Receives notification that the host application is being unloaded.
/// </summary>
public void OnBeginShutdown(ref Array custom)
{
MessageBox.Show("OnBeginShutdown");
}
private DTE2 _applicationObject;
private AddIn _addInInstance;
}
每個方法的注釋說明了相應的事件何時觸發。OnConnection是在Add-In加載的時候； OnDisconnection是在Add-In卸載的時候；OnAddInsUpdate是在所有Add-In的集合狀態發 生改變的時候；OnStartupComplete是在宿主環境加載完成的時候；OnBeginShutdown則是 在宿主環境將被關閉的時候。現在編譯項目，然後關閉VS。
打開VS，開始第一回合的觀察。由於沒有選擇在VS啟動時加載，所以現在什麼也不會 發生。打開Add-In Manager，對於LifeCycleAddin，將其設置為可用，確定。這時觸發了 OnConnection，connectMode為ext_cm_AfterStartup，也就是說在VS啟動之後才加載的； 然後還觸發了OnAddinsUpdate，因為LifeCycleAddin的狀態改變了。再次打開Add-In Manager，對於LifeCycleAddin，將其設置為啟動時加載，確定，再次觸發 OnAddinsUpdate。現在關閉VS，由於Add-In已經加載，所以會觸發OnBeginShutdown，然 後是OnDisconnection，說明Add-In已經被卸載。
打開VS，開始第二回合的觀察。由於選擇了在VS啟動時加載，所以此時觸發了 OnConnection，connectMode為ext_cm_Startup，也就是說是在VS啟動時加載的；之後連 續觸發了OnAddinsUpdate和OnStartupComplete，只有設置為在VS啟動時加載才可能觸發 該事件。至此，5個事件都已經觸發過了。
比較有意思的是OnAddinsUpdate。現在打開Add-In Manager，改變另一個Add-In的設 置，點擊確定，該事件也會觸發，這就是前面所說的“所有Add-In的集合狀態發生改變的 時候”。
由前面的介紹可以了解到，實現IDTExtensibility2接口是每個Add-In的核心所在。但 是僅僅這些顯然還不夠。我們不僅需要知道VS合適啟動、卸載或改變了Add-In，我們還要 能夠在這些時候訪問VS，否則開發VS的Add-In也就沒意義了。這就用到了VS的自動化對象 模型（Automation Object Model）。
VS自動化對象模型簡介
在Connect.cs文件的頂部using部分，可以看到兩個命名空間：EnvDTE和EnvDTE80。 EnvDTE表示開發環境工具擴展（Environment Development Tools Extensibility，常簡 稱為DTE），就是在這裡定義了VS的自動化對象模型（以下簡稱AOM）。而EnvDTE80的80表 示8.0版本的AOM，其實還有一個表示9.0版本的EnvDTE90，但沒有引用進來。
簡單說一下它們的關系。EnvDTE表示VS2005之前的DTE版本，在每個版本中微軟都會修 復一些bug或添加新的功能，到了VS2005，微軟使用了EnvDTE80表示新版本的變化（包括 修復和增強），同時對於那些舊版本中已經存在的類，在後面加了一個數字2表示該類的 新版本，如CodeFunction2表示是EnvDTE80中的新類型，而CodeFunction則表示EnvDTE中 對應的那個類。EnvDTE90與此類似，比如Solution3、Solution2和Solution分別表示三個 版本中表示解決方案的類。對於這些不同版本的類，微軟的做法是用新版本的類繼承舊的 版本，然後進行擴展。
但是相對於EnvDTE80與EnvDTE之間的變化，EnvDTE90的變化要小很多。大部分時候 EnvDTE80就夠用了，所以默認情況下，Connect.cs文件沒有引用EnvDTE90。以後當你看到 帶著2或3後綴的類型，就能明白它的來歷了。下面是AOM的結構圖（點擊查看大圖）：
不出意外的是，結構很復雜。原因有二：首先VS本身很復雜，DTE用來表示VS中的元素 ，不能不復雜；其次，AOM和DTE源自COM，在.NET和COM間的互操作增強一些額外的工作。 不過不用擔心，這些類封裝得非常之好，用起來還是比較容易的。
這個類型結構的頂端是DTE/DTE2，它是所有其它類型的容器。DTE主要包含5部分內容 ：解決方案和項目、命令（Command）、事件、文檔、調試器，通過這些，我們就能夠操 作VS的方方面面（可以先看一下圖中類的名字）。在後續的隨筆中，你將看到這些內容的 詳細用法。
再議IDTExtensibility2接口
現在回到IDTExtensibility2接口，仔細了解一下它的各個方法。
1）OnConnection
在實現這個接口的時候，我們需要獲得DTE對象，這樣才能操作VS，這件事要在 OnConnection中去做。
C# Code - Method Signature
public void OnConnection(object application,ext_ConnectMode connectMode,
object addInInst,ref Array custom)
application參數持有AOM根對象的引用，它同時實現了EnvDTE.DTE和EnvDTE80.DTE2接 口，所以在我們的例子中，它被轉換為DTE2。connectMode參數告訴Add-In是以何種方式 加載的，它的值來自Extensibility.ext_ConnectMode枚舉：
ext_cm_AfterStartup：在VS啟動之後加載
ext_cm_Startup：在VS啟動之時加載
ext_cm_External：在VS外部加載（VS已經不再使用該值）
ext_cm_CommandLine：從命令行加載
ext_cm_Solution：在解決方案內加載
ext_cm_UISetup：在建立用戶界面時加載
我們可以根據該參數值的不同進行相應的操作，比如如果是ext_cm_UISetup，可以在 菜單上添加一條命令（就像Add-In向導所做的那樣）。
Add-In本身是AddIn接口的一個實例，addInInst參數持有該實例的引用，我們可以將 該值保存下來備用。最後，IDTExtensibility2接口的每個方法都有一個custom參數， Add-In的宿主環境可以通過它來傳遞宿主相關的信息，不過VS總是傳遞一個空的數組（汗 。。。）。
2）OnStartupComplete
OnStartupComplete事件僅僅在Add-In隨VS啟動加載的時候才會觸發。
C# Code - Method Signature
void OnStartupComplete(ref Array custom)
如果一個Add-In隨VS啟動而加載，OnConnection並非總是進行初始化的好地方——比 如，Add-In加載的較早，而Add-In需要訪問的VS組件尚未加載完畢。
3）OnAddInsUpdate
C# Code - Method Signature
void OnAddInsUpdate(ref Array custom)
在某個Add-In被加載或卸載的時候，OnAddInsUpdate事件會觸發。OnAddInsUpdate事 件沒有提供被加載或卸載Add-In的信息，不過我們有辦法獲取到。大體原理是：通過 DTE.AddIns/DTE2.AddIns集合我們能夠獲取到所有的Add-In，裡面的元素類型為AddIn， AddIn有個Connected屬性，用以表示該Add-In是否處於加載狀態，我們在首次觸發 OnAddInsUpdate事件的時候記錄所有Add-In的狀態，在下次觸發的時候就知道那些Add-In 狀態改變了，這裡就不再給出代碼了。
4）OnBeginShutDown
C# Code - Method Signature
void OnBeginShutdown(ref Array custom)
如果在一個Add-In運行的時候關閉VS，OnBeginShutDown事件會觸發。我們在這個時候 可以做一些必要的清理工作。
5）OnDisconnection
C# Code - Method Signature
void OnDisconnection(ext_DisconnectMode disconnectMode,ref Array custom)
在Add-In的生命周期結束的時候，OnDisconnection事件會觸發。它跟 OnBeginShutDown事件的不同之處在於，這裡結束的是Add-In而不是VS。disconnectMode 參數的值來自Extensibility.ext_DisconnectMode枚舉：
ext_dm_HostShutdown：因為VS關閉而卸載
ext_dm_UserClosed：在VS運行時卸載
ext_dm_UISetupComplete：在用戶界面創建完畢後卸載
ext_dm_SolutionClosed：在解決方案關閉時卸載
它的作用類似於ext_ConnectMode，我們可以根據Add-In卸載方式的不同采取不同的動 作。
唔，至此Add-In的事件和生命周期介紹完畢。
我們身在何處？
本文主要介紹了VS Add-In的事件和生命周期，通過這些知識，我們能夠知道在何時獲 取需要的信息；同時還簡單介紹了VS自動化對象模型。加上Add-In運行機制解析（上）， 我們應當對Add-In的運行機制有個基本的了解，為接下來的開發打下基礎。到現在我們還 不足以寫出真正有用的Add-In，從下一篇開始我將介紹如何開發真正有用的Add-In。
出處：http://anderslly.cnblogs.com
