¿Le resultó útil esta página?
Sus comentarios sobre este contenido son muy importantes. Háganos saber su opinión.
¿Tiene comentarios adicionales?
Caracteres restantes: 1500
Herramienta de utilidad de metadatos de ServiceModel (Svcutil.exe)

Herramienta de utilidad de metadatos de ServiceModel (Svcutil.exe)

La herramienta de utilidad de metadatos de ServiceModel se utiliza para generar el código de modelo de servicio a partir de los documentos de metadatos y los documentos de metadatos a partir del código de modelo de servicio.

Comentarios

La herramienta de utilidad de metadatos de ServiceModel se puede encontrar en la ubicación de instalación de Windows SDK, específicamente, C:\Archivos de programa\Microsoft SDKs\Windows\v6 .0\Bin

La tabla siguiente resume las varias funcionalidades proporcionadas por esta herramienta y el tema correspondiente que explica cómo se utiliza.

Tarea Tema

Genera código a partir de servicios en ejecución o de documentos de metadatos estáticos.

Generating a WCF Client from Service Metadata

Exporta documentos de metadatos a partir del código compilado.

How to: Use Svcutil.exe to Export Metadata from Compiled Service Code

Valida el código de servicio compilado.

How to: Use Svcutil.exe to Validate Compiled Service Code

Descarga los documentos de metadatos de los servicios en ejecución.

How to: Download Metadata Documents from a Running Service

Genera el código de serialización.

How to: Use Svcutil.exe to Generate Serialization Code

Aa347733.Caution(es-es,VS.90).gifPrecaución:
Svcutil sobrescribirá los archivos existentes en un disco si los nombres proporcionados como parámetros son idénticos. Esto puede incluir archivos de código, archivos de configuración o archivos de metadatos. Para evitar esto al generar archivos de código y configuración, utilice el modificador /mergeConfig.

Además, los modificadores /r y /ct para hacer referencia a los tipos son para generar contratos de datos. Estos modificadores no funcionan al utilizar XmlSerializer.

La herramienta tiene un tiempo de espera de 5 minutos al recuperar los metadatos. Este tiempo de espera sólo se aplica a la recuperación de metadatos a través de la red. No se aplica a cualquier procesamiento de esos metadatos.

Cuando utiliza Svcutil para obtener acceso a un documento WSDL que contiene una referencia a un servicio de token de seguridad (STS), Svcutil realiza una llamada WS-MetadataExchange al STS. Sin embargo, el servicio puede exponer sus documentos WSDL mediante WS-MetadataExchange o HTTP GET. En consecuencia, si el STS sólo ha expuesto el documento WSDL mediante HTTP GET, un cliente escrito en .NET Framework 3,0 producirá un error. Con los clientes escritos en .NET Framework 3,5, Svcutil intentará utilizar WS-MetadataExchange y HTTP GET para obtener el WSDL de STS.

Usos comunes

La tabla siguiente muestra algunas opciones de esta herramienta usadas frecuentemente.

Opción Descripción

/directory:<directorio>

Directorio en el que se crearán los archivos.

Valor predeterminado: el directorio actual.

Forma abreviada: /d

/help

Muestra la sintaxis de comandos y las opciones de la herramienta.

Forma abreviada: /?

/noLogo

Suprime el mensaje del banner y el copyright.

/svcutilConfig:<configFile>

Especifica un archivo de configuración personalizado para utilizar en lugar del archivo App.config. Esto se puede utilizar para registrar extensiones system.serviceModel sin modificar el archivo de configuración de la herramienta.

/target:<tipo de salida>

Especifica la salida que va a generar la herramienta.

Los valores válidos son código, metadatos o xmlSerializer.

Forma abreviada: /t

Generación de código

Svcutil.exe puede generar el código para los contratos de servicios, clientes y tipos de datos a partir de documentos de metadatos. Estos documentos de metadatos pueden estar en un almacenamiento duradero o recuperarse en línea. La recuperación en línea sigue el protocolo de WS-Metadata Exchange o el protocolo DISCO (para obtener detalles, vea la sección Descarga de metadatos).

Para un servicio con un extremo BasicHttpContextbinding, Svcutil.exe genera un BasicHttpBinding con el atributo allowCookies establecido como true. Las cookies se utilizan para el contexto del servidor. Si desea administrar el contexto del cliente cuando el servicio utiliza cookies, puede modificar manualmente la configuración para usar un enlace de contexto.

