Использование программы SvcUtil.exe

Типичные способы использования

В следующей таблице перечислены некоторые наиболее часто используемые параметры этого средства.

Создание кода

Svcutil.exe может создавать код для контрактов службы, клиентов и типы данных из документов метаданных. Документы метаданных могут находиться в устойчивом хранилище или извлекаться в оперативном режиме. Извлечение в оперативном режиме происходит либо по протоколу WS-Metadata Exchange, либо по протоколу DISCO (дополнительные сведения см. в разделе "Загрузка метаданных").

Можно использовать средство SvcUtil.exe для создания контрактов службы и данных, основанных на предопределенном документе WSDL. Используйте переключатель /serviceContract и укажите URL-адрес, откуда можно загрузить документ WSDL, или расположение файла, где его можно найти. Это создаст контракты службы и данных, определенные в документе WSDL, которые можно будет использовать для реализации службы жалобы. Дополнительные сведения см. вКак извлечь метаданные и реализовать совместимую службу.

Вместо этого для службы с конечной точкой BasicHttpContextbinding Svcutil.exe создает привязку BasicHttpBinding с атрибутом allowCookies с заданным значением true. Файлы cookie используются для создания контекста на сервере. Если необходимо управлять контекстом в клиенте при использовании службой файлов cookie, можно вручную изменить настройки для использования контекстной привязки.

Внимание

Svcutil.exe создает клиент на основе файла WSDL или файла политики, полученного от службы. Имя участника-пользователя (UPN) создается добавлением к имени пользователя символа "@" и полного доменного имени (FQDN). Однако для пользователей, зарегистрированных в Active Directory, этот формат не является допустимым, и созданное средством имя участника-пользователя вызывает сбой проверки подлинности Kerberos с выдачей сообщения об ошибке "Сбой попытки входа в систему". Чтобы устранить эту проблему, необходимо вручную исправить файл клиента, созданный средством.

svcutil.exe [/t:code] <metadataDocumentPath>* | <url>* | <epr>

