共用方式為

WCF 測試用戶端 (WcfTestClient.exe)

  • 發行項

Windows Communication Foundation (WCF) 測試用戶端 (WcfTestClient.exe) 是一種 GUI 工具，可以讓使用者用來輸入測試參數、將該輸入送出至服務，以及檢視服務傳回的回應。 與 WCF 服務主機搭配時，可以提供順暢無礙的服務測試經驗。

您通常會在下列位置找到 WCF 測試用戶端 (WcfTestClient.exe)：C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\Common7\IDE - 社群可能是 "Enterprise"、"Professional" 或 "Community" 的其中一個，視已安裝的 Visual Studio 層級而定。

使用測試用戶端的案例

下列各節將討論一些可使用 WCF 測試用戶端簡化開發程序的最常見案例。

在 Visual Studio 內部

WCF 服務主機啟動具有單一服務的 WCF 測試用戶端

在您建立新的 WCF 服務專案並按下 F5 啟動偵錯工具之後，WCF 服務主機會開始裝載專案中的服務。 然後，WCF 測試用戶端便會開啟，並顯示組態檔中定義之服務端點的清單。 您可以測試參數並叫用服務，然後重複這個程序以持續測試及驗證服務。

WCF 服務主機啟動具有多個服務的 WCF 測試用戶端

您也可以使用 WCF 測試用戶端協助偵錯包含多個服務的服務專案。 當 WCF 測試用戶端開啟時，它會自動在您的專案中逐一查看服務清單，並開啟這些服務以進行測試。

在 Visual Studio 外部

您也可以在 Visual Studio 外部叫用 WCF 測試用戶端 (WcfTestClient.exe)，測試網際網路上的任意服務。 若要找出該工具，請移至下列位置：

C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\Common7\IDE (其中社群可能是 "Enterprise"、"Professional" 或 "Community" 的其中一個，視機器上安裝的 Visual Studio 層級而定)

若要使用該工具，按兩下檔名即可從這個位置開啟，或者是從命令列進行啟動。

WCF 測試用戶端可以採用任意數目的 URI 做為命令列引數。 這些引數是可以測試的服務 URI。

wcfTestClient.exe URI1 URI2 …

開啟 [WCF 測試用戶端] 視窗後，按一下 [檔案] -> [新增服務]，並輸入要開啟服務的端點位址。

WCF 測試用戶端使用者介面

您可以搭配單一服務或多個服務使用 WCF 測試用戶端。

服務作業

WCF 測試用戶端主視窗的左窗格會列出所有可用的服務，以及它們各自的端點和作業。

按兩下某項作業時，您可以在右窗格中具有該作業名稱的新索引標籤內，檢視其內容。

左窗格還會列出用戶端組態檔。 按兩下任何項目，即可在右窗格中新出現的索引視窗上看見檔案的內容。

輸入測試參數

若要檢視測試參數，請按兩下作業，在右窗格中開啟它。 參數預設會在 [已格式化] 檢視中顯示，您可以為參數輸入任意值來測試服務。

若要檢視訊息的 XML，請按一下 [XML]。 若要將參數傳送至服務，請按一下 [叫用]。

對於 DataSet 參數，請按一下 [編輯...] 旁的 […] 按鈕，在顯示 DataGrid 的新視窗中編輯參數。 請注意 [複製資料集] 和 [貼上資料集] 按鈕的外觀。 如果在第一次編輯時 DataSet 物件的結構描述為未知，DataGrid 為空白。 您必須將具有相同結構描述的 DataSet 物件貼入 DataGrid 中的目前物件 (請注意，您必須在貼上作業前從其他地方複製結構描述)。您也可以按一下 [複製資料集] 按鈕，複製 DataSet 物件供未來使用。

服務的回應會出現在測試參數下方。

注意

如果預期的傳回值是字串，則結果會顯示為引號括住的字串，即使提供的輸入並未以引號括住。

如果您在建立服務合約時將特定作業指定為單向，就不會顯示任何服務回應。 訊息一旦排入佇列中準備傳遞，快顯對話方塊就會出現，通知您已成功傳送訊息。

工作階段支援

服務作業索引標籤中的 [啟動新 Proxy] 核取方塊，可以讓您切換工作階段支援。 這個方塊預設為清除。

在針對特定作業 (或是相同服務端點中的其他作業) 輸入測試參數時，並在清除該核取方塊的情況下多次按下 [叫用]，則這些作業會共用一個 Proxy，並且會在多個作業間保存服務狀態。

如果有核取 [啟動新 Proxy] 核取方塊，則會針對每個 [叫用] 啟動新的 Proxy，稍早的工作階段會結束並重設服務狀態。

編輯用戶端組態

WCF 測試用戶端主視窗的左窗格會列出用戶端組態檔。 按兩下任何項目，即可在右窗格中顯示檔案的內容。

使用服務組態編輯器進行編輯

以滑鼠右鍵按一下左窗格中的 [組態檔]，並選取操作功能表 [使用 SvcConfigEditor 編輯]。 服務組態編輯器隨即啟動，並顯示用戶端組態內容。 您可以在該工具內編輯組態並進行儲存。

在服務組態編輯器中儲存檔案後，WCF 測試用戶端會顯示警告訊息，通知您檔案已在外部經過修改並詢問您是否要重新載入。

如果選取 [是]，[Client.dll.config] 索引標籤中的組態內容會反映出您在編輯器中進行的變更。

如果選取 [否]，[Client.dll.config] 索引標籤中的組態內容會維持不變，而修改過的內容會自動儲存到原始程式檔中。

還原至預設組態

