詳解Visual Studio 2010 Extension的應(yīng)用

作者：winkingzhang 2010-02-05 09:06:17

關(guān)于Visual Studio 2010 Extension，很多開發(fā)者并不是很熟悉。在本篇文章中將詳細(xì)介紹，以供大家參考。

對(duì)于即將發(fā)布正式版的Visual Studio 2010，有一個(gè)Visual Studio 2010 Extension功能。平時(shí)大家關(guān)注Visual Studio 2010 Extension不多，希望通過本文能讓大家更好的了解。

最近Visual Studio 2010 Extension在Visual Studio Blog（http://blogs.msdn.com/visualstudio/）上提得很頻繁，于是也想翻來(lái)文檔研究研究，結(jié)果居然找了半天，居然沒有一丁點(diǎn)完整介紹這一塊的，于是，只好自己找著VS IDE上的模板提供的內(nèi)容和Visual Studio Blog上的講解，一邊Reflector參演，一邊涂鴉一些代碼，準(zhǔn)備實(shí)彈演練一下，但是覺得這個(gè)模板建出來(lái)的Extension也太簡(jiǎn)單了，剛好看到AxTool（http://www.axtools.com/products-vs2010-extensions.php）有一個(gè)代碼編輯器擴(kuò)展，也是VS Extension的，于是就照著這個(gè)，自己一步一步做一下。

首先，要想建立VS Extension工程，你需要安裝VS2010 SDK，目前是Beta2版本，你可以到這里可以下載：http://go.microsoft.com/fwlink/?LinkID=165597），這里我是通過Editor Text Adornment模板創(chuàng)建的工程，嗯，我就不詳細(xì)寫如何通過模板創(chuàng)建自己Extension工程了，如果你不熟悉這里，可以參考Quan To的這篇帖子——Building and publishing an extension for Visual Studio 2010。

建好工程以后，會(huì)自動(dòng)生成TextViewCreationListener，這里實(shí)現(xiàn)了IWpfTextViewCreationListener接口，并通過MEF導(dǎo)出IWpfTextViewCreationListener對(duì)象：

[TextViewRole("DOCUMENT")]  
[Export(typeof(IWpfTextViewCreationListener))]  
[ContentType("text")]  
internal sealed class PETextViewCreationListener : IWpfTextViewCreationListener  
{  
void IWpfTextViewCreationListener.TextViewCreated(IWpfTextView textView)  
{  
//...  
}  
}

這樣VS就會(huì)在合適的時(shí)候調(diào)用IWpfTextViewCreationListener.TextViewCreated方法來(lái)通知文字編輯的狀態(tài)改變。

為了實(shí)現(xiàn)浮動(dòng)一個(gè)自己的工具欄，這里還需要導(dǎo)出一個(gè)AdornmentLayerDefinition，并通過Order Attribute來(lái)定制這個(gè)Adornment層的顯示位置和次序：

[Name("QuickToolbarAdornmentLayer")]  
[Order(After = "Text")]  
[Export(typeof(AdornmentLayerDefinition))]  
public AdornmentLayerDefinition QuickToolbarLayerDefinition  
{  
get;  
set;  
}

這里的Name Attribute很重要，以后的代碼中要獲取我們的AdornmentLayer就得靠它了：

this._adornmentLayer = 
this._textView.GetAdornmentLayer("QuickToolbarAdornmentLayer");

扯得遠(yuǎn)了，回到IWpfTextViewCreationListener.TextViewCreated，通過這里，可以得到一個(gè)IWpfTextView，

這是所有操作的目標(biāo)和展現(xiàn)，另外，還需要掛他的Closed、LayoutChanged、MouseHovered、SelectionChanged等事件，以響應(yīng)用戶行為。

由于我們要通過工具欄操作代碼，所以需要通過MEF導(dǎo)入IEditorOperationsFactoryService：這樣就可以在IWpfTextViewCreationListener.TextViewCreated中通過IEditorOperationsFactoryService.GetEditorOperations(ITextView)來(lái)獲得IEditorOperations，有了它，就可以方便快捷的編輯代碼了。

接下來(lái)要實(shí)現(xiàn)工具欄的界面，這個(gè)就不多說了，建一個(gè)UserControl，里面放上ToolBar就搞定了。那么何時(shí)何地顯示這個(gè)ToolBar呢？這就要依賴IWpfTextView的SelectionChanged事件了，上面提到會(huì)掛這個(gè)事件就是為這里用的。