Aa347733.Caution(es-es,VS.90).gifPrecaución:
Svcutil.exe genera el cliente basado en el WSDL o en el archivo de directivas recibido del servicio. El nombre principal del usuario (UPN) se genera concatenando el nombre de usuario, "@" y un nombre de dominio completo (FQDN). Sin embargo, para los usuarios que se registraron en Active Directory, este formato no es válido y el UPN generado por la herramienta produce un error en la autenticación de Kerberos con el mensaje de error "El intento de inicio de sesión ha producido un error." Para resolver este problema, debe corregir manualmente el archivo de cliente generado por esta herramienta.

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

Argumento Descripción

epr

La ruta de acceso a un archivo XML que contiene un WS-Addressing EndpointReference para un extremo de servicio compatible con WS-Metadata Exchange. Para obtener más información, vea la sección Descarga de metadatos.

metadataDocumentPath

La ruta de acceso a un documento de metadatos (wsdl o xsd) que contiene el contrato para importar a código (.wsdl, .xsd, .wspolicy o .wsmex).

Svcutil sigue importaciones e inclusiones al especificar una dirección URL remota para los metadatos. Sin embargo, si desea procesar los archivos de metadatos en el sistema de archivos local, debe especificar todos los archivos en este argumento. De esta manera, puede utilizar Svcutil en un entorno de compilación donde no puede tener dependencias de red. Puede utilizar caracteres comodín (por ejemplo, *.xsd, *.wsdl) para este argumento.

url

La dirección URL de un extremo de servicio que proporciona metadatos o a un documento de metadatos hospedado en línea. Para obtener más información sobre cómo se recuperan estos documentos, vea la sección Descarga de metadatos.

Opción Descripción

/async

Genera firmas del método sincrónicas y asincrónicas.

Valor predeterminado: generar sólo firmas de método sincrónicas.

Forma abreviada: /a

/collectionType:<tipo>

Especifica un nombre completo o certificado por ensamblado del tipo que se va a utilizar como un tipo de datos de colección cuando se genera el código a partir de los esquemas.

Forma abreviada: /ct

/config:<configFile>

Especifica el nombre de archivo para el archivo de configuración generado.

Valor predeterminado: output.config

/dataContractOnly

Genera código solo para tipos de contrato de datos. No se generan los tipos del contrato de servicio.

Sólo debería especificar archivos de metadatos locales para esta opción.

Forma abreviada: /dconly

/enableDataBinding

Implementa la interfaz INotifyPropertyChanged en todos los tipos de contrato de datos para habilitar el enlace de datos.

Forma abreviada: /edb

/excludeType:<tipo>

Especifica un nombre de tipo completo o certificado por ensamblado que se va a excluir de los tipos de contrato a los que se hace referencia.

Al utilizar este modificador junto con /r de DLL independientes, se hace referencia al nombre completo de la clase XSD.

Forma abreviada: /et

/importXmlTypes

Configura el serializador de contratos de datos para importar tipos que no son de contratos de datos como tipos IXmlSerializable.

/internal

Genera clases que están marcadas como internas. Valor predeterminado: generar sólo clases públicas.

Forma abreviada: /i

/language:<lenguaje>

Especifica el lenguaje de programación a utilizar para la generación de código. Debería proporcionar un nombre de lenguaje registrado en el archivo Machine.config o el nombre completo de una clase que hereda de CodeDomProvider.

Valores: c#, cs, csharp, vb, visualbasic, c++, cpp

Valor predeterminado: csharp

Forma abreviada: /l

Aa347733.note(es-es,VS.90).gifNota:
El modificador sólo admite C++ para el proveedor de código que se distribuye con Visual Studio 2005 SP1.

/mergeConfig

Combina la configuración generada en un archivo existente en lugar de sobrescribir el archivo existente.

/messageContract

Genera tipos de contrato de mensaje.

Forma abreviada: /mc

/namespace:<cadena,cadena>

Especifica una asignación de un targetNamespace WSDL o esquema XML a un espacio de nombres CLR. Utilizando '*' para targetNamespace se asignan todos los targetNamespaces sin asignación explícita a ese espacio de nombres CLR.

Para asegurarse de que el nombre de contrato de mensaje no produce una colisión con el nombre de la operación, debería certificar o la referencia de tipo con :: o asegurarse de que los nombres son únicos.

Valor predeterminado: Se deriva del espacio de nombres de destino del documento de esquema para contratos de datos. El espacio de nombres predeterminado se utiliza para todos los otros tipos generados.

Forma abreviada: /n

/noConfig

