WCF モニカーの COM クライアントと組み合わせての使用

  • [アーティクル]

COM サンプルでは、Windows Communication Foundation (WCF) サービス モニカーを使用して、COM ベースの開発環境 (Microsoft Office Visual Basic for Applications (Office VBA) や Visual Basic 6.0 など) に Web サービスを統合する方法を示します。 このサンプルは、Windows スクリプト ホストのクライアント (.vbs)、サポート クライアント ライブラリ (.dll)、およびインターネット インフォメーション サービス (IIS) でホストされるサービス ライブラリ (.dll) で構成されています。 このサービスは電卓サービスの 1 つであり、COM クライアントはサービスの算術演算 (Add、Subtract、Multiply、および Divide) を呼び出します。 クライアント アクティビティは、メッセージ ボックス ウィンドウに表示されます。

Note

このサンプルのセットアップ手順とビルド手順については、このトピックの最後を参照してください。

サービスは、次に示すコード例で定義される ICalculator コントラクトを実装します。

[ServiceContract(Namespace="http://Microsoft.ServiceModel.Samples")]
public interface ICalculator
{
    [OperationContract]
    double Add(double n1, double n2);
    [OperationContract]
    double Subtract(double n1, double n2);
    [OperationContract]
    double Multiply(double n1, double n2);
    [OperationContract]
    double Divide(double n1, double n2);
}

このサンプルでは、モニカーを使用するための次の 3 つの代替方法を示します。

  • 型指定のあるコントラクト - クライアント コンピューターで COM から参照できる型として登録されます。

  • WSDL コントラクト - WSDL ドキュメントという形で供給されます。

  • Metadata Exchange コントラクト – このコントラクトは、実行時に Metadata Exchange (MEX) エンドポイントから取得されます。

型指定のあるコントラクト

型指定のあるコントラクトと共にモニカーを使用するには、属性が適切に設定されているサービス コントラクトの型を COM に登録する必要があります。 まず、ServiceModel メタデータ ユーティリティ ツール (Svcutil.exe) を使用してクライアントを生成する必要があります。 次のコマンドをクライアント ディレクトリでコマンド プロンプトから実行して、型指定のあるプロキシを生成します。

svcutil.exe /n:http://Microsoft.ServiceModel.Samples,Microsoft.ServiceModel.Samples http://localhost/servicemodelsamples/service.svc /out:generatedClient.cs

このクラスはプロジェクトに含まれている必要があり、そのプロジェクトは、COM から参照できる署名付きのアセンブリをコンパイル時に生成するように構成されている必要があります。 AssemblyInfo.cs ファイルには次の属性を含める必要があります。

[assembly: ComVisible(true)]

プロジェクトをビルドしたら、次の例で示すように regasm を使用して、COM から参照できる型を登録します。

regasm.exe /tlb:CalcProxy.tlb client.dll

作成されたアセンブリは、グローバル アセンブリ キャッシュに追加する必要があります。 必要性は強くありませんが、これによってアセンブリを検索するランタイムのプロセスが簡略化されます。 グローバル アセンブリ キャッシュにアセンブリを追加するコマンドを次に示します。

gacutil.exe /i client.dll

注意

サービス モニカーで必要なのは型の登録だけであり、サービスと通信するためのプロキシは使用されません。

ComCalcClient.vbs クライアント アプリケーションは、サービス モニカーの構文を使用してサービスのアドレス、バインディング、およびコントラクトを指定し、GetObject 関数を使用してサービスのプロキシを構築します。