1 private void MayBeAdornmentShowCondition()
2 {
3 if (!this._textView.Selection.IsEmpty)
4 {
5 SnapshotPoint startPos = this._textView.Selection.Start.Position;
6 SnapshotPoint endPos = this._textView.Selection.End.Position;
7 IWpfTextViewLine textViewLineContainingBufferPosition = this._textView.GetTextViewLineContainingBufferPosition(startPos);
8 TextBounds characterBounds = textViewLineContainingBufferPosition.GetCharacterBounds(startPos);
9 TextBounds bounds2 = this._textView.GetTextViewLineContainingBufferPosition(endPos).GetCharacterBounds(endPos);
10 if (this._fromMouseHover)
11 {
12 this._mustHaveAdornmentDisplayed = true;
13 }
14 else
15 {
16 PELeftButtonMouseProcessor property = null;
17 try
18 {
19 property = this._textView.Properties.GetProperty<PELeftButtonMouseProcessor>(typeof(PELeftButtonMouseProcessor));
20 }
21 catch
22 {
23 }
24 this._mustHaveAdornmentDisplayed = (property != null)
25 && (property.IsLeftButtonDown
26 || ((DateTime.Now - property.LastLeftButtonDownTime).TotalMilliseconds < 400.0));
27 }
28 if (this._mustHaveAdornmentDisplayed)
29 {
30 TextBounds selectionBounds = !this._textView.Selection.IsReversed ? bounds2 : characterBounds;
31 int offset = 7;
32 double top = selectionBounds.Top + (!this._textView.Selection.IsReversed ?

(offset + textViewLineContainingBufferPosition.Height) : (-offset - this._adornmentUI.ActualHeight));
33 if (top < 0.0)
34 {
35 top = 0.0;
36 }
37 double left = characterBounds.Left + ((bounds2.Left - characterBounds.Left) / 2.0);
38 if ((left + this._adornmentUI.ActualWidth) > this._textView.ViewportWidth)
39 {
40 left = this._textView.ViewportWidth - this._adornmentUI.ActualWidth;
41 }
42 Canvas.SetTop(this._adornmentUI, top);
43 Canvas.SetLeft(this._adornmentUI, left);
44 long chars = 0L;
45 try
46 {
47 chars = this._textView.Selection.SelectedSpans[0].Span.Length;
48 }
49 catch
50 {
51 }
52 this._adornmentUI.SetStatus(chars);
53 this.RenderSelectionPopup();
54 }
55 }
56 else
57 {
58 this._mustHaveAdornmentDisplayed = false;
59 this._adornmentLayer.RemoveAdornmentsByTag(this._adornmentTag);
60 }
61 }
62
63 private void RenderSelectionPopup()
64 {
65 if (this._mustHaveAdornmentDisplayed)
66 {
67 IAdornmentLayerElement element = null;
68 try
69 {
70 element = this._adornmentLayer.Elements.First<IAdornmentLayerElement>(
71 (IAdornmentLayerElement ile) => ile.Tag.ToString() == this._adornmentTag);
72 }
73 catch (InvalidOperationException)
74 {
75 }
76 if (element == null)
77 {
78 this._adornmentLayer.AddAdornment(this._textView.Selection.SelectedSpans[0], this._adornmentTag, this._adornmentUI);
79 }
80 this._timer.Stop();
81 this._timer.Start();
82 }
83 }
84
85 private void selection_SelectionChanged(object sender, EventArgs e)
86 {
87 this._fromMouseHover = false;
88 this.MayBeAdornmentShowCondition();
89 }
90

然后要注意的是IWpfTextView的Closed事件處理要記得取消所有掛這個(gè)事件等等收尾工作。

接下來(lái)編譯工程，打包VSIX就完成了，目前實(shí)現(xiàn)的主要Feature：
1、當(dāng)在代碼編輯器中選擇一段文字，并將鼠標(biāo)移到文字區(qū)域時(shí)，QuickToolbar會(huì)以半透明的方式“浮”文字的旁邊。
代碼段 2、當(dāng)鼠標(biāo)移到QuickToolbar區(qū)域，QuickToolbar會(huì)變成不透明，其上的按鈕會(huì)響應(yīng)鼠標(biāo)動(dòng)作。
代碼段2
3、目前支持的操作有：

剪切（Cut）
復(fù)制（Copy）
粘貼（Paste）
刪除（Delete）
減小縮進(jìn)（Decrease Indent）
增加縮進(jìn)（Increase Indent）
注釋代碼（Comment）
取消注釋（Uncomment）
等等

上面主要展示了如何使用MEF擴(kuò)展VS2010，來(lái)擴(kuò)展編輯控制和展現(xiàn)自己的UI；在實(shí)現(xiàn)QuickToolbar的時(shí)候，發(fā)現(xiàn)MEF僅僅提供了很基本的編輯控制，如果需要高級(jí)的操作，比如注釋選擇的代碼，就捉襟見肘，很是麻煩。