No generar archivos de configuración.

/noStdLib

No hacer referencia a las bibliotecas estándar.

Valor predeterminado: Se hace referencia a Mscorlib.dll y a System.servicemodel.dll.

/out:<archivo>

Especifica el nombre de archivo para el código generado.

Valor predeterminado: Se deriva del nombre de definición de WSDL, nombre de servicio de WSDL o espacio de nombres de destino de uno de los esquemas.

Forma abreviada: /o

/serializable

Genera clases marcadas con el atributo Serializable.

Forma abreviada: /s

/targetClientVersion

Especifique qué versión de .NET Framework es el destino de la aplicación. Los valores válidos son Version30 y Version35. El valor predeterminado es Version30, que quiere decir que la herramienta SvcUtil.exe tiene como destino .NET Framework 3,0 de forma predeterminada.

Forma abreviada: /tcv

Version30: Utilice /tcv:Version30 si está generando código para clientes que utilizan .NET Framework 3,0. Utilizando este valor, la herramienta SvcUtil.exe genera código que hace referencia a la funcionalidad de .NET Framework 3,0 y versiones anteriores.

Version35: Utilice /tcv:Version35 si está generando código para clientes que utilizan .NET Framework 3,5. Utilizando este valor, la herramienta SvcUtil.exe genera código que hace referencia a la funcionalidad de .NET Framework 3,5 y versiones anteriores. Al utilizar /tcv:Version35 con el modificador /async, se generan tanto el método asincrónico basado en evento como el método asincrónico de devolución de llamada/basado en el delegado. Además, está habilitada la compatibilidad para conjuntos de datos habilitados por LINQ y DateTimeOffset.

/reference:<ruta de acceso al archivo>

Tipos de referencia en el ensamblado especificado. Al generar clientes, utilice esta opción para especificar ensamblados que podrían contener tipos que representan los metadatos que se están importando.

No puede especificar contratos de mensaje y los tipos XmlSerializer utilizando este modificador.

Si se hace referencia a DateTimeOffset, se utiliza este tipo en lugar de generar un tipo nuevo. Si la aplicación se escribe utilizando .NET Framework 3,5, SvcUtil.exe hace referencia a DateTimeOffset de forma automática.

Forma abreviada: /r

/serializer:Auto

Selecciona el serializador de forma automática. Utiliza el serializador de contratos de datos. Si esto falla, se utiliza XmlSerializer.

Forma abreviada: /ser:Auto

/serializer:DataContractSerializer

Genera tipos de datos que utilizan el serializador de contratos de datos para la serialización y deserialización.

Forma abreviada: /ser:DataContractSerializer

/serializer:XmlSerializer

Genera tipos de datos que utilizan el XmlSerializer para la serialización y deserialización.

Forma abreviada: /ser:XmlSerializer

Aa347733.note(es-es,VS.90).gifNota:
Cuando el enlace de servicio es uno de los enlaces proporcionados por el sistema (vea System-Provided Bindings), y la propiedad ProtectionLevel está establecida en None o Sign, Svcutil genera un archivo de configuración utilizando el elemento <customBinding> en lugar del elemento esperado proporcionado por sistema. Por ejemplo, si el servicio utiliza el elemento <wsHttpBinding> con ProtectionLevel establecido en Sign, la configuración generada tiene <customBinding> en la sección de enlaces en lugar de <wsHttpBinding>. Para obtener más información acerca de los niveles de protección, consulte Understanding Protection Level.

Exportación de metadatos

Svcutil.exe puede exportar metadatos para los servicios, contratos y tipos de datos en ensamblados compilados. Para exportar los metadatos para un servicio, debe utilizar la opción /serviceName para especificar el servicio que desea exportar. Para exportar todos los tipos de contrato de datos dentro de un ensamblado, debe utilizar la opción /dataContractOnly. De forma predeterminada, los metadatos se exportan para todos los contratos de servicios en los ensamblados de entrada.

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

Argumento Descripción

assemblyPath

Especifica la ruta de acceso a un ensamblado que contiene los servicios, contratos o tipos de contrato de datos a exportar. Los caracteres comodín de la línea de comandos estándar se pueden utilizar para proporcionar varios archivos como entrada.

Opción Descripción

/serviceName:<serviceConfigName>

Especifica el nombre de configuración de un servicio que se va a exportar. Si se utiliza esta opción, se debe pasar un ensamblado ejecutable con un archivo de configuración asociado como entrada. Svcutil.exe busca la configuración de servicio en todos los archivos de configuración asociados. Si los archivos de configuración contienen cualquier tipo de extensión, los ensamblados que contienen estos tipos deben estar en la GAC o indicados de forma explícita mediante la opción /reference.

