前言

在上篇Add-In運(yùn)行機(jī)制解析（上）中，我分析了Add-In向?qū)傻拇a，從中我們知道只要?jiǎng)?chuàng)建一個(gè)類庫(kù)，它包含實(shí)現(xiàn)了IDTExtensibility2接口的類，然后為其建立.addin配置文件，就可以實(shí)現(xiàn)一個(gè)Add-In了。本文將更進(jìn)一步，介紹Add-In的事件和生命周期，為今后的開(kāi)發(fā)打下基礎(chǔ)。

Add-In的事件

Add-In是事件驅(qū)動(dòng)的，可以猜到的事件有加載、卸載、狀態(tài)改變等等。事實(shí)上，這些事件都與IDTExtensibility2接口有關(guān)，也就是該接口的5個(gè)方法：

如果要了解這些方法如何執(zhí)行，一個(gè)辦法是在這些方法中加一個(gè)MessageBox，然后通過(guò)Add-In Manager進(jìn)行一些操作，來(lái)觀察事件的執(zhí)行。現(xiàn)在使用Add-In向?qū)Ы⒁粋€(gè)簡(jiǎn)單的Add-In，名字為L(zhǎng)ifeCycleAddin，不要選擇在Tools菜單顯示命令，也不要選擇在VS啟動(dòng)時(shí)加載。然后把Connect類的代碼簡(jiǎn)化一下：

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;
}

每個(gè)方法的注釋說(shuō)明了相應(yīng)的事件何時(shí)觸發(fā)。OnConnection是在Add-In加載的時(shí)候；OnDisconnection是在Add-In卸載的時(shí)候；OnAddInsUpdate是在所有Add-In的集合狀態(tài)發(fā)生改變的時(shí)候；OnStartupComplete是在宿主環(huán)境加載完成的時(shí)候；OnBeginShutdown則是在宿主環(huán)境將被關(guān)閉的時(shí)候。現(xiàn)在編譯項(xiàng)目，然后關(guān)閉VS。

打開(kāi)VS，開(kāi)始第一回合的觀察。由于沒(méi)有選擇在VS啟動(dòng)時(shí)加載，所以現(xiàn)在什么也不會(huì)發(fā)生。打開(kāi)Add-In Manager，對(duì)于LifeCycleAddin，將其設(shè)置為可用，確定。這時(shí)觸發(fā)了OnConnection，connectMode為ext_cm_AfterStartup，也就是說(shuō)在VS啟動(dòng)之后才加載的；然后還觸發(fā)了OnAddinsUpdate，因?yàn)長(zhǎng)ifeCycleAddin的狀態(tài)改變了。再次打開(kāi)Add-In Manager，對(duì)于LifeCycleAddin，將其設(shè)置為啟動(dòng)時(shí)加載，確定，再次觸發(fā)OnAddinsUpdate。現(xiàn)在關(guān)閉VS，由于Add-In已經(jīng)加載，所以會(huì)觸發(fā)OnBeginShutdown，然后是OnDisconnection，說(shuō)明Add-In已經(jīng)被卸載。

打開(kāi)VS，開(kāi)始第二回合的觀察。由于選擇了在VS啟動(dòng)時(shí)加載，所以此時(shí)觸發(fā)了OnConnection，connectMode為ext_cm_Startup，也就是說(shuō)是在VS啟動(dòng)時(shí)加載的；之后連續(xù)觸發(fā)了OnAddinsUpdate和OnStartupComplete，只有設(shè)置為在VS啟動(dòng)時(shí)加載才可能觸發(fā)該事件。至此，5個(gè)事件都已經(jīng)觸發(fā)過(guò)了。

比較有意思的是OnAddinsUpdate。現(xiàn)在打開(kāi)Add-In Manager，改變另一個(gè)Add-In的設(shè)置，點(diǎn)擊確定，該事件也會(huì)觸發(fā)，這就是前面所說(shuō)的“所有Add-In的集合狀態(tài)發(fā)生改變的時(shí)候”。

由前面的介紹可以了解到，實(shí)現(xiàn)IDTExtensibility2接口是每個(gè)Add-In的核心所在。但是僅僅這些顯然還不夠。我們不僅需要知道VS合適啟動(dòng)、卸載或改變了Add-In，我們還要能夠在這些時(shí)候訪問(wèn)VS，否則開(kāi)發(fā)VS的Add-In也就沒(méi)意義了。這就用到了VS的自動(dòng)化對(duì)象模型（Automation Object Model）。