我將展示如何深入挖掘VS2010 Extension，使它成為鋒利的軍刀，而不是繡花枕頭。鑒于此，這里就從上面提到了的Feature——注釋和取消注釋選擇的代碼來(lái)剖析，希望可以為大家拓寬思路，更好的利用VS2010。

首先回顧一下上篇中的實(shí)現(xiàn)，當(dāng)時(shí)是基于TextViewLine做注釋代碼的，這里有兩個(gè)潛在問題：其一，TextViewLine，顧名思義，是“可視區(qū)域”的行，所以如果選擇超出可視區(qū)域，超出的部分就沒有注釋掉；其二，當(dāng)選擇的結(jié)束位置在行的結(jié)尾時(shí)，無(wú)法實(shí)現(xiàn)IDE注釋代碼后保持Caret在選擇結(jié)尾而不跳到下一行的行為，當(dāng)嘗試自己重新選擇并移動(dòng)Caret就會(huì)收到ITextSpanshot無(wú)效的異常。

上面提到了VS2010 Extension對(duì)編輯器的編輯行為的控制能力僅僅提供了通用的，比如Cut/Copy/Paste等等，而其他的諸如注釋/取消注釋代碼，添加、刪除、導(dǎo)航到Bookmark等程序員常用功能沒有暴露出來(lái)，具體可以參考IEditorOperations Interface（http://msdn.microsoft.com/en-us/library/microsoft.visualstudio.text.operations.ieditoroperations_methods%28VS.100%29.aspx），這里的所有Member表達(dá)了其所支持的編輯操作。總之，這條路只有這么幾個(gè)目的地。

那么，還有其他方法嗎？貌似走到了死胡同了，但是當(dāng)我們使用IDE時(shí)候，卻是可以很容易的通過Edit菜單找到所有的功能的，問題是，它們要怎樣才能為我所用呢？

我首先想到的是在VSSDK中找找，結(jié)果一個(gè)名字看起來(lái)很順眼的接口撞到眼里，它就是IVsUIShell Interface（http://msdn.microsoft.com/en-us/library/microsoft.visualstudio.shell.interop.ivsuishell%28VS.100%29.aspx），MSDN上市這么說的：

This interface provides access to basic windowing functionality, including access to and creation of tool windows and document windows. provided by the environment.

也就是說這是一個(gè)由IDE提供的全局的Service，可以創(chuàng)建、訪問工具窗口和編輯窗口。瀏覽一下這個(gè)所有Member，發(fā)現(xiàn)了一個(gè)叫IVsUIShell.PostExecCommand(...)（http://msdn.microsoft.com/en-us/library/microsoft.visualstudio.shell.interop.ivsuishell.postexeccommand%28VS.100%29.aspx）的方法，MSDN描述說通過它可以異步執(zhí)行Command，那么，只要找到注釋代碼的Command，在通過這個(gè)接口就可以實(shí)現(xiàn)VS IDE一樣的注釋代碼的Feature了。酷斃了，就是它，當(dāng)怎么得到它呢？現(xiàn)在請(qǐng)留心MSDN上的解釋，就是上面我使用紅色粗體表示出來(lái)的部分——這個(gè)由IDE提供的全局的Service，那么可以通過Package.GetGlobalService(...)（http://msdn.microsoft.com/en-us/library/microsoft.visualstudio.shell.package.getglobalservice%28VS.100%29.aspx）來(lái)獲取：

IVsUIShell shell = Package.GetGlobalService(typeof(IVsUIShell)) as IVsUIShell;

接下來(lái)是找到自己需要Command，然后PostExecCommand就搞定了；而VS提供的Command有兩部分組成：Guid和CommandID，這個(gè)大部分都在VSConstants Class（http://msdn.microsoft.com/en-us/library/microsoft.visualstudio.vsconstants%28VS.100%29.aspx）里面，以注釋代碼為例，其Guid是：VsConstants.VSStd2k，而CommandID是VSConstants.VSStd2kCmdID.COMMENTBLOCK。下面是我包裝的注釋和取消注釋的代碼片段：

 public static void ProcessComments(bool comment)  
 {  
 IVsUIShell shell = Package.GetGlobalService(typeof(IVsUIShell)) as IVsUIShell;  
 if (shell != null)  
 {  
 Guid std2k = VSConstants.VSStd2K;  
 uint cmdId = comment ?   
(uint)VSConstants.VSStd2KCmdID.COMMENT_BLOCK :  
(uint)VSConstants.VSStd2KCmdID.UNCOMMENT_BLOCK;  
 object arg = null;  
 shell.PostExecCommand(ref std2k, cmdId, 0, ref arg);  
 }  
 }