.NET Core 用 WCF dotnet-svcutil ツール

[アーティクル]
05/09/2023

Windows Communication Foundation (WCF) dotnet-svcutil ツールは、ネットワークの場所にある Web サービスから、あるいは WSDL ファイルからメタデータを取得し、Web サービス操作にアクセスするクライアントプロキシメソッドを含んだ WCF クラスを生成する .NET ツールです。

.NET Framework プロジェクトの ServiceModel メタデータユーティリティツール (Svcutil.exe) と同様に、dotnet-svcutil は、.NET Core プロジェクトおよび .NET Standard プロジェクトと互換性のある Web サービス参照を生成するためのコマンドラインツールです。

dotnet-svcutil ツールは、Visual Studio 2017 バージョン 15.5 で最初に用意された Visual Studio 接続済みサービスプロバイダーである、WCF Web Service Reference に対する代わりのオプションです。 dotnet-svcutil ツールは、.NET ツールとして、Linux、macOS、Windows 上でクロスプラットフォームで利用できます。

重要

信頼できるソースのサービスのみを参照してください。信頼できないソースの参照を追加すると、セキュリティが損なわれる可能性があります。

.NET Core 2.1 SDK 以降のバージョン
任意のコードエディター

作業の開始

次の例では、Web サービス参照を .NET Core Web プロジェクトに追加してサービスを呼び出すために必要な手順について説明します。 HelloSvcutil という名前の .NET Core Web アプリケーションを作成し、次のコントラクトを実装する Web サービスへの参照を追加します。

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

この例では、Web サービスが次のアドレスでホストされると仮定します: http://contoso.com/SayHello.svc

Windows、macOS、または Linux のコマンドウィンドウから次の手順を実行します。

次の例に示すように、HelloSvcutil という名前のディレクトリをプロジェクト用に作成し、現在のディレクトリに指定します。
```
mkdir HelloSvcutil
cd HelloSvcutil
```
次に示すように、dotnet new コマンドを使用して、このディレクトリに新しい C# Web プロジェクトを作成します。
```
dotnet new web
```
CLI ツールとして dotnet-svcutilNuGet パッケージをインストールします。
- dotnet-svcutil 2.x
- dotnet-svcutil 1.x
```
dotnet tool install --global dotnet-svcutil
```
HelloSvcutil.csproj プロジェクトファイルをエディターで開いて Project 要素を編集し、次のコードを使用して dotnet-svcutil NuGet パッケージを CLI ツールの参照として追加します。
```
<ItemGroup>
  <DotNetCliToolReference Include="dotnet-svcutil" Version="1.0.*" />
</ItemGroup>
```
その後、次に示すように、dotnet restore コマンドを使用して dotnet-svcutil パッケージを復元します。
```
dotnet restore
```
次に示すように、dotnet-svcutil コマンドを実行して、Web サービス参照ファイルを生成します。
- dotnet-svcutil 2.x
- dotnet-svcutil 1.x
```
dotnet-svcutil http://contoso.com/SayHello.svc
```
```
dotnet svcutil http://contoso.com/SayHello.svc
```

生成されたファイルは、HelloSvcutil/ServiceReference/Reference.cs として保存されます。また、dotnet-svcutil ツールでは、プロキシコードで必要な適切な WCF パッケージが、パッケージ参照としてプロジェクトに追加されます。

サービス参照の使用

次に示すように、dotnet restore コマンドを使用して WCF パッケージを復元します。
```
dotnet restore
```
使用するクライアントクラスと操作の名前を検索します。 Reference.cs には System.ServiceModel.ClientBase を継承するクラスが含まれており、そのメソッドを使用してサービスで操作を呼び出すことができます。この例では、SayHello サービスの Hello 操作を呼び出します。 ServiceReference.SayHelloClient はクライアントクラスの名前であり、操作の呼び出しに使用できる HelloAsync という名前のメソッドが含まれます。
エディターで Startup.cs ファイルを開き、先頭にサービス参照名前空間に対する usingディレクティブを追加します。
```
using ServiceReference;
```

Web サービスを呼び出すように、Configure メソッドを編集します。これを行うには、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);
    });
}

次に示すように、dotnet run コマンドを使用してアプリケーションを実行します。
```
dotnet run
```
Web ブラウザーでコンソールに表示されている URL に移動します (たとえば、http://localhost:5000)。

次の出力が表示されます。"Hello dotnet-svcutil!"

dotnet-svcutil ツールのパラメーターの詳細な説明については、次に示すように、help パラメーターを渡してツールを呼び出してください。

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

dotnet-svcutil --help

dotnet svcutil --help

フィードバックと質問

質問やフィードバックがありましたら、GitHub で問題を提起してください。 GitHub の WCF リポジトリで既存の質問や問題を確認することもできます。

リリースノート

既知の問題を含む最新のリリース情報については、リリースノートのページを参照してください。

情報

dotnet-svcutil NuGet パッケージ

.NET Core 用 WCF dotnet-svcutil ツール

必須コンポーネント

作業の開始

サービス参照の使用

フィードバックと質問

リリース ノート

情報

フィードバック

その他のリソース

リリースノート