Аргумент	Описание
epr	Путь к файлу XML, который содержит ссылку на конечную точку службы WS-Addressing EndpointReference, которая поддерживает WS-Metadata Exchange. Дополнительные сведения см. в разделе "Загрузка метаданных".
metadataDocumentPath	Путь к документу метаданных (wsdl или xsd), который содержит контракт для импортирования в код (.wsdl,.xsd,.wspolicy или.wsmex). Svcutil следит за ходом импортирования и включает удаленный URL-адрес для метаданных, когда указано пользователем. Однако если файлы метаданных необходимо обработать в локальной файловой системе, все файлы следует задавать в этом аргументе. Таким образом, Svcutil можно использовать в среде построения, где отсутствуют сетевые зависимости. Для этого аргумента можно использовать подстановочные знаки (например, XSD, WSDL).
url	URL-адрес конечной точки службы, предоставляющей метаданные, или документа метаданных, размещенного в сети. Дополнительные сведения об извлечении этих документов см. в разделе "Загрузка метаданных".
Параметр	Описание
/async	Создает сигнатуры как синхронных, так и асинхронных методов. По умолчанию: создает только сигнатуры синхронных методов. Сокращенная форма: /a
/collectionType:<тип>	Создает сигнатуры как синхронных, так и асинхронных методов. По умолчанию: создает только сигнатуры синхронных методов. Сокращенная форма: /a
/config:<файл_конфигурации>	Задает имя файла для создаваемого файла конфигурации. По умолчанию: output.config
/dataContractOnly	Создает код только для типов контрактов данных. Типы контрактов службы не созданы. Для этого параметра следует задавать только локальные файлы метаданных. Сокращенная форма: /dconly
/enableDataBinding	Реализует интерфейс INotifyPropertyChanged для всех типов контрактов данных для обеспечения привязки данных. Сокращенная форма: /edb
/excludeType:<тип>	Задает полное имя типа или имя типа с указанием на сборку, который необходимо исключить из ссылочных типов контракта. При использовании этого переключателя вместе с /r из отдельных библиотек DLL создается ссылка на полное имя класса XSD. Сокращенная форма: /et
/importXmlTypes	Служит для настройки сериализатора контракта данных для импортирования типов, отличных от типов контракта данных, в качестве типов IXmlSerializable.
/internal	Создает классы, помеченные как внутренние. По умолчанию: создает только открытые классы. Сокращенная форма: /i
/language:<язык>	Задает язык программирования, используемый для создания кода. Необходимо указать либо имя языка, зарегистрированное в файле Machine.config, либо полное имя класса, наследуемого от CodeDomProvider. Значения: c#, cs, csharp, vb, visualbasic, c++, cpp По умолчанию: csharp Сокращенная форма: /l Примечание Переключатель поддерживает только С++ для поставщика кода, который поставляется с Visual Studio 2005 SP1.
/mergeConfig	Объединяет созданную конфигурацию с существующим файлом (вместо перезаписи существующего файла).
/messageContract	Создает типы контрактов сообщений. Сокращенная форма: /mc
/namespace:<string,string>	Задает сопоставление атрибута targetNamespace WSDL или схемы XML пространству имен среды CLR. Использование подстановочного знака '*' для атрибута targetNamespace позволяет сопоставить все атрибуты targetNamespace без явного сопоставления пространству имен среды CLR. Чтобы убедиться, что имя контракта сообщения не конфликтует с именем операции, необходимо дополнить ссылку на тип двойными двоеточиями (::) или задать уникальные имена. По умолчанию: для контрактов данных выводится из целевого пространства имен документа схемы. Для всех остальных создаваемых типов используется пространство имен по умолчанию. Сокращенная форма: /n
/noConfig	Запрещает создавать файлы конфигурации.
/noStdLib	Запрещает ссылаться на стандартные библиотеки. По умолчанию: создаются ссылки на файлы Mscorlib.dll и System.servicemodel.dll.
/out:<файл>	Задает имя файла созданного кода. По умолчанию: наследуется от имени определения WSDL, имени службы WSDL или целевого пространства имен одной из схем. Сокращенная форма: /o
/reference:<путь к файлу>	Ссылается на типы в заданной сборке. При создании клиентов необходимо использовать этот параметр для задания сборок, которые могут содержать типы, представляющие импортируемые метаданные. С помощью этого переключателя невозможно задать контракты сообщений и типы XmlSerializer. При ссылке на DateTimeOffset вместо создания нового типа используется этот тип. Если приложение создано с использованием.NET Framework 3.5, SvcUtil.exe автоматически ссылается на DateTimeOffset. Сокращенная форма: /r
/serializable	Создает классы, помеченные сериализуемым атрибутом. Сокращенная форма: /s
/serviceContract	Сформировать код только для контрактов службы. Класс клиента и его конфигурация не будут сформированы. Сокращенная форма: /sc
/serializer:Auto	Создает классы, помеченные сериализуемым атрибутом. Сокращенная форма: /s
/serializer:DataContractSerializer	Создает типы данных, использующие сериализатор контракта данных для сериализации и десериализации. Сокращенная форма: /ser:DataContractSerializer
/serializer:XmlSerializer	Создает типы данных, использующие для сериализации и десериализации сериализатор XmlSerializer. Сокращенная форма: /ser:XmlSerializer
/targetClientVersion	Указывает, на какую версию.NET Framework нацелено приложение. Допустимые значения: Version30 и Version35. Значением по умолчанию является Version30. Сокращенная форма: /tcv Version30: при создании кода для клиентов, работающих с WinFX, следует использовать /tcv:Version30. Version35: при создании кода для клиентов, работающих с.NET Framework 3.5, следует использовать /tcv:Version35. При использовании /tcv:Version35 с переключателем /async создаются асинхронные методы как на основе событий, так и на основе обратных вызовов/делегатов. Кроме того, включена поддержка наборов данных с поддержкой LINQ и DateTimeOffset.
/wrapped	Определяет, используется ли особый подход для документов со стилем document-literal с параметрами в оболочке. Используйте ключ /wrapped со средством Служебное средство ServiceModel Metadata Utility Tool (Svcutil.exe) для указания обычного регистра.

