（翻譯）LearnVSXNow! #9 - 創建我們第一個工具集－重構為服務

  • 2019 年 10 月 5 日
  • 筆記

在第6篇和第7篇里，我們創建了一個名為StartupToolset的示例package，並且手動地添加了一個菜單項和工具窗。在這篇文章里，我們將重構這個package，提取獨立的服務模組出來。

我們這個示例package有很多地方可以重構：不僅可以做提取服務之類的結構調整，也可以封裝可重用的程式碼，以便供以後調用或提高程式碼可讀性。在下一篇文章里我們將封裝可重用的程式碼，但在這一篇里，我們把精力放在服務上。

複製一份StartupToolset

為了在重構之前保留目前的StartupToolset的版本，我把這個package複製了一份，並命名為StartupToolsetRefactored。你可以參考第6篇和第7篇的內容自己來做一個副本：新建一個空的名為StartupToolsRefactored的package，並且根據第6篇的內容為它添加一個菜單項，根據第7篇的內容添加一個工具窗。

為了避免和前一個package衝突，要修改一下StartupToolsRefactored里的GUID，並且修改一下菜單命令的顯示文本，這樣就可以在介面上和舊版的package區分開來。

創建一個全局服務（global service）

在重構的第一步，我們將把「計算引擎」做成一個全局服務。這樣的話別的package就可以調用我們這個服務的功能了。

到目前為止，「計算」的邏輯是直接嵌入到我們的工具窗的用戶控制項CaculationControl類里的。這段邏輯放在了CalculateButton_Click事件處理方法里，這樣我們的程式碼看起來就非常簡單並且容易懂。但是在這種結構下，計算邏輯和我們的package是緊耦合的：

public partial class CalculationControl : UserControl{  ...  private void CalculateButton_Click(object sender, EventArgs e)  {    try    {      int firstArg = Int32.Parse(FirstArgEdit.Text);      int secondArg = Int32.Parse(SecondArgEdit.Text);      int result = 0;      switch (OperatorCombo.Text)      {        case "+":          result = firstArg + secondArg;          break;        ...      }      ResultEdit.Text = result.ToString();    }    catch (SystemException) { ... }    ...  }}

最適合的改進方案是把這段計算邏輯放到一個獨立的服務對象里。如果我們把這個服務對象做成一個全局的VSX服務的話，不僅我們的CalculationControl控制項可以使用它，其他的package也一樣可以使用它。OK，就這樣做！

創建服務介面

每一個服務都必須至少提供一個介面來作為服務的「契約」，所以，不必驚訝，我們要創建介面（譯者註：從技術上來講，服務不一定非得需要介面，這一點我在這篇譯文的後面會做些測試程式碼來說明）。我們可以把介面定義在我們的package程式集里，但是，別的package要想用這個服務的話，就不得不引用我們的整個package：我們通常不想這麼做。

所以，我們用老配方：創建一個的單獨的程式集來放置服務。這樣我們的package和其他的package都可以引用它。

創建一個名為StartupToolsetInterfaces的類庫項目，並在StartupToolsetRefactored項目里引用它。刪除掉默認的Class1.cs文件，並添加一個CalculationService.cs文件。

如果你還記得我們在前面的例子中是怎樣訪問到全局服務的話，你一定會想起來GetService方法：

IVsUIShell uiShell = (IVsUIShell)GetService(typeof(SVsUIShell));

為得到uiShell這個服務對象，我們用到了兩個類型：IVsUIShell是定義服務的介面；SVsUIShell是所謂的標記類型（markup type），用它來標識服務對象。你可能會問，我們為什麼要用兩個類型？只用一個介面類型不就夠了嗎？是的，一個介面類型就夠了，但用兩個類型可以提高靈活性：一個服務對象可以實現一個或多個介面，一個介面也可以被一個或多個服務對象實現（譯者註：例如你有一堆的服務都是IXXXService類型的，但每個服務的具體實現有所不同，你就可以定義若干個標記類型來區分這些不同的服務）。用兩個類型的話，我們即可以給服務對象起名（如SVsUIShell），也可以為服務介面起名（如IVsUIShell）。GetService的參數可以是實現了服務的類型，但也不一定非得這樣。實際上，我們可以傳任何類型給它，這個參數只是作為一個key來標識一個服務對象。

