利用 COM 用戶端使用 WCF Moniker

發行項
09/12/2008

這個範例會示範如何使用 Windows Communication Foundation (WCF) 服務 Moniker，以將 Web 服務整合至 COM 開發環境，例如 Microsoft Office Visual Basic for Applications (Office VBA) 或 Visual Basic 6.0。這個範例由 Windows Script Host 用戶端 (.vbs)、支援的用戶端程式庫 (.dll) 和網際網路資訊服務 (IIS) 裝載的服務程式庫 (.dll) 所組成。服務為計算機服務，而 COM 用戶端會呼叫服務上的數學作業：加法、減法、乘法和除法。您可以在訊息方塊視窗中看到用戶端活動。

注意：
此範例的安裝程序與建置指示位於本主題的結尾。

服務會實作如下列程式碼所定義的 ICalculator 合約：

[ServiceContract(Namespace="http://Microsoft.ServiceModel.Samples")]
public interface ICalculator
{
    [OperationContract]
    double Add(double n1, double n2);
    [OperationContract]
    double Subtract(double n1, double n2);
    [OperationContract]
    double Multiply(double n1, double n2);
    [OperationContract]
    double Divide(double n1, double n2);
}

此範例會示範使用 Moniker 的三個替代方法：

型別合約：合約會在用戶端機器上註冊為 COM 可見型別。
WSDL 合約：合約會以 WSDL 文件的形式提供。
中繼資料交換合約：會在執行階段從中繼資料交換 (MEX) 端點擷取合約。

型別合約

若要搭配使用 Moniker 和型別合約，必須使用 COM 適當地註冊服務合約的屬性化型別。首先，必須使用Service Model Metadata Utility Tool (Svcutil.exe) 產生用戶端。您可以從用戶端目錄中的命令提示字元執行下列命令，以產生具型別的 Proxy：

svcutil.exe /n:http://Microsoft.ServiceModel.Samples,Microsoft.ServiceModel.Samples https://localhost/servicemodelsamples/service.svc /out:generatedClient.cs

這個類別必須包含在專案中，並且專案應該設定為在進行編譯時，產生 COM 可見的簽署組件。下列屬性應該包含在 AssemblyInfo.cs 檔中：

[assembly: ComVisible(true)]

建置專案之後，請使用 regasm 註冊 COM 可見的型別：

regasm.exe /tlb:CalcProxy.tlb client.dll

建立的組件則應該新增至全域組件快取中。這樣可簡化執行階段尋找組件的程序，不過這不是十分必要的動作。下列命令會將組件新增至全域組件快取：

gacutil.exe /i client.dll

注意：
服務 Moniker 只需要型別註冊，而不會使用 Proxy 與服務進行通訊。

ComCalcClient.vbs 用戶端應用程式會使用 GetObject 函式以建構服務的 Proxy，進而使用服務 Moniker 語法來指定服務的位址、繫結和合約。

