Ferramenta WCF dotnet-svcutil para .NET Core

Artigo
01/10/2024

A ferramenta dotnet-svcutil do Windows Communication Foundation (WCF) é uma ferramenta .NET que recupera metadados de um serviço Web em um local de rede ou de um arquivo WSDL e gera uma classe WCF contendo métodos de proxy de cliente que acessam as operações do serviço Web.

Semelhante à ferramenta Service Model Metadata - svcutil para projetos do .NET Framework, o dotnet-svcutil é uma ferramenta de linha de comando para gerar uma referência de serviço Web compatível com projetos .NET Core e .NET Standard.

A ferramenta dotnet-svcutil é uma opção alternativa ao provedor de serviços conectados WCF Web Service Reference Visual Studio que foi fornecido pela primeira vez com o Visual Studio 2017 versão 15.5. A ferramenta dotnet-svcutil como uma ferramenta .NET, está disponível multiplataforma no Linux, macOS e Windows.

Importante

Você só deve fazer referência a serviços de uma fonte confiável. Adicionar referências de uma fonte não confiável pode comprometer a segurança.

SDK do .NET Core 2.1 ou versões posteriores
Seu editor de código favorito

Introdução

O exemplo a seguir orienta você pelas etapas necessárias para adicionar uma referência de serviço Web a um projeto Web .NET Core e invocar o serviço. Você criará um aplicativo Web .NET Core chamado HelloSvcutil e adicionará uma referência a um serviço Web que implemente o seguinte contrato:

[ServiceContract]
public interface ISayHello
{
    [OperationContract]
    string Hello(string name);
}

Neste exemplo, vamos supor que o serviço Web será hospedado no seguinte endereço: http://contoso.com/SayHello.svc

Em uma janela de comando do Windows, macOS ou Linux, execute as seguintes etapas:

Crie um diretório chamado HelloSvcutil para seu projeto e torne-o seu diretório atual, como no exemplo a seguir:
```
mkdir HelloSvcutil
cd HelloSvcutil
```
Crie um novo projeto Web C# nesse diretório usando o dotnet new comando da seguinte maneira:
```
dotnet new web
```
Instale o dotnet-svcutil pacote NuGet como uma ferramenta CLI:
- dotnet-svcutil 2.x
- dotnet-svcutil 1.x
```
dotnet tool install --global dotnet-svcutil
```
Abra o arquivo de HelloSvcutil.csproj projeto em seu editor, edite o Project elemento e adicione o dotnet-svcutil pacote NuGet como uma referência de ferramenta CLI, usando o seguinte código:
```
<ItemGroup>
  <DotNetCliToolReference Include="dotnet-svcutil" Version="1.0.*" />
</ItemGroup>
```
Em seguida, restaure o pacote dotnet-svcutil usando o dotnet restore comando da seguinte maneira:
```
dotnet restore
```
Execute o comando dotnet-svcutil para gerar o arquivo de referência do serviço Web da seguinte maneira:
- dotnet-svcutil 2.x
- dotnet-svcutil 1.x
```
dotnet-svcutil http://contoso.com/SayHello.svc
```
```
dotnet svcutil http://contoso.com/SayHello.svc
```

O arquivo gerado é salvo como HelloSvcutil/ServiceReference/Reference.cs. A ferramenta dotnet-svcutil também adiciona ao projeto os pacotes WCF apropriados exigidos pelo código proxy como referências de pacote.

Usando a referência de serviço

Restaure os pacotes WCF usando o dotnet restore comando da seguinte maneira:
```
dotnet restore
```
Encontre o nome da classe do cliente e da operação que você deseja usar. Reference.cs conterá uma classe que herda de System.ServiceModel.ClientBase, com métodos que podem ser usados para chamar operações no serviço. Neste exemplo, você deseja chamar a operação Hello do serviço SayHello. ServiceReference.SayHelloClient é o nome da classe cliente e tem um método chamado HelloAsync que pode ser usado para chamar a operação.
Abra o Startup.cs arquivo no editor e adicione uma using diretiva para o namespace de referência de serviço na parte superior:
```
using ServiceReference;
```

Edite o Configure método para invocar o serviço Web. Para fazer isso, crie uma instância da classe que herda e chame o método no objeto cliente ClientBase :

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }

    app.Run(async (context) =>
    {
        var client = new SayHelloClient();
        var response = await client.HelloAsync();
        await context.Response.WriteAsync(response);
    });
}

Execute o aplicativo usando o dotnet run comando da seguinte maneira:
```
dotnet run
```
Navegue até o URL listado no console (por exemplo, http://localhost:5000) no navegador da Web.

Você deve ver a seguinte saída: "Olá dotnet-svcutil!"

Para obter uma descrição detalhada dos parâmetros da dotnet-svcutil ferramenta, invoque a ferramenta que passa o parâmetro help da seguinte maneira:

dotnet-svcutil 2.x
dotnet-svcutil 1.x

dotnet-svcutil --help

dotnet svcutil --help

Feedback e perguntas

Se você tiver alguma dúvida ou feedback, abra um problema no GitHub. Você também pode revisar quaisquer perguntas ou problemas existentes no repositório WCF no GitHub.

Notas de versão

Consulte as Notas de versão para obter informações atualizadas sobre a versão, incluindo problemas conhecidos.

Informação

Pacote NuGet dotnet-svcutil

Partilhar via