如果要取消所有變更並還原為預設用戶端組態，以滑鼠右鍵按一下左窗格中的 [組態檔]，並選取操作功能表 [還原至預設組態]。預設組態值隨即載入，並會還原「Client.dll.config」索引標籤中的內容。

驗證變更

在 WCF 測試用戶端中載入儲存的變更時，會針對 WCF 結構描述檢查組態是否有效。 如果發現錯誤，會顯示對話方塊說明錯誤詳細資料。

在 Proxy 產生、二進位編譯或服務叫用期間，會停用支援編輯 (也就是 [編輯…]、[還原…] 等等) 的功能表項目。 將更新過的組態載入至 WCF 測試用戶端時，也會停用服務叫用。

保存用戶端組態

[工具] -> [選項] -> [用戶端組態] 索引標籤包含預設為啟用的 [啟動服務時永遠重新產生組態] 選項。 這個選項表示每當 WCF 測試用戶端載入服務時，會依據最新的服務合約和服務 App.config 檔案，重新產生組態檔。

如果您已經編輯過 WCF 服務的用戶端組態，並想要永遠使用這個更新檔來偵錯服務，您可以取消核取 [重新產生] 選項。 如此一來，即使在您更新服務並重新開啟 WCF 測試用戶端時，Client.dll.config 檔案仍然是您先前更新過的檔案，而非依據更新服務所重新產生的檔案。

但是，您可能需要編輯組態檔，讓其跟重新產生的 Proxy 一致。 如果重新產生的 Proxy 和組態檔因更新服務而不相符，則在叫用服務時將發生錯誤。

警告

如果您修改過用戶端組態檔並選擇供往後重複使用，則可以在下列位置找到該檔案：

\Documents and Settings\[User Account]\My Documents\Test Client Projects。

任何儲存在用戶端組態檔中經過更新的認證資訊，皆受到這個資料夾的存取控制清單 (ACL) 所保護。

新增、移除和重新整理服務

新增服務

按一下 [檔案]->[新增服務] 將服務新增至 WCF 測試用戶端。 接著會要求您輸入要新增之服務的 URI (端點位址)。 服務位址可以是 Mex 位址或 WSDL 位址。

您也可以在 [最近使用的服務] 子功能表中，找到 10 個最近新增的服務端點清單。 如果選取其中一個服務，該指定服務就會加入到 WCF 測試用戶端中。

您也可以滑鼠右鍵按一下服務樹狀目錄 [我的服務專案] 的根，並選取 [新增服務]，以達成相同結果。

在 Proxy 產生、二進位編譯或服務叫用期間，會停用支援新增服務的功能表項目。 同時也會停用服務叫用。

移除服務

以滑鼠右鍵按一下要移除之服務的服務根，並選取 [移除服務]，即可從 WCF 測試用戶端移除服務。

在 Proxy 產生、二進位編譯或服務叫用期間，會停用支援移除服務的功能表項目。 同時也會停用服務叫用。

重新整理服務

如果在 WCF 測試用戶端執行當中變更過服務，而您想要確認該服務的 WCF 測試用戶端實作是最新的，請以滑鼠右鍵按一下服務的服務根，並選取 [重新整理服務]。 請注意，重新整理後會重設服務狀態。

在 Proxy 產生、二進位編譯或服務叫用期間，會停用支援重新整理服務的功能表項目。 同時也會停用服務叫用。

測試用戶端產生的檔案位置

根據預設，WCF 測試用戶端會將產生的用戶端程式碼和組態檔儲存在 "%appdata%\Local\temp\Test Client Projects" 資料夾。 在 WCF 測試用戶端結束後，便會刪除這個資料夾。 如果在 WCF 測試用戶端中修改組態檔，並且是在停用 [啟動服務時永遠重新產生組態] 選項的情況下，修改過的檔案會複製到 "My Documents\Test Client Projects" 下的 "CachedConfig" 資料夾，並會有對應的 (metadata-address-to-file-name) XML 檔案做為索引。

您也可以在命令列啟動 WCF 測試用戶端，使用 /ProjectPath 參數指定用於儲存產生檔案的新目標路徑，或是使用 /RestoreProjectPath 參數還原預設位置。 語法如下所示：

wcfTestClient.exe /ProjectPath [desired location]

執行這個命令並不會開啟 WCF 測試用戶端。 只是會變更資料夾位置。 不論 WCF 測試用戶端是否正在執行，都可以執行這個命令。 新的位置會在重新啟動 WCF 測試用戶端時套用。 有關位置的資訊可以儲存在登錄中，或者是 "%appdata%\Local\temp\Test Client Projects" 資料夾的 "WcfTestClient.exe.option" 檔案中。

WCF 測試用戶端支援的功能

下列為 WCF 測試用戶端支援的功能清單：

  • 服務叫用：要求/回應和單向訊息。

  • 繫結：Svcutil.exe 支援的所有繫結。

  • 控制工作階段。

  • 訊息合約。

  • XML 序列化。

下列為 WCF 測試用戶端不支援的功能清單：

關閉 WCF 測試用戶端

您可以透過下列方式關閉 WCF 測試用戶端：

  • 在 [檔案] 功能表上按一下 [結束] 。 或者，在 WCF 測試用戶端主視窗中按一下 [關閉]。 如果 WCF 測試用戶端是由 Visual Studio 啟動的，這兩個動作也會關閉 WCF 服務自動主機並停止 Visual Studio 偵錯程序。

  • 以滑鼠右鍵按一下通知區域中的 [WCF 服務主機] 圖示，然後按一下 [結束]。這會同時關閉 WCF 服務自動主機和 WCF 測試用戶端，並且停止 Visual Studio 偵錯程序。

另請參閱