Примечание

Если привязка службы предоставляется системой (см. раздел Привязки, предоставляемые системой) и свойству ProtectionLevel задано значение None или Sign, Svcutil создает файл конфигурации с использованием элемента <customBinding>, а не элемента, предоставляемого системой. Например, если служба использует элемент <wsHttpBinding>, свойству ProtectionLevel которого задано значение Sign, раздел привязок создаваемой конфигурации будет содержать <customBinding> вместо <wsHttpBinding>. Дополнительную информацию об уровне защиты можно найти в разделе Основные сведения об уровне защиты.

Экспорт метаданных

При помощи Svcutil.exe можно экспортировать метаданные для служб, контрактов и типов данных в скомпилированных сборках. Чтобы экспортировать метаданные для службы, необходимо использовать параметр /serviceName для задания службы, которую следует экспортировать. Для экспорта всех типов контрактов данных внутри сборки используется параметр /dataContractOnly. По умолчанию метаданные экспортируются для всех контрактов служб во входных сборках.

svcutil.exe [/t:metadata] [/serviceName:<serviceConfigName>] [/dataContractOnly] <assemblyPath>*

Проверка службы

Проверка проводится для выявления ошибок в реализациях службы без размещения службы. Для указания службы для проверки используется параметр /serviceName.

svcutil.exe /validate /serviceName:<serviceConfigName> <assemblyPath>*

Загрузка метаданных

Средство Svcutil.exe можно использовать для загрузки метаданных из работающих служб и сохранения этих метаданных в локальных файлах. Для загрузки метаданных необходимо задать параметр /t:metadata. В противном случае создается код клиента. Для URL-схем HTTP и HTTPS средство Svcutil.exe предпринимает попытку извлечь метаданные с помощью WS-Metadata Exchange и DISCO. Для всех остальных URL-схем Svcutil.exe использует только WS-Metadata Exchange.

Svcutil одновременно направляет следующие запросы метаданных для извлечения метаданных.

· Запрос MEX (WS-Transfer) на предоставленный адрес

· Запрос MEX на предоставленный адрес с присоединенным /mex

· Запрос DISCO (с использованием протокола DiscoveryClientProtocol из ASMX) на предоставленный адрес.

По умолчанию для осуществления запросов MEX Svcutil.exe использует привязки, определенные в классе MetadataExchangeBindings. Для настройки привязки, используемой для WS-Metadata Exchange, необходимо определить в конфигурации, использующей контракт IMetadataExchange, конечную точку клиента. Ее можно определить в файле конфигурации средства Svcutil.exe или в другом файле конфигурации, заданном с помощью параметра /svcutilConfig.

svcutil.exe /t:metadata <url>* | <epr>

Создание типа XmlSerializer

Службы и клиентские приложения, использующие типы данных, сериализуемые с помощью сериализатора XmlSerializer, создают и компилируют код сериализации для этих типов данных во время выполнения, что может привести к снижению производительности при запуске.

Примечание

Предварительно созданный код сериализации может использоваться только в клиентских приложениях, но не в службах.

Svcutil.exe может улучшить производительность при запуске этих приложений путем создания необходимого кода сериализации C# из компилированных сборок для приложения. Дополнительные сведения см. в разделе Как сократить время запуска клиентских приложений WCF с использованием XmlSerializer.

Примечание

Svcutil.exe создает код только для типов, которые используются контрактами служб, найденными во входных сборках.

svcutil.exe /t:xmlSerializer <assemblyPath>*