Visual Studio 2008 可扩展性开发（三）：Add-In运行机制解析（下）
前言
在上篇Add-In運行機制解析（上）中，我分析了Add-In向導生成的代碼，從中我們知道只要創(chuàng)建一個類庫，它包含實現(xiàn)了IDTExtensibility2接口的類，然后為其建立.addin配置文件，就可以實現(xiàn)一個Add-In了。本文將更進一步，介紹Add-In的事件和生命周期，為今后的開發(fā)打下基礎。
Add-In的事件
Add-In是事件驅動的，可以猜到的事件有加載、卸載、狀態(tài)改變等等。事實上，這些事件都與IDTExtensibility2接口有關，也就是該接口的5個方法：
如果要了解這些方法如何執(zhí)行，一個辦法是在這些方法中加一個MessageBox，然后通過Add-In Manager進行一些操作，來觀察事件的執(zhí)行。現(xiàn)在使用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;
}
每個方法的注釋說明了相應的事件何時觸發(fā)。OnConnection是在Add-In加載的時候；OnDisconnection是在Add-In卸載的時候；OnAddInsUpdate是在所有Add-In的集合狀態(tài)發(fā)生改變的時候；OnStartupComplete是在宿主環(huán)境加載完成的時候；OnBeginShutdown則是在宿主環(huán)境將被關閉的時候。現(xiàn)在編譯項目，然后關閉VS。
打開VS，開始第一回合的觀察。由于沒有選擇在VS啟動時加載，所以現(xiàn)在什么也不會發(fā)生。打開Add-In Manager，對于LifeCycleAddin，將其設置為可用，確定。這時觸發(fā)了OnConnection，connectMode為ext_cm_AfterStartup，也就是說在VS啟動之后才加載的；然后還觸發(fā)了OnAddinsUpdate，因為LifeCycleAddin的狀態(tài)改變了。再次打開Add-In Manager，對于LifeCycleAddin，將其設置為啟動時加載，確定，再次觸發(fā)OnAddinsUpdate。現(xiàn)在關閉VS，由于Add-In已經(jīng)加載，所以會觸發(fā)OnBeginShutdown，然后是OnDisconnection，說明Add-In已經(jīng)被卸載。
打開VS，開始第二回合的觀察。由于選擇了在VS啟動時加載，所以此時觸發(fā)了OnConnection，connectMode為ext_cm_Startup，也就是說是在VS啟動時加載的；之后連續(xù)觸發(fā)了OnAddinsUpdate和OnStartupComplete，只有設置為在VS啟動時加載才可能觸發(fā)該事件。至此，5個事件都已經(jīng)觸發(fā)過了。
比較有意思的是OnAddinsUpdate。現(xiàn)在打開Add-In Manager，改變另一個Add-In的設置，點擊確定，該事件也會觸發(fā)，這就是前面所說的“所有Add-In的集合狀態(tài)發(fā)生改變的時候”。
由前面的介紹可以了解到，實現(xiàn)IDTExtensibility2接口是每個Add-In的核心所在。但是僅僅這些顯然還不夠。我們不僅需要知道VS合適啟動、卸載或改變了Add-In，我們還要能夠在這些時候訪問VS，否則開發(fā)VS的Add-In也就沒意義了。這就用到了VS的自動化對象模型（Automation Object Model）。
VS自動化對象模型簡介
在Connect.cs文件的頂部using部分，可以看到兩個命名空間：EnvDTE和EnvDTE80。EnvDTE表示開發(fā)環(huán)境工具擴展（Environment Development Tools Extensibility，常簡稱為DTE），就是在這里定義了VS的自動化對象模型（以下簡稱AOM）。而EnvDTE80的80表示8.0版本的AOM，其實還有一個表示9.0版本的EnvDTE90，但沒有引用進來。
簡單說一下它們的關系。EnvDTE表示VS2005之前的DTE版本，在每個版本中微軟都會修復一些bug或添加新的功能，到了VS2005，微軟使用了EnvDTE80表示新版本的變化（包括修復和增強），同時對于那些舊版本中已經(jīng)存在的類，在后面加了一個數(shù)字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的方方面面（可以先看一下圖中類的名字）。在后續(xù)的隨筆中，你將看到這些內容的詳細用法。
再議IDTExtensibility2接口
現(xiàn)在回到IDTExtensibility2接口，仔細了解一下它的各個方法。
1）OnConnection
在實現(xiàn)這個接口的時候，我們需要獲得DTE對象，這樣才能操作VS，這件事要在OnConnection中去做。
C# Code - Method Signaturepublic?void?OnConnection(object?application,?ext_ConnectMode?connectMode,?
????????????object?addInInst,?ref?Array?custom)
application參數(shù)持有AOM根對象的引用，它同時實現(xiàn)了EnvDTE.DTE和EnvDTE80.DTE2接口，所以在我們的例子中，它被轉換為DTE2。connectMode參數(shù)告訴Add-In是以何種方式加載的，它的值來自Extensibility.ext_ConnectMode枚舉：
- ext_cm_AfterStartup：在VS啟動之后加載
- ext_cm_Startup：在VS啟動之時加載
- ext_cm_External：在VS外部加載（VS已經(jīng)不再使用該值）
- ext_cm_CommandLine：從命令行加載
- ext_cm_Solution：在解決方案內加載
- ext_cm_UISetup：在建立用戶界面時加載
我們可以根據(jù)該參數(shù)值的不同進行相應的操作，比如如果是ext_cm_UISetup，可以在菜單上添加一條命令（就像Add-In向導所做的那樣）。
Add-In本身是AddIn接口的一個實例，addInInst參數(shù)持有該實例的引用，我們可以將該值保存下來備用。最后，IDTExtensibility2接口的每個方法都有一個custom參數(shù)，Add-In的宿主環(huán)境可以通過它來傳遞宿主相關的信息，不過VS總是傳遞一個空的數(shù)組（汗。。。）。
2）OnStartupComplete
OnStartupComplete事件僅僅在Add-In隨VS啟動加載的時候才會觸發(fā)。
C# Code - Method Signaturevoid?OnStartupComplete(ref?Array?custom)
如果一個Add-In隨VS啟動而加載，OnConnection并非總是進行初始化的好地方——比如，Add-In加載的較早，而Add-In需要訪問的VS組件尚未加載完畢。
3）OnAddInsUpdate
C# Code - Method Signaturevoid?OnAddInsUpdate(ref?Array?custom)
在某個Add-In被加載或卸載的時候，OnAddInsUpdate事件會觸發(fā)。OnAddInsUpdate事件沒有提供被加載或卸載Add-In的信息，不過我們有辦法獲取到。大體原理是：通過DTE.AddIns/DTE2.AddIns集合我們能夠獲取到所有的Add-In，里面的元素類型為AddIn，AddIn有個Connected屬性，用以表示該Add-In是否處于加載狀態(tài)，我們在首次觸發(fā)OnAddInsUpdate事件的時候記錄所有Add-In的狀態(tài)，在下次觸發(fā)的時候就知道那些Add-In狀態(tài)改變了，這里就不再給出代碼了。
4）OnBeginShutDown
C# Code - Method Signaturevoid?OnBeginShutdown(ref?Array?custom)
如果在一個Add-In運行的時候關閉VS，OnBeginShutDown事件會觸發(fā)。我們在這個時候可以做一些必要的清理工作。
5）OnDisconnection
C# Code - Method Signaturevoid?OnDisconnection(ext_DisconnectMode?disconnectMode,?ref?Array?custom)
在Add-In的生命周期結束的時候，OnDisconnection事件會觸發(fā)。它跟OnBeginShutDown事件的不同之處在于，這里結束的是Add-In而不是VS。disconnectMode參數(shù)的值來自Extensibility.ext_DisconnectMode枚舉：
- ext_dm_HostShutdown：因為VS關閉而卸載
- ext_dm_UserClosed：在VS運行時卸載
- ext_dm_UISetupComplete：在用戶界面創(chuàng)建完畢后卸載
- ext_dm_SolutionClosed：在解決方案關閉時卸載
它的作用類似于ext_ConnectMode，我們可以根據(jù)Add-In卸載方式的不同采取不同的動作。
唔，至此Add-In的事件和生命周期介紹完畢。
我們身在何處？
本文主要介紹了VS Add-In的事件和生命周期，通過這些知識，我們能夠知道在何時獲取需要的信息；同時還簡單介紹了VS自動化對象模型。加上Add-In運行機制解析（上），我們應當對Add-In的運行機制有個基本的了解，為接下來的開發(fā)打下基礎。到現(xiàn)在我們還不足以寫出真正有用的Add-In，從下一篇開始我將介紹如何開發(fā)真正有用的Add-In。
參考
《Professional Visual Studio? 2008 Extensibility》
《Working with Microsoft Visual Studio? 2005》
?
from:http://www.cnblogs.com/anderslly/archive/2009/03/03/vs-addin-explained-part2.html
總結
以上是生活随笔為你收集整理的Visual Studio 2008 可扩展性开发（三）：Add-In运行机制解析（下）的全部內容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： 学习org-mode
- 下一篇： 《架构之美》摘录一