WCF クライアントを使用したサービスへのアクセス

  • [アーティクル]

サービスを作成したら、次のステップは WCF クライアント プロキシの作成です。 クライアント アプリケーションでは、サービスとの通信にWCF クライアント プロキシが使用されます。 通常は、クライアント アプリケーションによってサービスのメタデータがインポートされ、サービスの呼び出しに使用できる WCF クライアント コードが生成されます。

WCF クライアントを作成するための基本手順は、次のとおりです。

  1. サービス コードをコンパイルします。

  2. WCF クライアント プロキシを生成します。

  3. WCF クライアント プロキシをインスタンス化します。

WCF クライアント プロキシは、ServiceModel メタデータ ユーティリティ ツール (SvcUtil.exe) を使って手動で生成できます。詳細については、「ServiceModel メタデータ ユーティリティ ツール (Svcutil.exe)」を参照してください。 WCF クライアント プロキシは、Visual Studio の [サービス参照の追加] 機能を使って生成することもできます。 いずれかの方法で WCF クライアント プロキシを生成するには、サービスが実行中であることが必要です。 サービスが自己ホスト型の場合は、ホストを実行する必要があります。 サービスが IIS/WAS でホストされている場合、特に必要な操作はありません。

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

ServiceModel メタデータ ユーティリティ ツール (Svcutil.exe) は、メタデータからコードを生成するためのコマンドライン ツールです。 基本的な Svcutil.exe コマンドの使用例を次に示します。

Svcutil.exe <service's Metadata Exchange (MEX) address or HTTP GET address>

また、Svcutil.exe は、ファイル システム上の Web サービス記述言語 (WSDL) ファイルや XML スキーマ定義言語 (XSD) ファイルを指定して使用することもできます。

Svcutil.exe <list of WSDL and XSD files on file system>

結果として、WCF クライアント コードが格納されたコード ファイルが作成されます。これは、サービスを呼び出すためにクライアント アプリケーションによって使用されます。

このツールを使用して構成ファイルを生成することもできます。

Svcutil.exe <file1 [,file2]>

ファイル名を 1 つだけ指定した場合、それは出力ファイルの名前になります。 ファイル名を 2 つ指定した場合は、1 番目のファイルが入力構成ファイルになり、そのファイルの内容と生成された構成がマージされ、2 番目のファイルに書き出されます。 構成の詳細については、サービスのバインディングの構成に関する記事を参照してください。

重要

セキュリティで保護されていないメタデータ要求には、セキュリティで保護されていないネットワーク要求と同様の一定の危険が伴います。通信先のエンドポイントが、本当に相手から通知されたとおりのエンドポイントかどうかわからない場合、取得した情報は悪質なサービスからのメタデータである可能性があります。

Visual Studio の "サービス参照の追加"

サービスを実行した状態で、WCF クライアント プロキシを含むプロジェクトを右クリックし、 [追加]>[サービス参照] を選択します。 [サービス参照の追加] ダイアログで、呼び出すサービスの URL を入力し、 [移動] ボタンをクリックします。 このダイアログ ボックスには、指定したアドレスで利用可能なサービスの一覧が表示されます。 サービスをダブルクリックすると、利用可能なコントラクトと操作が表示されるので、生成されたコードの名前空間を指定して、 [OK] ボタンをクリックします。

例

サービス用に作成されたコントラクトのコード例を次に示します。

// Define a service contract.
[ServiceContract(Namespace="http://Microsoft.ServiceModel.Samples")]
public interface ICalculator
{
    [OperationContract]
    double Add(double n1, double n2);
    // Other methods are not shown here.
}

' Define a service contract.
<ServiceContract(Namespace:="http://Microsoft.ServiceModel.Samples")> _
Public Interface ICalculator
    <OperationContract()>  _
    Function Add(ByVal n1 As Double, ByVal n2 As Double) As Double
    ' Other methods are not shown here.
End Interface