VS自動(dòng)化對(duì)象模型簡(jiǎn)介

在Connect.cs文件的頂部using部分，可以看到兩個(gè)命名空間：EnvDTE和EnvDTE80。EnvDTE表示開(kāi)發(fā)環(huán)境工具擴(kuò)展（Environment Development Tools Extensibility，常簡(jiǎn)稱為DTE），就是在這里定義了VS的自動(dòng)化對(duì)象模型（以下簡(jiǎn)稱AOM）。而EnvDTE80的80表示8.0版本的AOM，其實(shí)還有一個(gè)表示9.0版本的EnvDTE90，但沒(méi)有引用進(jìn)來(lái)。

簡(jiǎn)單說(shuō)一下它們的關(guān)系。EnvDTE表示VS2005之前的DTE版本，在每個(gè)版本中微軟都會(huì)修復(fù)一些bug或添加新的功能，到了VS2005，微軟使用了EnvDTE80表示新版本的變化（包括修復(fù)和增強(qiáng)），同時(shí)對(duì)于那些舊版本中已經(jīng)存在的類，在后面加了一個(gè)數(shù)字2表示該類的新版本，如CodeFunction2表示是EnvDTE80中的新類型，而CodeFunction則表示EnvDTE中對(duì)應(yīng)的那個(gè)類。EnvDTE90與此類似，比如Solution3、Solution2和Solution分別表示三個(gè)版本中表示解決方案的類。對(duì)于這些不同版本的類，微軟的做法是用新版本的類繼承舊的版本，然后進(jìn)行擴(kuò)展。

但是相對(duì)于EnvDTE80與EnvDTE之間的變化，EnvDTE90的變化要小很多。大部分時(shí)候EnvDTE80就夠用了，所以默認(rèn)情況下，Connect.cs文件沒(méi)有引用EnvDTE90。以后當(dāng)你看到帶著2或3后綴的類型，就能明白它的來(lái)歷了。下面是AOM的結(jié)構(gòu)圖（點(diǎn)擊查看大圖）：

不出意外的是，結(jié)構(gòu)很復(fù)雜。原因有二：首先VS本身很復(fù)雜，DTE用來(lái)表示VS中的元素，不能不復(fù)雜；其次，AOM和DTE源自COM，在.NET和COM間的互操作增強(qiáng)一些額外的工作。不過(guò)不用擔(dān)心，這些類封裝得非常之好，用起來(lái)還是比較容易的。

這個(gè)類型結(jié)構(gòu)的頂端是DTE/DTE2，它是所有其它類型的容器。DTE主要包含5部分內(nèi)容：解決方案和項(xiàng)目、命令（Command）、事件、文檔、調(diào)試器，通過(guò)這些，我們就能夠操作VS的方方面面（可以先看一下圖中類的名字）。在后續(xù)的隨筆中，你將看到這些內(nèi)容的詳細(xì)用法。

再議IDTExtensibility2接口

現(xiàn)在回到IDTExtensibility2接口，仔細(xì)了解一下它的各個(gè)方法。

1）OnConnection

在實(shí)現(xiàn)這個(gè)接口的時(shí)候，我們需要獲得DTE對(duì)象，這樣才能操作VS，這件事要在OnConnection中去做。

C# Code - Method Signature
public?void?OnConnection(object?application,?ext_ConnectMode?connectMode,?
????????????object?addInInst,?ref?Array?custom)

application參數(shù)持有AOM根對(duì)象的引用，它同時(shí)實(shí)現(xiàn)了EnvDTE.DTE和EnvDTE80.DTE2接口，所以在我們的例子中，它被轉(zhuǎn)換為DTE2。connectMode參數(shù)告訴Add-In是以何種方式加載的，它的值來(lái)自Extensibility.ext_ConnectMode枚舉：

• ext_cm_AfterStartup：在VS啟動(dòng)之后加載
• ext_cm_Startup：在VS啟動(dòng)之時(shí)加載
• ext_cm_External：在VS外部加載（VS已經(jīng)不再使用該值）
• ext_cm_CommandLine：從命令行加載
• ext_cm_Solution：在解決方案內(nèi)加載
• ext_cm_UISetup：在建立用戶界面時(shí)加載