Set typedServiceMoniker = GetObject(
"service:address=https://localhost/ServiceModelSamples/service.svc, binding=wsHttpBinding, 
contractType={9213C6D2-5A6F-3D26-839B-3BA9B82228D3}")

Moniker 所使用的參數會指定：

服務端點的位址。
用戶端應該用來連接該端點的繫結。在此情況下，雖然可以在用戶端組態檔中定義自訂繫結，仍會使用系統定義的 wsHttpBinding。若要與 Windows Script Host 搭配使用，可在與 Cscript.exe 相同目錄的 Cscript.exe.config 檔中定義自訂繫結。
端點所支援的合約型別。這是上面所產生及註冊的型別。由於 Visual Basic 指令碼不支援強型別 COM 環境，因此，必須為合約指定識別碼。此 GUID 是取自 CalcProxy.tlb 的 interfaceID，您可以使用 OLE/COM 物件檢視器 (OleView.exe) 這類 COM 工作來檢視 CalcProxy.tlb。針對 Office VBA 或 Visual Basic 6.0 這類強型別，將明確參考新增至型別程式庫，然後宣告 Proxy 物件的型別，這個動作可用來代替合約參數。此動作在應用程式開發期間也會提供 IntelliSense 支援。

使用服務 Moniker 建構 Proxy 執行個體完畢之後，用戶端應用程式就可以針對 Proxy 呼叫方法，使服務 Moniker 基礎結構呼叫對應的服務作業：

' Call the service operations using the moniker object
WScript.Echo "Typed service moniker: 100 + 15.99 = " & typedServiceMoniker.Add(100, 15.99)

當您執行範例時，作業回應會顯示在 Windows Script Host 訊息方塊視窗中。這將示範使用具型別 Moniker 進行 COM 呼叫，以與 WCF 服務通訊的 COM 用戶端。就算在用戶端應用程式中使用 COM，服務通訊只能包含 Web 服務呼叫。

WSDL 合約

若要搭配使用 Moniker 和 WSDL 合約，您不需要用戶端程式庫註冊，但必須透過超出範圍之外的機制擷取服務的 WSDL 合約，例如使用瀏覽器存取服務的 WSDL 端點。Moniker 接著可在執行階段存取該合約。

ComCalcClient.vbs 用戶端應用程式會使用 FileSystemObject 來存取在本機儲存的 WSDL 檔，然後再次使用 GetObject 函式來建構服務的 Proxy：

' Open the WSDL contract file and read it all into the wsdlContract string
Const ForReading = 1
Set objFSO = CreateObject("Scripting.FileSystemObject")
Set objFile = objFSO.OpenTextFile("serviceWsdl.xml", ForReading)
wsdlContract = objFile.ReadAll
objFile.Close

' Create a string for the service moniker including the content of the WSDL contract file
wsdlMonikerString = "service:address='https://localhost/ServiceModelSamples/service.svc'"
wsdlMonikerString = wsdlMonikerString + ", binding=WSHttpBinding_ICalculator, bindingNamespace='http://Microsoft.ServiceModel.Samples'"
wsdlMonikerString = wsdlMonikerString + ", wsdl='" & wsdlContract & "'"
wsdlMonikerString = wsdlMonikerString + ", contract=ICalculator, contractNamespace='http://Microsoft.ServiceModel.Samples'"

' Create the service moniker object
Set wsdlServiceMoniker = GetObject(wsdlMonikerString)

Moniker 所使用的參數會指定：

服務端點的位址。
用戶端應該用來連接該端點的繫結，以及在其中定義該繫結的命名空間。在此情況中，會使用 wsHttpBinding_ICalculator。
定義合約的 WSDL。在此情況中，這是已從 serviceWsdl.xml 檔讀取的字串。

合約的名稱與命名空間。這是必要的識別，因為 WSDL 可能包含多個合約。

注意：
根據預設，WCF 服務會對每個命名空間產生不同的 WSDL 檔。而這些檔案則與使用 WSDL 匯入建構相連結。由於 Moniker 預期使用單一 WSDL 定義，服務必須如同本範例所示範使用單一命名空間，或必須以手動方式合併不同的檔案。

使用服務 Moniker 建構 Proxy 執行個體完畢之後，用戶端應用程式就可以針對 Proxy 呼叫方法，使服務 Moniker 基礎結構呼叫對應的服務作業：

' Call the service operations using the moniker object
WScript.Echo "WSDL service moniker: 145 - 76.54 = " & wsdlServiceMoniker.Subtract(145, 76.54)

當您執行範例時，作業回應會顯示在 Windows Script Host 訊息方塊視窗中。這將示範搭配使用 Moniker 和 WSDL 合約進行 COM 呼叫，以與 WCF 服務通訊的 COM 用戶端。

中繼資料交換合約

若要搭配使用 Moniker 和 MEX 合約，就如同搭配使用 WSDL 合約一樣，將不需要用戶端註冊。透過內部使用中繼資料交換，即可在執行階段擷取服務合約。

ComCalcClient.vbs 用戶端應用程式會再次使用 GetObject 函式來建構服務的 Proxy：

' Create a string for the service moniker specifying the address to retrieve the service metadata from
mexMonikerString = "service:mexAddress='https://localhost/servicemodelsamples/service.svc/mex'"
mexMonikerString = mexMonikerString + ", address='https://localhost/ServiceModelSamples/service.svc'"
mexMonikerString = mexMonikerString + ", binding=WSHttpBinding_ICalculator, bindingNamespace='http://Microsoft.ServiceModel.Samples'"
mexMonikerString = mexMonikerString + ", contract=ICalculator, contractNamespace='http://Microsoft.ServiceModel.Samples'"

' Create the service moniker object
Set mexServiceMoniker = GetObject(mexMonikerString)

Moniker 所使用的參數會指定：

服務中繼資料交換端點的位址。
服務端點的位址。
用戶端應該用來連接該端點的繫結，以及在其中定義該繫結的命名空間。在此情況中，會使用 wsHttpBinding_ICalculator。
合約的名稱與命名空間。這是必要的識別，因為 WSDL 可能包含多個合約。

使用服務 Moniker 建構 Proxy 執行個體完畢之後，用戶端應用程式就可以針對 Proxy 呼叫方法，使服務 Moniker 基礎結構呼叫對應的服務作業：

' Call the service operations using the moniker object
WScript.Echo "MEX service moniker: 9 * 81.25 = " & mexServiceMoniker.Multiply(9, 81.25)

當您執行範例時，作業回應將會顯示在 Windows Script Host 訊息方塊視窗中。這將示範搭配使用 Moniker 和 MEX 合約進行 COM 呼叫，以與 WCF 服務通訊的 COM 用戶端。

若要設定和建置範例

請確定您已執行 Windows Communication Foundation 範例的單次安裝程序。
若要建置方案的 C# 或 Visual Basic .NET 版本，請遵循建置 Windows Communication Foundation 範例中的指示。
從命令提示字元巡覽至語言特定資料夾下的 \client\bin 資料夾。如果使用 Windows Vista 或 Windows Server 2008，請務必使用系統管理員身分執行命令提示字元。
輸入 regasm.exe /tlb:CalcProxy.tlb client.dll，以向 COM 註冊型別。預期會出現「型別程式庫匯出工具警告」，但這不是很重要，因為不需要使用泛型型別。執行命令之前，請確定已將路徑設定為包含 regasm.exe 的資料夾。
輸入 gacutil.exe /i client.dll，將組件新增至全域組件快取。執行命令之前，請確定已將路徑設定為包含 gacutil.exe 的資料夾。

若要在同一部機器上執行範例

輸入下列位址，測試您是否可以使用瀏覽器存取服務：https://localhost/servicemodelsamples/service.svc。確認頁面應該會顯示在回應中。
在語言特定資料夾下的 \client 中，執行 ComCalcClient.vbs。用戶端活動會顯示在訊息方塊視窗中。
如果用戶端和服務無法通訊，請參閱疑難排解秘訣。

若要跨機器執行範例

在服務機器上，建立一個名稱為 ServiceModelSamples 的虛擬目錄。您可以使用範例隨附的 Setupvroot.bat 指令碼，建立磁碟目錄和虛擬目錄。
將服務程式檔案從 %SystemDrive%\Inetpub\wwwroot\servicemodelsamples 複製到服務機器上的 ServiceModelSamples 虛擬目錄。請務必將檔案放在 \bin 目錄中。
將語言特定資料夾下 \client 資料夾中的用戶端指令碼檔，複製至用戶端機器。
在指令碼檔中，變更端點定義的位址值以符合服務的新位址。以位址中的完整網域名稱取代 "localhost" 的任何參考。
在 WSDL 檔案 serviceWsdl.xml 中，在位址中以完整網域名稱取代 "localhost" 的任何參考。
將語言特定資料夾下 \client\bin 資料夾的 Client.dll 程式庫，複製至用戶端機器上的目錄。
從命令提示字元巡覽至用戶端機器上的目的目錄。如果使用 Windows Vista 或 Windows Server 2008，請務必使用系統管理員身分執行命令提示字元。
輸入 regasm.exe /tlb:CalcProxy.tlb client.dll，以向 COM 註冊型別。執行命令之前，請確定已將路徑設定為包含 regasm.exe 的資料夾。
輸入 gacutil.exe /i client.dll，將組件新增至全域組件快取。執行命令之前，請確定已將路徑設定為包含 gacutil.exe 的資料夾。
測試您是否能夠使用瀏覽器，從用戶端機器存取服務。
在用戶端機器上，啟動 ComCalcClient.vbs。

若要在使用範例之後進行清除

基於安全性目的，請在完成範例之後，移除虛擬目錄定義以及安裝步驟中所授與的權限。

共用方式為

利用 COM 用戶端使用 WCF Moniker

型別合約

WSDL 合約

中繼資料交換合約

若要設定和建置範例

若要在同一部機器上執行範例

若要跨機器執行範例

若要在使用範例之後進行清除

其他資源