/reference:<ruta de acceso al archivo>

Agrega el ensamblado especificado al conjunto de ensamblados utilizados para resolver las referencias de tipo. Si está exportando o validando un servicio registrado en configuración que utiliza extensiones de terceros (Comportamientos, Enlaces y Elementos de enlace), utilice esta opción para buscar ensamblados de extensión que no están en la GAC.

Forma abreviada: /r

/dataContractOnly

Sólo funciona en tipos de contrato de datos. No se procesan los contratos de servicios.

Sólo debería especificar archivos de metadatos locales para esta opción.

Forma abreviada: /dconly

/excludeType:<tipo>

Especifica el nombre completo o certificado por ensamblado de un tipo que se va a excluir de la exportación. Se puede utilizar esta opción al exportar los metadatos para un servicio o un conjunto de contratos de servicios excluyan tipos de la exportación. Esta opción no se puede combinar con la opción /dconly.

Si tiene un ensamblado único que contiene varios servicios y cada uno usa clases independientes con el mismo nombre XSD, debería especificar el nombre del servicio en lugar del nombre de clase XSD para este modificador.

No se admiten XSD o tipos de contrato de datos.

Forma abreviada: /et

Validación del servicio

La validación se puede utilizar para detectar errores en implementaciones del servicio sin hospedar el servicio. Debe utilizar la opción /serviceName para indicar el servicio que desea validar.

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

Argumento Descripción

assemblyPath

Especifica la ruta de acceso a un ensamblado que contiene tipos de servicio que hay que validar. El ensamblado debe tener un archivo de configuración asociado para proporcionar la configuración de servicio. Los caracteres comodín de la línea de comandos estándar se pueden utilizar para proporcionar varios ensamblados.

Opción Descripción

/validate

Valida una implementación del servicio especificada por la opción /serviceName. Si se utiliza esta opción, se debe pasar un ensamblado ejecutable con un archivo de configuración asociado como entrada.

Forma abreviada: /v

/serviceName:<serviceConfigName>

Especifica el nombre de configuración de un servicio que se va a validar. Svcutil.exe busca la configuración de servicio en todos los archivos de configuración asociados de todos los ensamblados de entrada. Si los archivos de configuración contienen cualquier tipo de extensión, los ensamblados que contienen estos tipos deben estar en la GAC o indicados de forma explícita mediante la opción /reference.

/reference:<ruta de acceso al archivo>

Agrega el ensamblado especificado al conjunto de ensamblados utilizados para resolver las referencias de tipo. Si está exportando o validando un servicio registrado en configuración que utiliza extensiones de terceros (Comportamientos, Enlaces y Elementos de enlace), utilice esta opción para buscar ensamblados de extensión que no están en la GAC.

Forma abreviada: /r

/dataContractOnly

Sólo funciona en tipos de contrato de datos. No se procesan los contratos de servicios.

Sólo debería especificar archivos de metadatos locales para esta opción.

Forma abreviada: /dconly

/excludeType:<tipo>

Especifica el nombre completo o certificado por ensamblado de un tipo que se va a excluir de la validación.

Forma abreviada: /et

Descarga de metadatos

Se puede utilizar Svcutil.exe para descargar los metadatos de servicios en ejecución y guardar los metadatos en archivos locales. Debe especificar la opción /t:metadata para descargar los metadatos. De lo contrario, se genera el código de cliente. Para esquemas URL de HTTP y HTTPS, Svcutil.exe intenta recuperar metadatos mediante WS-Metadata Exchange y DISCO. Para todos los otros esquemas de URL, Svcutil.exe utiliza sólo WS-Metadata Exchange.

Svcutil emite simultáneamente las solicitudes de los metadatos siguientes para recuperar los metadatos.

  • Solicitud MEX (WS-Transfer) a la dirección proporcionada
  • Solicitud MEX a la dirección proporcionada con /mex anexado
  • Solicitud DISCO (utilizando DiscoveryClientProtocol de ASMX) a la dirección proporcionada.

De forma predeterminada, Svcutil.exe utiliza los enlaces definidos en la clase MetadataExchangeBindings para realizar las solicitudes MEX. Para configurar el enlace utilizado para WS-Metadata Exchange, debe definir un extremo del cliente en configuración que utiliza el contrato de IMetadataExchange. Esto se puede definir en el archivo de configuración de Svcutil.exe o en otro archivo de configuración especificado mediante la opción /svcutilConfig.

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