我們可以根據(jù)該參數(shù)值的不同進(jìn)行相應(yīng)的操作，比如如果是ext_cm_UISetup，可以在菜單上添加一條命令（就像Add-In向?qū)龅哪菢?#xff09;。

Add-In本身是AddIn接口的一個(gè)實(shí)例，addInInst參數(shù)持有該實(shí)例的引用，我們可以將該值保存下來(lái)備用。最后，IDTExtensibility2接口的每個(gè)方法都有一個(gè)custom參數(shù)，Add-In的宿主環(huán)境可以通過(guò)它來(lái)傳遞宿主相關(guān)的信息，不過(guò)VS總是傳遞一個(gè)空的數(shù)組（汗。。。）。

2）OnStartupComplete

OnStartupComplete事件僅僅在Add-In隨VS啟動(dòng)加載的時(shí)候才會(huì)觸發(fā)。

C# Code - Method Signature
void?OnStartupComplete(ref?Array?custom)

如果一個(gè)Add-In隨VS啟動(dòng)而加載，OnConnection并非總是進(jìn)行初始化的好地方——比如，Add-In加載的較早，而Add-In需要訪問(wèn)的VS組件尚未加載完畢。

3）OnAddInsUpdate

C# Code - Method Signature
void?OnAddInsUpdate(ref?Array?custom)

在某個(gè)Add-In被加載或卸載的時(shí)候，OnAddInsUpdate事件會(huì)觸發(fā)。OnAddInsUpdate事件沒(méi)有提供被加載或卸載Add-In的信息，不過(guò)我們有辦法獲取到。大體原理是：通過(guò)DTE.AddIns/DTE2.AddIns集合我們能夠獲取到所有的Add-In，里面的元素類型為AddIn，AddIn有個(gè)Connected屬性，用以表示該Add-In是否處于加載狀態(tài)，我們?cè)谑状斡|發(fā)OnAddInsUpdate事件的時(shí)候記錄所有Add-In的狀態(tài)，在下次觸發(fā)的時(shí)候就知道那些Add-In狀態(tài)改變了，這里就不再給出代碼了。

4）OnBeginShutDown

C# Code - Method Signature
void?OnBeginShutdown(ref?Array?custom)

如果在一個(gè)Add-In運(yùn)行的時(shí)候關(guān)閉VS，OnBeginShutDown事件會(huì)觸發(fā)。我們?cè)谶@個(gè)時(shí)候可以做一些必要的清理工作。

5）OnDisconnection

C# Code - Method Signature
void?OnDisconnection(ext_DisconnectMode?disconnectMode,?ref?Array?custom)

在Add-In的生命周期結(jié)束的時(shí)候，OnDisconnection事件會(huì)觸發(fā)。它跟OnBeginShutDown事件的不同之處在于，這里結(jié)束的是Add-In而不是VS。disconnectMode參數(shù)的值來(lái)自Extensibility.ext_DisconnectMode枚舉：

• ext_dm_HostShutdown：因?yàn)閂S關(guān)閉而卸載
• ext_dm_UserClosed：在VS運(yùn)行時(shí)卸載
• ext_dm_UISetupComplete：在用戶界面創(chuàng)建完畢后卸載
• ext_dm_SolutionClosed：在解決方案關(guān)閉時(shí)卸載

它的作用類似于ext_ConnectMode，我們可以根據(jù)Add-In卸載方式的不同采取不同的動(dòng)作。

唔，至此Add-In的事件和生命周期介紹完畢。

我們身在何處？

本文主要介紹了VS Add-In的事件和生命周期，通過(guò)這些知識(shí)，我們能夠知道在何時(shí)獲取需要的信息；同時(shí)還簡(jiǎn)單介紹了VS自動(dòng)化對(duì)象模型。加上Add-In運(yùn)行機(jī)制解析（上），我們應(yīng)當(dāng)對(duì)Add-In的運(yùn)行機(jī)制有個(gè)基本的了解，為接下來(lái)的開(kāi)發(fā)打下基礎(chǔ)。到現(xiàn)在我們還不足以寫出真正有用的Add-In，從下一篇開(kāi)始我將介紹如何開(kāi)發(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

總結(jié)

以上是生活随笔為你收集整理的Visual Studio 2008 可扩展性开发（三）：Add-In运行机制解析（下）的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。