標記類型（markup type)不包含任何功能，它們僅僅用來標記一個類型，以區分其他類型。

我們也按照這種模式來做，在CalculationService.cs文件里，添加兩個介面：一個服務介面和一個標記介面：

using System.Runtime.InteropServices;  namespace StartupToolsetInterfaces{  [Guid("D7524CAB-5029-402d-9591-FA0D59BBA0F0")]  [ComVisible(true)]  public interface ICalculationService  {    bool Calculate(string firstArgText, string secondArgText,       string operatortext, out string resultText);  }    [Guid("AF7F72EF-2B54-4798-B76A-21DC02CC04B7")]  public interface SCalculationService  {  }}

按照慣例，服務介面以「I」開頭，標記介面以「S」開頭。它們必須能夠被COM識別，所以要加上Guid。另外，服務介面必須定義為ComVisible，這樣非託管程式碼就可以檢索到它。

創建服務類

我們把實現計算邏輯的服務實現類定義在我們的package里（不在StartupToolsetInterfaces類庫項目里）。在StartupToolsetRefactored項目里，添加一個CalculationService.cs文件（此CalculationService.cs文件非彼CalculationService.cs 文件），並添加類似下面的程式碼：

using System;using StartupToolsetInterfaces;  namespace MyCompany.StartupToolsetRefactored{  public sealed class CalculationService: ICalculationService, SCalculationService  {    public bool Calculate(string firstArgText, string secondArgText,       string operatorText, out string resultText)    { ... }  }}

由於介面是定義在StartupToolsetInterface程式集里的，所以我們要using它們的命名空間。為了能正常的創建我們的服務，服務類必須既實現服務介面，又實現標記介面(markup type)。如果你沒有實現標記介面，編譯是沒問題的，但這個服務對象實例是不會被創建的。由於標記類型實際上不包含任何方法，所以我們只需要實現Calculate方法就可以了。這個方法的實現可以從CalculationControl控制項的CalculateButton_Click方法里複製過來，並且要做些調整：

public bool Calculate(string firstArgText, string secondArgText,   string operatorText, out string resultText){  try  {    int firstArg = Int32.Parse(firstArgText);    int secondArg = Int32.Parse(secondArgText);    int result = 0;    switch (operatorText)    {      case "+":        result = firstArg + secondArg;        break;      ...    }    resultText = result.ToString();  }  catch (SystemException)  {    resultText = "#Error";    return false;  }  return true;}

現在讓我們修改一下CalculateButton_Click方法，來用這個service：

public partial class CalculationControl : UserControl{  ...  private void CalculateButton_Click(object sender, EventArgs e)  {    ICalculationService calcService = new CalculationService();    string result;    calcService.Calculate(FirstArgEdit.Text, SecondArgEdit.Text,                          OperatorCombo.Text, out result);    ResultEdit.Text = result;    LogCalculation(FirstArgEdit.Text, SecondArgEdit.Text, OperatorCombo.Text,      ResultEdit.Text);  }  ...}

運行StartupToolsetRefactored項目，並且試一下Calculate工具窗，你會發現它能夠正常工作。這樣就夠了嗎？不，還不夠。現在我們有了服務對象，並且應用了它，但我們還需要告訴VS IDE這個服務的存在，這樣別的package才能用它！

提供服務

在我們使我們的服務可見和可用之前，我們先來看一下VS IDE中服務體系的機制。在第5篇中，我講了一下VS IDE中服務的基本概念，這一次讓我們深入一些。

任何一個對象如果想調用一個服務的話，它必須要和service provider「對話」。service provider實現了IServiceProvider介面，並包含GetService方法：

public interface IServiceProvider{  object GetService(Type serviceType);}

很容易想像出來：一個service provider包含了一個預定義的服務集合。VS IDE本身就是一個service provider，然而，VS IDE可以動態的處理服務對象，因為已安裝的package可以提供它們自己的服務給IDE。所以，還應該有一個service container，service container實現了IServiceContainer介面，該介面繼承自IServiceProvider：