Argumento Descripción

url

La dirección URL de un extremo de servicio que proporciona metadatos o a un documento de metadatos hospedado en línea.

epr

La ruta de acceso a un archivo XML que contiene un WS-Addressing EndpointReference para un extremo de servicio compatible con WS-Metadata Exchange.

Generación de tipo XmlSerializer

Los servicios y las aplicaciones cliente que utilizan tipos de datos que son serializables utilizando XmlSerializer generan y compilan el código de la serialización para esos tipos de datos en el tiempo de ejecución, lo que se puede traducir en un rendimiento de inicio lento.

Aa347733.note(es-es,VS.90).gifNota:
El código de serialización generado previamente sólo puede usarse en aplicaciones cliente y no en servicios.

Svcutil.exe puede generar el código de serialización C# necesario a partir de los ensamblados compilados para la aplicación, mejorando así el rendimiento de inicio de esas aplicaciones. Para obtener más información, vea How to: Improve the Startup Time of WCF Client Applications using the XmlSerializer.

Aa347733.note(es-es,VS.90).gifNota:
Svcutil.exe sólo genera el código para los tipos utilizados por los contratos de servicio situados en los ensamblados de entrada.

svcutil.exe /t:xmlSerializer <assemblyPath>*

Argumento Descripción

assemblyPath

Especifica la ruta de acceso a un ensamblado que contiene tipos de contrato de servicio. Los tipos de serialización se generan para todos los tipos Xml Serializable en cada contrato.

Opción Descripción

/reference:<ruta de acceso al archivo>

Agrega el ensamblado especificado al conjunto de ensamblados utilizados para resolver las referencias de tipo.

Forma abreviada: /r

/excludeType:<tipo>

Especifica el nombre completo o certificado por ensamblado de un tipo que se va a excluir de la exportación o de la validación.

Forma abreviada: /et

/out:<archivo>

Especifica el nombre de archivo para el código generado. Se omite esta opción cuando se pasan varios ensamblados a la herramienta como entrada.

Valor predeterminado: Se deriva del nombre de ensamblado.

Forma abreviada: /o

/UseSerializerForFaults

Especifica que XmlSerializer se debería utilizar para leer y escribir los errores, en lugar del DataContractSerializer predeterminado.

Ejemplos

El comando siguiente genera el código de cliente a partir de un servicio en ejecución o los documentos de metadatos en línea.

svcutil http://service/metadataEndpoint

El comando siguiente genera el código de cliente a partir de los documentos de metadatos locales.

svcutil *.wsdl *.xsd /language:C#

El comando siguiente genera los tipos de contrato de datos en Visual Basic a partir de documentos de esquema locales.

svcutil /dconly *.xsd /language:VB

El comando siguiente descarga los documentos de metadatos a partir de servicios en ejecución.

svcutil /t:metadata http://service/metadataEndpoint

El comando siguiente genera los documentos de metadatos para contratos de servicios y tipos asociados en un ensamblado.

svcutil myAssembly.dll

El comando siguiente genera documentos de metadatos para un servicio y todos los contratos de servicios asociados y tipos de datos en un ensamblado.

svcutil myServiceHost.exe /serviceName:myServiceName

El comando siguiente genera documentos de metadatos para los tipos de datos en un ensamblado.

svcutil myServiceHost.exe /dconly

El comando siguiente comprueba el alojamiento del servicio.

svcutil /validate /serviceName:myServiceName myServiceHost.exe

El comando siguiente genera los tipos de serialización para los tipos XmlSerializer utilizados por cualquier contrato de servicios en el ensamblado.

svcutil /t:xmlserializer myContractLibrary.exe

Cuestiones de seguridad

Debería utilizar la lista de control de acceso (ACL) adecuada para proteger la carpeta de instalación de Svcutil.exe, Svcutil.config y los archivos que /svcutilConfig señala. Esto puede evitar que se registren y se ejecuten extensiones malintencionadas.

Además, para minimizar la oportunidad de que la seguridad se ponga en peligro, no debería agregar extensiones que no son de confianza para formar parte del sistema ni utilizar proveedores de código que no son de confianza con Svcutil.exe.

Finalmente, no debería utilizar la herramienta en el nivel medio de su aplicación, ya que puede producir la denegación de servicio al proceso actual.

Consulte también


Adiciones de comunidad

AGREGAR
Mostrar:
© 2015 Microsoft