Web 服務描述語言工具 (Wsdl.exe)

本主題專門說明舊有技術。 應該使用下列建立 XML Web Service 及 XML Web Service 用戶端： Windows Communication Foundation.

Web 服務描述語言工具會從 WSDL 合約檔案、XSD 結構描述 (Schema) 和 .discomap 探索文件產生 XML Web Service 和 XML Web Service 用戶端的程式碼。

注意：
WSDL.exe 可能產生名稱類似 “@string” 的類別。這些是有效的型別名稱，使用 ‘@’ 前置字元允許包含 C# 關鍵字的型別名稱。

wsdl [options] {URL | path}

備註

引數	說明
URL	WSDL 約定檔案 (.wsdl)、XSD 結構描述檔案 (.xsd) 或探索文件 (.disco) 的 URL。請注意，您不能指定 .discomap 探索文件的 URL。
路徑	本機 WSDL 合約檔案 (.wsdl)、XSD 結構描述檔案 (.xsd) 或探索文件 (.disco 或 .discomap) 的路徑。 注意： 提供本機檔案時，Wsdl.exe 不會從網路擷取 Include 和 Import。若要讓 Wsdl.exe 在處理本機檔案時能擷取網路資源，請將 URL 傳遞至本機檔案。例如，下列檔案會使用網路來擷取必要資源： wsdl File:///E:/Customers/WSDLS/Accounts.wsdl /out:proxy.cs

.wsdl 檔案是以稱為 Web 服務描述語言 (WSDL) 的 XML 文法所撰寫的 XML 文件。這個檔案定義了 XML Web Service 的行為，並且指示用戶端如何與該服務互動。

您可以使用 Web 服務探索工具 (Disco.exe) 來取得 XML Web Service 的探索文件。由這個工具所產生的 .discomap、.disco、.wsdl 和 .xsd 檔案可以用作 Wsdl.exe 的輸入。

使用 Wsdl.exe 建立 Proxy 類別時，會以您所指定的程式設計語言建立單一資源檔。在為 Proxy 類別產生原始程式碼的過程中，工具會決定要對服務描述中所指定的物件使用的最佳型別。在某些情況下，工具會使用最小公因數的方法，將物件轉換為某個型別。因此，Proxy 類別中產生的型別可能會和開發人員想要或預期的不同。例如，當 Wsdl.exe 在服務描述中遇到 ArrayList 型別時，它會在產生的 Proxy 類別中建立 Object Array。若要確定正確的物件型別轉換 (Type Cast)，請開啟包含產生之 Proxy 類別的檔案，並將所有不正確的物件型別變更為預期的物件型別。

• / parameters 選項所指定的檔案，其中包含的項目會與大多數命令提示字元選項對應。有些命令提示字元選項只能在 /parameters 檔案格式中使用。

/ parameters 選項接受的 XML 檔案格式是外部 <wsdlParameters xmlns="https://microsoft.com/webReference/"> 項目內一連串的項目。如果已指定命令提示字元值而且使用了含有不同選項或值的 /parameters 檔案，則會使用命令提示字元中指定的值。<wsdlParameters xmlns="https://microsoft.com/webReference/"> 項目必須包含 <nologo> 項目、<parsableerrors> 項目和 <sharetypes> 項目。

有些選項會當做 <webReferenceOptions> 項目的子項目傳遞，此項目必須包含 <verbose> 項目。其他 <webReferenceOptions> 子項目為：

• <style>. 包含 "client"、"server" 或 "serverInterface"。

• <schemaImporterExtension>. 包含任意數量的 <type> 項目。

• <codeGenerationOptions>. 可以採用下列字串的空白分隔設定。

• "properties"

• "newAsync"

• "oldAsync"

• "order"

• "enableDataBinding"

如需 /parameters 選項的示範，請參閱下面的＜範例＞一節。

範例

下列命令會在 C# 語言中建立 XML Web Service 的用戶端 Proxy 類別。

wsdl http://hostServer/WebserviceRoot/WebServiceName.asmx?WSDL

以下命令會以 C# 語言，對位於指定 URL 的 XML Web Service 建立用戶端 Proxy 類別。工具會將用戶端 Proxy 類別儲存在 myProxyClass.cs 檔案中。

wsdl /out:myProxyClass.cs http://hostServer/WebserviceRoot/WebServiceName.asmx?WSDL

以下命令會以 Microsoft Visual Basic 語言，對位於指定 URL 的 XML Web Service 建立用戶端 Proxy 類別。工具會將用戶端 Proxy 類別儲存在 myProxyClass.vb 檔案中。

wsdl /language:VB /out:myProxyClass.vb http://hostServer/WebserviceRoot/WebServiceName.asmx?WSDL

下列程式碼範例會顯示基本 /parameters WSDL 檔案，其中僅具有必要寫入的項目，而這些項目可以在命令提示字元中與 URL 引數組合使用。

<wsdlParameters xmlns="https://microsoft.com/webReference/">
  <nologo>true</nologo>
  <parsableerrors>true</parsableerrors>
  <sharetypes>true</sharetypes>
</wsdlParameters>

使用 <documents> 項目在 /parameters WSDL 檔案中加入 WSDL 文件，如下列程式碼範例所示。可在 <documents> 項目中使用任何數目的 <document> 項目。

<wsdlParameters xmlns="https://microsoft.com/webReference/">
  <nologo>true</nologo>
  <parsableerrors>true</parsableerrors>
  <sharetypes>true</sharetypes>
  <documents>
    <document>https://www.contoso.com/service.asmx?WSDL</document>
  </documents>
</wsdlParameters>

下列 /parameters WSDL 檔案會示範 <webReferenceOptions> 項目內，使用 <codeGenerationOptions> 和 <style> 項目的方法。在此情況下，檔案可允許在 Proxy 程式碼中的新樣式資料繫結，並指定輸出並非詳細資訊且 Wsdl.exe 會用來建立用戶端 Proxy 的結構描述擴充匯入工具。

<wsdlParameters xmlns="https://microsoft.com/webReference/">
  <nologo>true</nologo>
  <parsableerrors>true</parsableerrors>
  <sharetypes>true</sharetypes>
  <documents>
    <document>https://www.contoso.com/service.asmx?WSDL</document>
  </documents>
  <webReferenceOptions>
    <verbose>false</verbose>
    <codeGenerationOptions>properties newAsync enableDataBinding</codeGenerationOptions>
    <schemaImporterExtension>
      <type>MyNamespace.MyCustomImporterExtension,ExtensionLibrary</type>
    </schemaImporterExtensions>
    <style>client</style>
  </webReferenceOptions>
</wsdlParameters>

另請參閱

參考

Web 服務探索工具 (Disco.exe)

概念

建立 XML Web Service Proxy
XML Web Service 描述
XML Web Service 概觀

其他資源

.NET Framework Tools
SDK Command Prompt