public interface IServiceContainer: IServiceProvider{  void AddService(...); // --- Overloaded  void RemoveService(...); // --- Overloaded}

AddService和RemoveService方法提供了我們所期望的service container的功能。一個VSPackage本身就是一個service container（當然也是一個service provider），因為Package類實現了IServiceContainer。

service container並不是一個平面的東東，它可能包含parent container。當添加或移除一個服務的時候，我們可以把這個服務傳給它的parent container，VS IDE就是用這種結構來管理全局服務的。另外，VS IDE用SProfferService服務來管理全局服務，不過MPF幫我們屏蔽了SProfferService：如果我們的package繼承自Package基類的話，我們很少會用到它。

好了，讓我們看看怎樣才能把CalculationService提供給VS IDE。我們需要做下面的幾步：

  1. 第一步：需要一個方法，該方法負責創建相應類型的服務對象。
  2. 第二步：在package上註明該package能提供的服務類型。
  3. 第三步：為服務對象的創建添加初始化程式碼。

第一步：添加負責創建服務對象的方法

服務對象只會被創建一次，然後所有的調用方都用這同一個實例。我們可以在package初始化的時候實例化服務對象，也可以在第一個調用者請求這個服務的時候才去實例化它。

在這裡我們打算用第二種方式，所以我們需要一個創建服務對象的回調方法。在我們的package類中，添加一個CreateService的方法：

private object CreateService(IServiceContainer container, Type serviceType){  if (container != this)  {    return null;  }  if (typeof(SCalculationService) == serviceType)  {    return new CalculationService();  }  return null;}

這個回調方法有兩個參數：container是請求這個服務的容器，serviceType是請求的服務類型。如果能夠創建服務的話，該方法必須返回服務實例，否則必須返回null。在上面這個程式碼段里，我們只接受是package本身的container，並且只能創建SCalculationService類型的服務。

第二步：聲明能提供的服務

就像菜單命令和工具窗那樣，我們必須在package那裡附加一個attribute，以聲明該package能提供的服務：

[ProvideService(typeof(SCalculationService))] public sealed class StartupToolsetRefactoredPackage : Package { ... }

ProvideService屬性的作用是：regpkg.exe利用這個attribute去註冊我們的服務，並使我們的package能夠按需載入（在第一次調用package的服務的時候，如果package沒有載入，則載入package）。

每個服務默認以類型的名字作為服務名，當然也可以通過設置這個attribute的ServiceName屬性來更改服務名。

第三步：添加初始化程式碼

我們的package通過ProvideServiceAttribute使外面的事件知道它的服務的存在，但是為了服務實例能被創建，我們還得添加一些初始化程式碼才行。這段程式碼最好放在package的構造函數里：

public sealed class StartupToolsetRefactoredPackage : Package{  public StartupToolsetRefactoredPackage()  {    IServiceContainer serviceContainer = this;    ServiceCreatorCallback creationCallback = CreateService;    serviceContainer.AddService(typeof(SCalculationService),       creationCallback, true);  }  ...}

Package類顯示地實現了IServiceContainer介面，是沒有公開的AddService方法的，所以我們必須把this轉換成IServiceContainer類型的對象。AddService方法有很多重載，我們用其中的接受3個參數的那個：要添加的服務的類型、當服務第一次調用時會被調用的回調方法、以及是否把這個服務傳遞給parent container的標記。我們把最後一個參數設成true，這樣就可以確保我們的服務可以被全局訪問。

使用服務

現在，所有其他package都可以用松耦合的方式來使用我們的計算服務了。但是我們在CalculationButton_Click方法里是直接實例化它的：

ICalculationService calcService = new CalculationService();string result;calcService.Calculate(FirstArgEdit.Text, SecondArgEdit.Text,                      OperatorCombo.Text, out result);

我們最好修改一下它，以便從IDE里得到服務實例：

private void CalculateButton_Click(object sender, EventArgs e){  ICalculationService calcService =     Package.GetGlobalService(typeof (SCalculationService)) as ICalculationService;  if (calcService != null)  {    string result;    calcService.Calculate(FirstArgEdit.Text, SecondArgEdit.Text,                          OperatorCombo.Text, out result);    ResultEdit.Text = result;  }}

一些試驗

到目前為止，我們的package已經使用了我們創建的服務了。接下來，我建議你對程式碼做些臨時的改動，並看看我們的package會有什麼變化。

為了能夠清楚地看到這些變化，我建議你在CalculateButton_Click方法的最下面調用LogCalculationToOutput方法，這樣就可以看到我們的package在執行的時候輸出來的調試資訊：

private void CalculateButton_Click(object sender, EventArgs e){  ...  LogCalculationToOutput(FirstArgEdit.Text, SecondArgEdit.Text,     OperatorCombo.Text, ResultEdit.Text);}

我們將對程式碼做些小的改動，並且每次改動都會使我們的服務不可用：當我們需要得到這個服務的實例的時候，我們只能得到空引用。在這個過程中不會有任何錯誤提示，但是在output窗口裡，我們可以發現這個服務不會正常工作。例如，如果我們想計算「1+2」，我們期待在output窗口中能看到「1 + 2 = 3」，但是我們只能看到「1 + 2 = 」。

我強烈建議你做這一下這些改動，並檢查改動後的結果，因為服務開發者經常會犯類似的錯誤，並且不知道錯在哪了。所以，求你了，做一下下面的試驗（每次試驗完要記得「undo」這一次的修改）。

試驗1：在CalculationService類聲明那裡，注釋掉對SCalculationService介面的實現

public sealed class CalculationService: ICalculationService   // , SCalculationService{  public bool Calculate(string firstArgText, string secondArgText,     string operatorText, out string resultText)  { ... }}

package照樣可以編譯通過，但是這個服務對象是沒法被創建的。因為當我們調用GetService方法的時候，這個方法認為返回的服務對象能夠轉換成參數里指定的類型。在我們的例子中我們是通過GetService(typeof(SCalculationService))調用的，但返回的CalculationService類的實例是不能夠轉換成SCalculationService類型的，因為它並沒有實現SCalculationService介面。

試驗2：在調用AddService方法時，把最後一個參數從true改成false

public StartupToolsetRefactoredPackage(){  IServiceContainer serviceContainer = this;  ServiceCreatorCallback creationCallback = CreateService;  serviceContainer.AddService(typeof(SCalculationService), creationCallback,    false);}

這樣改後，我們也得不到服務的實例了，這是因為Package.GetGlobalService方法找的是所有公開給VS IDE的服務，但是我們把AddService的最後一個參數改成false之後，我們的服務就不是公開的了。

用本地的方式使用服務

到目前為止我們都是通過調用Package.GetGlobalService方法來得到服務實例的，看起來像是這個服務是別的package而不是我們的package提供的。其實，我們可以用GetService方法：

private void CalculateButton_Click(object sender, EventArgs e){  ICalculationService calcService =     GetService(typeof (SCalculationService)) as ICalculationService;  ...}

這樣改動後，我們的package照樣運行正常！但是這個GetService方法是從哪裡來的呢？CalculateControl用戶控制項和我們的package沒有直接的聯繫，它繼承自UserControl類，UserControl又繼承自System.ComponentModel.Component，而這個類實現了IServiceProvider介面，還記得不，這個介面定義了GetService方法！但是，屬於用戶控制項的GetService方法是怎麼知道我們的package會提供這個服務的？我們並沒有在這個用戶控制項里直接引用package啊。

原因就是VS IDE的Siting機制。當我們的package載入到IDE的時候，它被site了，並且得到了一個parent IServiceProvider；當我們的工具窗里的用戶控制項載入到記憶體的時候，這個控制項也被site到工具窗中，所以也會有一個parent IServiceProvider，這兩個service provider是同一個對象。用戶控制項的GetService方法在執行的時候，會查找整個IServiceProvider鏈。在這個鏈中，它會調用到我們的package的GetService方法並最終得到這個服務對象。這是一種本地訪問服務的方式。如果注釋掉package上附加的ProvideService屬性的話（譯者註：僅注釋掉是不夠的，要卸載package然後再註冊），我們的package也可以正常運行，但是這個服務就不再是一個全局服務了，別的package不一定能夠再使用它。（譯者註：在別的package請求這個服務時，無法知道這個服務在哪個package內，所以也就無法使用這個服務，但是如果我們的package已經載入了，那麼別的package依然可以得到這個服務，因為在我們package的構造函數里，我們把這個服務加到了parent service container里）

總結

原來的StartupToolset里的計算邏輯是耦合在工具窗的用戶控制項里的，在這篇文章里，我們把這段邏輯抽了出來做成了一個全局服務。為創建這個服務，我們在一個單獨的程式集里添加了兩個介面：