Set typedServiceMoniker = GetObject(
"service4:address=http://localhost/ServiceModelSamples/service.svc, binding=wsHttpBinding,
contractType={9213C6D2-5A6F-3D26-839B-3BA9B82228D3}")

モニカーが使用するパラメーターでの指定:

  • サービス エンドポイントのアドレス。

  • エンドポイントとの接続にクライアントが使用する必要のあるバインディング。 クライアントの構成ファイルにはカスタム バインドを定義できますが、この場合はシステム定義の wsHttpBinding を使用します。 Windows スクリプト ホストで使用する場合、カスタム バインディングは、Cscript.exe と同じディレクトリにある Cscript.exe.config で定義されます。

  • エンドポイントでサポートされるコントラクトの型。 これは上の手順で生成され、登録された型です。 Visual Basic スクリプトには厳密に型指定された COM 環境がないので、コントラクトの識別子を指定する必要があります。 この GUID は CalcProxy.tlb からの interfaceID で、OLE/COM オブジェクト ビューアー (OleView.exe) などの COM ツールを使用して表示できます。 Office VBA や Visual Basic 6.0 などの厳密に型指定された環境では、コントラクト パラメーターを使用する代わりに、タイプ ライブラリへの明示的な参照を追加してからプロキシ オブジェクトの型を宣言できます。 これにより、クライアント アプリケーションの開発中に IntelliSense のサポートも提供されます。

サービス モニカーを使用してプロキシ インスタンスを構築しておくと、クライアント アプリケーションはプロキシでメソッドを呼び出すことができます。これにより、対応するサービス操作を呼び出すサービス モニカー インフラストラクチャは次のようになります。

' Call the service operations using the moniker object
WScript.Echo "Typed service moniker: 100 + 15.99 = " & typedServiceMoniker.Add(100, 15.99)

サンプルを実行すると、操作の応答が Windows スクリプト ホストのメッセージ ボックス ウィンドウに表示されます。 これは、WCF サービスと通信するために型指定のあるモニカーを使用して COM 呼び出しを行う COM クライアントを示しています。 クライアント アプリケーションでは COM が使用されますが、サービスとの通信は Web サービス呼び出しのみで構成されます。

WSDL コントラクト

WSDL コントラクトと共にモニカーを使用するには、クライアント ライブラリを登録する必要はありません。ただし、ブラウサを使用してサービスの WSDL エンドポイントにアクセスするなど、帯域外機構を通じてサービスの WSDL コントラクトを取得する必要があります。 これにより、モニカーは実行時にそのコントラクトにアクセスできるようになります。

ComCalcClient.vbs クライアント アプリケーションは、次のように FileSystemObject を使用してローカルに保存されている WSDL ファイルにアクセスし、その後 GetObject 関数を再度使用してサービスのプロキシを構築します。

' Open the WSDL contract file and read it all into the wsdlContract string
Const ForReading = 1
Set objFSO = CreateObject("Scripting.FileSystemObject")
Set objFile = objFSO.OpenTextFile("serviceWsdl.xml", ForReading)
wsdlContract = objFile.ReadAll
objFile.Close

' Create a string for the service moniker including the content of the WSDL contract file
wsdlMonikerString = "service4:address='http://localhost/ServiceModelSamples/service.svc'"
wsdlMonikerString = wsdlMonikerString + ", binding=WSHttpBinding_ICalculator, bindingNamespace='http://Microsoft.ServiceModel.Samples'"
wsdlMonikerString = wsdlMonikerString + ", wsdl='" & wsdlContract & "'"
wsdlMonikerString = wsdlMonikerString + ", contract=ICalculator, contractNamespace='http://Microsoft.ServiceModel.Samples'"

' Create the service moniker object
Set wsdlServiceMoniker = GetObject(wsdlMonikerString)

モニカーが使用するパラメーターでの指定:

  • サービス エンドポイントのアドレス。

  • そのエンドポイントと接続するためにクライアントが使用する必要があるバインディングと、そのバインディングが定義されている名前空間。 この場合、wsHttpBinding_ICalculator が使用されます。

  • コントラクトを定義する WSDL。 この場合は、サービスの Wsdl.xml ファイルから読み取られた文字列です。

  • コントラクトの名前と名前空間。 WSDL に複数のコントラクトが含まれている場合があるので、識別情報が必要です。

    注意

    既定では、WCF サービスでは、使用される名前空間ごとに異なる WSDL ファイルが生成されます。 これらのファイルは、WSDL インポート コンストラクターを使用してリンクされます。 モニカーでは単一の WSDL 定義が想定されているので、サービスはこのサンプルで示すように単一の名前空間を使用するか、または別のファイルを手動でマージする必要があります。

サービス モニカーを使用してプロキシ インスタンスを構築しておくと、クライアント アプリケーションはプロキシでメソッドを呼び出すことができます。これにより、対応するサービス操作を呼び出すサービス モニカー インフラストラクチャは次のようになります。

' Call the service operations using the moniker object
WScript.Echo "WSDL service moniker: 145 - 76.54 = " & wsdlServiceMoniker.Subtract(145, 76.54)

サンプルを実行すると、操作の応答が Windows スクリプト ホストのメッセージ ボックス ウィンドウに表示されます。 これは、WCF サービスと通信するために WSDL コントラクトと共にモニカーを使用して COM 呼び出しを行う COM クライアントを示してます。

Metadata Exchange コントラクト

MEX コントラクトと共にモニカーを使用するには、WSDL コントラクトと同様、クライアント登録は必要ありません。 サービスのコントラクトは、実行時に Metadata Exchange を内部使用して取得されます。

ComCalcClient.vbs クライアント アプリケーションは次のように GetObject 関数を再度使用して、サービスのプロキシを構築します。

' Create a string for the service moniker specifying the address to retrieve the service metadata from
mexMonikerString = "service4:mexAddress='http://localhost/servicemodelsamples/service.svc/mex'"
mexMonikerString = mexMonikerString + ", address='http://localhost/ServiceModelSamples/service.svc'"
mexMonikerString = mexMonikerString + ", binding=WSHttpBinding_ICalculator, bindingNamespace='http://Microsoft.ServiceModel.Samples'"
mexMonikerString = mexMonikerString + ", contract=ICalculator, contractNamespace='http://Microsoft.ServiceModel.Samples'"

' Create the service moniker object
Set mexServiceMoniker = GetObject(mexMonikerString)

モニカーが使用するパラメーターでの指定:

  • サービスの Metadata Exchange エンドポイントのアドレス。

  • サービス エンドポイントのアドレス。

  • そのエンドポイントと接続するためにクライアントが使用する必要があるバインディングと、そのバインディングが定義されている名前空間。 この場合、wsHttpBinding_ICalculator が使用されます。

  • コントラクトの名前と名前空間。 WSDL に複数のコントラクトが含まれている場合があるので、識別情報が必要です。

サービス モニカーを使用してプロキシ インスタンスを構築しておくと、クライアント アプリケーションはプロキシでメソッドを呼び出すことができます。これにより、対応するサービス操作を呼び出すサービス モニカー インフラストラクチャは次のようになります。

' Call the service operations using the moniker object
WScript.Echo "MEX service moniker: 9 * 81.25 = " & mexServiceMoniker.Multiply(9, 81.25)

サンプルを実行すると、操作の応答が Windows スクリプト ホストのメッセージ ボックス ウィンドウに表示されます。 これは、WCF サービスと通信するために MEX コントラクトと共にモニカーを使用して COM 呼び出しを行う COM クライアントを示しています。

サンプルをセットアップしてビルドするには

  1. Windows Communication Foundation サンプルの 1 回限りのセットアップの手順を実行したことを確認します。

  2. ソリューションの C# 版または Visual Basic .NET 版をビルドするには、「 Building the Windows Communication Foundation Samples」の手順に従います。

  3. Visual Studio の開発者コマンド プロンプトで、言語固有のフォルダーの下にある \client\bin フォルダーを開きます。

    注意

    Windows Vista、Windows Server 2008、Windows 7、または Windows Server 2008 R2 を使用している場合は、コマンド プロンプトを管理者権限で実行していることを確認します。

  4. 「tlbexp.exe client.dll /out:CalcProxy.tlb」と入力して、dll を tlb ファイルにエクスポートします。 "タイプ ライブラリ エクスポーターの警告" が表示されることが予想されますが、ジェネリック型は不要なので問題にはなりません。

  5. 「regasm.exe /tlb:CalcProxy.tlb client.dll」と入力して、型を COM に登録します。 "タイプ ライブラリ エクスポーターの警告" が表示されることが予想されますが、ジェネリック型は不要なので問題にはなりません。

  6. 「gacutil.exe /i client.dll」と入力して、アセンブリをグローバル アセンブリ キャッシュに追加します。

サンプルを同じコンピューターで実行するには

  1. 次のアドレスを入力して、ブラウザーを使用してサービスにアクセスできることをテストします: http://localhost/servicemodelsamples/service.svc。 これに応答して、確認ページが表示されます。

  2. 言語固有のフォルダーの下の \client にある ComCalcClient.vbs を実行します。 クライアント アクティビティがメッセージ ボックス ウィンドウに表示されます。

  3. クライアントとサービスの間で通信できない場合は、WCF サンプルのトラブルシューティングのヒントに関するページをご覧ください。

サンプルを複数のコンピューターで実行するには

  1. サービス コンピューターで、ServiceModelSamples という仮想ディレクトリを作成します。 サンプルに含まれている Setupvroot.bat スクリプトを使用して、ディスク ディレクトリと仮想ディレクトリを作成できます。

  2. サービス プログラム ファイルを %SystemDrive%\Inetpub\wwwroot\servicemodelsamples からサービス コンピューターの ServiceModelSamples 仮想ディレクトリにコピーします。 \bin ディレクトリのファイルが含まれていることを確認してください。

  3. クライアント スクリプト ファイルを、言語固有のフォルダーにある \client フォルダーからクライアント コンピューターにコピーします。

  4. このスクリプト ファイルで、エンドポイント定義のアドレス値をサービスの新しいアドレスに変更します。 アドレスの "localhost" への参照をすべて完全修飾ドメイン名に置き換えます。

  5. WSDL ファイルをクライアント コンピューターにコピーします。 WSDL ファイルのサービスの Wsdl.xml で、アドレスの "localhost" への参照をすべて完全修飾ドメイン名に置き換えます。

  6. Client.dll ライブラリを、言語固有のフォルダーにある \client\bin\ フォルダーからクライアント コンピューターのディレクトリにコピーします。

  7. コマンド プロンプトで、クライアント コンピューターのコピー先ディレクトリに移動します。 Windows Vista または Windows Server 2008 を使用している場合は、必ず管理者としてコマンド プロンプトを実行してください。

  8. 「tlbexp.exe client.dll /out:CalcProxy.tlb」と入力して、dll を tlb ファイルにエクスポートします。 "タイプ ライブラリ エクスポーターの警告" が表示されることが予想されますが、ジェネリック型は不要なので問題にはなりません。

  9. 「regasm.exe /tlb:CalcProxy.tlb client.dll」と入力して、型を COM に登録します。 このコマンドを実行する前に、パスが regasm.exe を含むフォルダーに設定されていることを確認します。

  10. 「gacutil.exe /i client.dll」と入力して、アセンブリをグローバル アセンブリ キャッシュに追加します。 このコマンドを実行する前に、パスが gacutil.exe を含むフォルダーに設定されていることを確認します。

  11. ブラウザーを使用して、サービスにクライアント コンピューターからアクセスできるかどうかをテストします。

  12. クライアント コンピューターで ComCalcClient.vbs を起動します。

サンプルの実行後にクリーンアップするには

セキュリティの目的で、サンプルの使用が終わったら、このセットアップで付与された仮想ディレクトリの定義とアクセス許可を削除してください。