Инструмент языка описания веб-служб (Wsdl.exe)

Этот раздел посвящен технологии прежних версий. Веб-службы XML и клиенты веб-служб XML должны создаваться с использованием Windows Communication Foundation.

Инструмент языка описания веб-служб создает код для XML-веб-служб и их клиентов из файлов контрактов WSDL, схем XSD и документов обнаружения DISCOMAP.

Примечание
Программа WSDL.exe может создавать классы с именами вида «@string». Это допустимые имена типов, в которых префикс @ используется, чтобы разрешить использование имен, содержащих ключевые слова C#.

wsdl [options] {URL | path}

Замечания

Аргумент	Описание
URL	URL-адрес файла контракта WSDL, файла схемы XSD или документа обнаружения DISCO. Обратите внимание, что нельзя указать URL-адрес документа обнаружения .discomap.
Path	Путь к локальному файлу контракта WSDL, файлу схемы XSD или документу обнаружения DISCO или DISCOMAP. Примечание Wsdl.exe не извлекает включения и импорты из сети, если задан локальный файл. Чтобы разрешить программе Wsdl.exe извлекать сетевые ресурсы при обработке локального файла, передайте URL-адрес в локальный файл. Например, следующий файл извлекает необходимые ресурсы из сети: wsdl File:///E:/Customers/WSDLS/Accounts.wsdl /out:proxy.cs

Файл WSDL — это документ XML, составленный согласно XML-грамматике, называемой языком описания веб-служб (WSDL). Этот файл определяет поведение XML-веб-службы и указывает клиентам правила взаимодействия с ней.

Документы обнаружения для XML-веб-службы можно получить с помощью программы Инструмент для обнаружения веб-служб (Disco.exe). Файлы DISCOMAP, DISCO, WSDL и XSD, созданные этой программой, можно использовать в качестве входных данных для программы Wsdl.exe.

При создании прокси-класса с помощью программы Wsdl.exe создается один исходный файл на указанном языке программирования. При генерировании исходного кода для прокси-класса программа определяет, какой тип лучше использовать для объектов, указанных в описании службы. В некоторых случаях при приведении объектов к типу используется "принцип наименьшего общего знаменателя". В результате созданный тип в прокси-классе может отличаться от требуемого или ожидаемого разработчиком. Например, когда программа WSDL.exe встречает в описании службы тип ArrayList, в генерируемом прокси-классе создается массив Object Array. Чтобы обеспечить правильное приведение типов объектов, откройте файл, содержащий сгенерированный прокси-класс, и измените все неправильные типы объектов на ожидаемые типы.

• Параметр /parameters указывает файл, содержащий элементы, соответствующие многим параметрам командной строки. Некоторые параметры командной строки доступны только в формате файла /parameters.

Формат файла XML, поддерживаемый параметром /parameters, — это набор элементов, заключенных во внешний элемент <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-веб-службы.

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

Следующая команда создает клиентский прокси-класс на языке C# для XML-веб-службы, находящейся по указанному URL-адресу. Программа сохраняет клиентский прокси-класс в файле myProxyClass.cs.

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

Следующая команда создает клиентский прокси-класс на языке Microsoft Visual Basic для XML-веб-службы, находящейся по указанному URL-адресу. Программа сохраняет клиентский прокси-класс в файле myProxyClass.vb.

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

В следующем примере кода показан простейший WSDL-файл /parameters, содержащий только требуемые элементы. Его можно использовать в командной строке в сочетании с аргументом URL.

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

WSDL-документы добавляются в WSDL-файл /parameters с помощью элемента <documents>, как показано в следующем примере кода. Элемент <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>

В следующем WSDL-файле /parameters показано использование элементов <codeGenerationOptions> и <style>, содержащихся в элементе <webReferenceOptions>. В этом случае файл включает новый стиль привязки данных в коде прокси, предписывает расширению импортера схемы не выводить подробную выходную информацию, а программе Wsdl.exe — создать клиентский прокси-класс.

<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>

См. также

Справочник

Инструмент для обнаружения веб-служб (Disco.exe)

Основные понятия

Создание прокси-класса XML-веб-службы
Описание XML-веб-службы
Общие сведения об XML-веб-службах

Другие ресурсы

.NET Framework Tools
SDK Command Prompt