チュートリアル: Windows Communication Foundation クライアントを作成する

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

このチュートリアルでは、基本的な Windows Communication Foundation (WCF) アプリケーションの作成に必要な 5 つのタスクのうち 4 番目のタスクについて説明します。このチュートリアルの概要については、「チュートリアル: Windows Communication Foundation アプリケーション入門」を参照してください。

WCF アプリケーションを作成するための次のタスクでは、WCF サービスからメタデータを取得してクライアントを作成します。 Visual Studio を使用してサービス参照を追加し、そこでサービスの MEX エンドポイントからメタデータを取得します。その後、Visual Studio によって、選択した言語でクライアントプロキシ用のマネージドソースコードファイルが生成されます。また、クライアント構成ファイル (App.config) も作成されます。このファイルにより、クライアントアプリケーションはエンドポイントでサービスに接続できるようになります。

Note

Visual Studio でクラスライブラリプロジェクトから WCF サービスを呼び出す場合は、サービス参照の追加機能を使用して、プロキシおよび関連構成ファイルを自動的に生成します。ただし、クラスライブラリプロジェクトではこの構成ファイルが使用されないため、クラスライブラリを呼び出す実行可能ファイルの App.config ファイルに、生成された構成ファイルの設定を追加する必要があります。

Note

別の方法として、Visual Studio ではなく ServiceModel メタデータユーティリティツールを使用して、プロキシクラスと構成ファイルを生成することもできます。

クライアントアプリケーションは、生成されたプロキシクラスを使用してサービスと通信します。この手順については、クライアントの使用のチュートリアルに関する記事を参照してください。

このチュートリアルでは、以下の内容を学習します。

WCF クライアント用のコンソールアプリプロジェクトを作成して構成します。
プロキシクラスと構成ファイルを生成するには、WCF サービスへのサービス参照を追加します。

Windows Communication Foundation クライアントを作成する

Visual Studio でコンソールアプリプロジェクトを作成します。
1. [ファイル] メニューから、 [開く]>[ソリューション/プロジェクト] を選択し、前に作成した GettingStarted ソリューション (GettingStarted.sln) を参照します。 [Open] を選択します。
2. [表示] メニューの [ソリューションエクスプローラー] を選択します。
3. [ソリューションエクスプローラー] ウィンドウで、GettingStarted ソリューション (最上位ノード) を選択し、ショートカットメニューの [追加]>[新しいプロジェクト] を選択します。
4. [新しいプロジェクトの追加] ウィンドウの左側で、 [Visual C#] または [Visual Basic] の下にある [Windows デスクトップ] カテゴリを選択します。
5. [コンソールアプリ (.NET Framework)] テンプレートを選択し、 [名前] に「GettingStartedClient」と入力します。 [OK] を選択します。
GettingStartedClient プロジェクトで、System.ServiceModel アセンブリへの参照を追加します。
1. [ソリューションエクスプローラー] ウィンドウで、GettingStartedClient プロジェクトの下にある [参照設定] フォルダーを選択して、ショートカットメニューから [参照の追加] を選択します。
2. [参照の追加] ウィンドウの左側にある [アセンブリ] で、 [フレームワーク] を選択します。
3. System.ServiceModel を見つけて選択し、 [OK] を選択します。
4. [ファイル]>[すべて保存] を選択して、ソリューションを保存します。
電卓サービスへのサービス参照を追加します。
1. [ソリューションエクスプローラー] ウィンドウで、GettingStartedClient プロジェクトの下にある [参照設定] フォルダーを選択して、ショートカットメニューから [サービス参照の追加] を選択します。
2. [サービス参照の追加] ウィンドウで、 [探索] を選択します。
  
  CalculatorService サービスが開始され、Visual Studio の [サービス] ボックスに表示されます。
3. CalculatorService を選択して展開し、サービスによって実装されているサービスコントラクトを表示します。既定の [名前空間] をそのまま使用して、 [OK] を選択します。
  
  Visual Studio によって、GettingStartedClient プロジェクトの [接続済みサービス] フォルダーに新しい項目が追加されます。

ServiceModel メタデータユーティリティツール

次の例では、必要に応じて、ServiceModel メタデータユーティリティツール (Svcutil.exe) を使用してプロキシクラスファイルを生成する方法を示します。このツールにより、プロキシクラスファイルと App.config ファイルが生成されます。次の例では、それぞれ C# と Visual Basic でプロキシを生成する方法を示します。

svcutil.exe /language:cs /out:generatedProxy.cs /config:app.config http://localhost:8000/GettingStarted/CalculatorService

svcutil.exe /language:vb /out:generatedProxy.vb /config:app.config http://localhost:8000/GettingStarted/CalculatorService

クライアント構成ファイル

クライアントを作成した後、Visual Studio によって GettingStartedClient プロジェクトに App.config 構成ファイルが作成されます。それは、次の例のようになります。

    <?xml version="1.0" encoding="utf-8" ?>
    <configuration>
        <startup>
            <!-- specifies the version of WCF to use-->
            <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.6.1" />
        </startup>
        <system.serviceModel>
            <bindings>
                <!-- Uses wsHttpBinding-->
                <wsHttpBinding>
                    <binding name="WSHttpBinding_ICalculator" />
                </wsHttpBinding>
            </bindings>
            <client>
                <!-- specifies the endpoint to use when calling the service -->
                <endpoint address="http://localhost:8000/GettingStarted/CalculatorService"
                    binding="wsHttpBinding" bindingConfiguration="WSHttpBinding_ICalculator"
                    contract="ServiceReference1.ICalculator" name="WSHttpBinding_ICalculator">
                    <identity>
                        <dns value="localhost" />
                    </identity>
                </endpoint>
            </client>
        </system.serviceModel>
    </configuration>

<system.serviceModel> セクションの <endpoint> 要素に注目してください。 <endpoint> 要素によって、次のように、クライアントでサービスにアクセスするために使用するエンドポイントが定義されます。

アドレス: http://localhost:8000/GettingStarted/CalculatorService。エンドポイントのアドレス。
サービスコントラクト: ServiceReference1.ICalculator。サービスコントラクトにより、WCF クライアントとサービスの間の通信が処理されます。このコントラクトは、サービス参照の追加機能を使用したときに、Visual Studio によって生成されました。基本的には、GettingStartedLib プロジェクトで定義したコントラクトのコピーです。
バインディング: WSHttpBinding。バインディングにより、トランスポートとして HTTP、相互運用可能なセキュリティ、その他の構成詳細が指定されます。

次のステップ

このチュートリアルでは、以下の内容を学習しました。

WCF クライアント用のコンソールアプリプロジェクトを作成して構成します。
クライアントアプリケーション用のプロキシクラスと構成ファイルを生成するには、WCF サービスへのサービス参照を追加します。

次のチュートリアルに進み、生成されたクライアントを使用する方法を学習してください。

チュートリアル: WCF クライアントを使用する

チュートリアル: Windows Communication Foundation クライアントを作成する

Windows Communication Foundation クライアントを作成する

ServiceModel メタデータ ユーティリティ ツール

クライアント構成ファイル

次のステップ

その他のリソース

ServiceModel メタデータユーティリティツール