ServiceModel メタデータ ユーティリティ ツールと、Visual Studio の [サービス参照の追加] により、次の WCF クライアント クラスが生成されます。 このクラスは ClientBase<TChannel> ジェネリック クラスから継承されたもので、ICalculator インターフェイスを実装します。 このツールは、ICalculator インターフェイス (この例には表示されていません) も生成します。

public partial class CalculatorClient : System.ServiceModel.ClientBase<ICalculator>, ICalculator
{
    public CalculatorClient()
    {}

    public CalculatorClient(string endpointConfigurationName) :
            base(endpointConfigurationName)
    {}

    public CalculatorClient(string endpointConfigurationName, string remoteAddress) :
            base(endpointConfigurationName, remoteAddress)
    {}

    public CalculatorClient(string endpointConfigurationName,
        System.ServiceModel.EndpointAddress remoteAddress) :
            base(endpointConfigurationName, remoteAddress)
    {}

    public CalculatorClient(System.ServiceModel.Channels.Binding binding,
        System.ServiceModel.EndpointAddress remoteAddress) :
            base(binding, remoteAddress)
    {}

    public double Add(double n1, double n2)
    {
        return base.Channel.Add(n1, n2);
    }
}

Partial Public Class CalculatorClient
    Inherits System.ServiceModel.ClientBase(Of ICalculator)
    Implements ICalculator

    Public Sub New()
        MyBase.New
    End Sub

    Public Sub New(ByVal endpointConfigurationName As String)
        MyBase.New(endpointConfigurationName)
    End Sub

    Public Sub New(ByVal endpointConfigurationName As String, ByVal remoteAddress As String)
        MyBase.New(endpointConfigurationName, remoteAddress)
    End Sub

    Public Sub New(ByVal endpointConfigurationName As String,
        ByVal remoteAddress As System.ServiceModel.EndpointAddress)
        MyBase.New(endpointConfigurationName, remoteAddress)
    End Sub

    Public Sub New(ByVal binding As System.ServiceModel.Channels.Binding,
        ByVal remoteAddress As System.ServiceModel.EndpointAddress)
        MyBase.New(binding, remoteAddress)
    End Sub

    Public Function Add(ByVal n1 As Double, ByVal n2 As Double) As Double
        Implements ICalculator.Add
        Return MyBase.Channel.Add(n1, n2)
    End Function
End Class

WCF クライアントの使用

WCF クライアントを使用するには、次のコードのように WCF クライアントのインスタンスを作成し、次にそのメソッドを呼び出します。

// Create a client object with the given client endpoint configuration.
CalculatorClient calcClient = new CalculatorClient("CalculatorEndpoint");
// Call the Add service operation.
double value1 = 100.00D;
double value2 = 15.99D;
double result = calcClient.Add(value1, value2);
Console.WriteLine("Add({0},{1}) = {2}", value1, value2, result);

' Create a client object with the given client endpoint configuration.
Dim calcClient As CalculatorClient = _
New CalculatorClient("CalculatorEndpoint")

' Call the Add service operation.
Dim value1 As Double = 100.00D
Dim value2 As Double = 15.99D
Dim result As Double = calcClient.Add(value1, value2)
Console.WriteLine("Add({0},{1}) = {2}", value1, value2, result)

クライアントによってスローされた例外のデバッグ

WCF クライアントからスローされる例外の多くは、サービスで発生した例外が原因となって引き起こされます。 この例を次にいくつか示します。

  • SocketException: 既存の接続がリモート ホストによって強制終了されました。

  • CommunicationException: 基になる接続が予期せずに閉じられました。

  • CommunicationObjectAbortedException: ソケット接続が中止されました。 これは、メッセージ処理時のエラー、リモート ホストでの受信タイムアウトの超過、または基になるネットワーク リソースの問題が原因で発生する可能性があります。

このような種類の例外が発生した場合、問題を解決するには、サービス側でトレースをオンにし、そこで発生した例外を特定することをお勧めします。 トレースの詳細については、「トレース」と「トレースを使用したアプリケーションのトラブルシューティング」を参照してください。

関連項目