  1. 服務介面聲明了服務的功能（契約）。
  2. 標記類型（無成員的介面）被用作GetService的參數。

在package項目中，我們添加了一個服務實現類，實現了服務介面和標記介面，並探討了服務的機制和使服務能被全局訪問的步驟。我們的服務實例在第一次被請求時才會創建。另外，我們還知道了怎樣以全局和本地的方法來訪問服務。

在下一篇里，我們繼續重構這個package，並創建可重用的程式碼。

原文鏈接：http://dotneteers.net/blogs/divedeeper/archive/2008/01/31/LearnVSXNow9.aspx

到這裡這篇譯文就已經結束了，但我還想再多說明一些東西：

1。服務一定需要定義成介面嗎？

如果單單從技術上來看，服務不一定非得需要介面。為了說明這一點，我們在StartupToolsetInterfaces項目里添加一個MyServiceClass.cs文件，並添加如下程式碼：

public class MyServiceClass{    public int Caculate(int i)    {        return i*i;    }}

然後用這篇譯文里的方法添加ProvideService、回調方法，並在package的構造函數里調用AddService。然後，新建一個帶菜單項的package，並添加對StartupToolsetInterfaces的引用，然後在菜單項的事件處理方法里，添加如下程式碼：

MyServiceClass myService = GetService(typeof(MyServiceClass)) as MyServiceClass;if (myService != null){    MessageBox.Show(myService.Caculate(3).ToString());}

運行起來後，點擊這個package的菜單，是不是彈出了一個消息框，並顯示9？所以，服務不一定非得用介面，但用介面會更好，可以使結構更好，又或者可以使非託管程式碼可以訪問這個服務（我並沒有驗證過）。

2。服務的GUID是幹什麼用的？

在上面這個示例服務MyService里，我們並沒有給他加GUID，但原文作者給出的例子卻加了GUID，那麼這個GUID是幹嘛用的呢？其實，GUID無非就是標識這個服務而已。然後打開註冊表，在HKEY_CURRENT_USERSoftwareMicrosoftVisualStudio9.0ExpConfigurationServices下面就可以找到這個GUID，是ProvideService這個attribute指定的SCalculationService介面的GUID。如果沒有給它加GUID，regpkg在註冊的時候，會自動產生一個GUID，所以，一般情況下也不用給服務指定GUID。

但在某些情況下，這個GUID還是有用的。比如由於某種原因，我們的package不能夠引用StartupToolsetInterfaces項目，但是在package里又想用它的service，我們就可以在package項目里加一個介面或類（該介面或類可以是空的），然後給他一個GUID，GUID的值是StartupToolsetInterfaces里的SCalculationService的GUID：

[Guid("AF7F72EF-2B54-4798-B76A-21DC02CC04B7")]class MyService{ //空的   }

然後把自己定義的這個介面類型傳給GetService方法，這樣就照樣可以得到這個服務的實例（是一個object類型的），然後通過反射來調用它的方法了。 

object service = GetService(typeof(MyService));if(service != null){    //反射調用其方法}

當然，通過反射來調用看起來很怪，應該有其他方式可以用「強類型」的方式使用這個服務，例如像使用COM對象那樣，定義interop類型，但我缺少這方面的知識，所以沒有去驗證怎樣使用。

Tags:

VirMach 便宜 VPS