方法: メタデータの取得および準拠サービスの実装をする

[アーティクル]
04/07/2023

サービスのデザイン担当者と実装担当者が同じであるとは限りません。アプリケーションの相互運用が重要な環境では、コントラクトを Web サービス記述言語 (WSDL) でデザインまたは記述した場合、開発者はそのコントラクトに準拠するサービスを実装する必要があります。既存のサービスを Windows Communication Foundation (WCF) に移行することもできますが、その物理メッセージフォーマットを維持しなければなりません。さらに、双方向コントラクトでは、呼び出し元でコールバックコントラクトを実装する必要もあります。

このような場合は、ServiceModel メタデータユーティリティツール (Svcutil.exe) (または同等のツール) を使用して、サービスコントラクトインターフェイスを実装可能なマネージド言語で生成し、コントラクトの要件を満たす必要があります。通常、ServiceModel メタデータユーティリティツール (Svcutil.exe) を使用して、チャネルファクトリまたは WCF クライアント型で使用されるサービスコントラクトや、正しいバインディングとアドレスを設定するクライアント構成ファイルで使用されるサービスコントラクトを取得します。生成された構成ファイルを使用するには、それをサービスの構成ファイルに変更する必要があります。また、サービスコントラクトを変更する必要もあります。

データを取得して準拠サービスを実装するには

メタデータファイルまたはメタデータのエンドポイントに対して ServiceModel メタデータユーティリティツール (Svcutil.exe) を使用してコードファイルを生成します。

出力コードファイルを検索し、System.ServiceModel.ServiceContractAttribute 属性でマークされた対象のインターフェイス (複数ある場合) 部分を見つけます。次のコード例は、ServiceModel メタデータユーティリティツール (Svcutil.exe) で生成された 2 つのインターフェイスを示しています。最初の例 (ISampleService) は、準拠サービスを作成するために実装するサービスコントラクトインターフェイスです。 2 番目の例 (ISampleServiceChannel) は、サービスコントラクトインターフェイスと System.ServiceModel.IClientChannel の両方を拡張するクライアント用のヘルパーインターフェイスです。これはクライアントアプリケーションでも使用されます。

[System.CodeDom.Compiler.GeneratedCodeAttribute("System.ServiceModel", "3.0.0.0")]
[System.ServiceModel.ServiceContractAttribute(
  Namespace="http://microsoft.wcf.documentation"
)]
public interface ISampleService
{

    [System.ServiceModel.OperationContractAttribute(
      Action="http://microsoft.wcf.documentation/ISampleService/SampleMethod",
      ReplyAction="http://microsoft.wcf.documentation/ISampleService/SampleMethodResponse"
    )]
    [System.ServiceModel.FaultContractAttribute(
      typeof(microsoft.wcf.documentation.SampleFault),
      Action="http://microsoft.wcf.documentation/ISampleService/SampleMethodSampleFaultFault"
    )]
    string SampleMethod(string msg);
}

[System.CodeDom.Compiler.GeneratedCodeAttribute("System.ServiceModel", "3.0.0.0")]
public interface ISampleServiceChannel : ISampleService, System.ServiceModel.IClientChannel
{
}

すべての操作に対する応答アクションを WSDL で指定していない場合、生成後の操作コントラクトでは、ReplyAction プロパティがワイルドカード文字 (*) に設定される場合があります。このプロパティの設定を削除します。削除しない場合は、サービスコントラクトメタデータを実装するときに、それらの操作のメタデータをエクスポートできません。
クラスにインターフェイスを実装してサービスをホストします。例については、「方法: サービスコントラクトを実装する」を参照するか、以下の「使用例」にある簡単な実装を参照してください。
ServiceModel メタデータユーティリティツール (Svcutil.exe) によって生成されたクライアント構成ファイルで、<client> 構成セクションを <services> 構成セクションに変更します (生成されたクライアントアプリケーション構成ファイルの例については、次の例を参照してください)。
<services> 構成セクション内で、name 属性をサービス実装の <services> 構成セクションに作成します。
サービスの name 属性をユーザーのサービス実装の構成名に設定します。
実装するサービスコントラクトを使用するエンドポイント構成要素をサービス構成セクションに追加します。

例

次のコード例には、メタデータファイルに対して ServiceModel メタデータユーティリティツール (Svcutil.exe) を実行して生成されたコードファイルの大部分が示されています。

このコードには、次の項目が示されています。

コントラクトの要件に準拠するサービスコントラクトインターフェイス (実装する場合) (ISampleService)。
サービスコントラクトインターフェイスと System.ServiceModel.IClientChannel の両方を拡張するクライアント用のヘルパーインターフェイス。これはクライアントアプリケーションでも使用されます(ISampleServiceChannel)。
System.ServiceModel.ClientBase<TChannel> を拡張するヘルパークラス。クライアントアプリケーションで使用されます。(SampleServiceClient)
サービスから生成された構成ファイル。
ISampleService サービスの簡単な実装。
クライアント側の構成ファイルからサービス側バージョンへの変換。

//------------------------------------------------------------------------------
// <auto-generated>
//     This code was generated by a tool.
//     Runtime Version:2.0.50727.42
//
//     Changes to this file may cause incorrect behavior and will be lost if
//     the code is regenerated.
// </auto-generated>
//------------------------------------------------------------------------------

[assembly: System.Runtime.Serialization.ContractNamespaceAttribute("http://microsoft.wcf.documentation", ClrNamespace="microsoft.wcf.documentation")]

namespace microsoft.wcf.documentation
{
    using System.Runtime.Serialization;

    [System.CodeDom.Compiler.GeneratedCodeAttribute("System.Runtime.Serialization", "3.0.0.0")]
    [System.Runtime.Serialization.DataContractAttribute()]
    public partial class SampleFault : object, System.Runtime.Serialization.IExtensibleDataObject
    {

        private System.Runtime.Serialization.ExtensionDataObject extensionDataField;

        private string FaultMessageField;

        public System.Runtime.Serialization.ExtensionDataObject ExtensionData
        {
            get
            {
                return this.extensionDataField;
            }
            set
            {
                this.extensionDataField = value;
            }
        }

        [System.Runtime.Serialization.DataMemberAttribute()]
        public string FaultMessage
        {
            get
            {
                return this.FaultMessageField;
            }
            set
            {
                this.FaultMessageField = value;
            }
        }
    }
}

[System.CodeDom.Compiler.GeneratedCodeAttribute("System.ServiceModel", "3.0.0.0")]
[System.ServiceModel.ServiceContractAttribute(
  Namespace="http://microsoft.wcf.documentation"
)]
public interface ISampleService
{

    [System.ServiceModel.OperationContractAttribute(
      Action="http://microsoft.wcf.documentation/ISampleService/SampleMethod",
      ReplyAction="http://microsoft.wcf.documentation/ISampleService/SampleMethodResponse"
    )]
    [System.ServiceModel.FaultContractAttribute(
      typeof(microsoft.wcf.documentation.SampleFault),
      Action="http://microsoft.wcf.documentation/ISampleService/SampleMethodSampleFaultFault"
    )]
    string SampleMethod(string msg);
}

[System.CodeDom.Compiler.GeneratedCodeAttribute("System.ServiceModel", "3.0.0.0")]
public interface ISampleServiceChannel : ISampleService, System.ServiceModel.IClientChannel
{
}

[System.CodeDom.Compiler.GeneratedCodeAttribute("System.ServiceModel", "3.0.0.0")]
public partial class SampleServiceClient : System.ServiceModel.ClientBase<ISampleService>, ISampleService
{

    public SampleServiceClient()
    {
    }

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

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

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

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

    public string SampleMethod(string msg)
    {
        return base.Channel.SampleMethod(msg);
    }
}

<configuration>
    <system.serviceModel>
        <bindings>
            <basicHttpBinding>
                <binding name="BasicHttpBinding_ISampleService" closeTimeout="00:01:00"
                    openTimeout="00:01:00" receiveTimeout="00:10:00" sendTimeout="00:01:00"
                    allowCookies="false" bypassProxyOnLocal="false" hostNameComparisonMode="StrongWildcard"
                    maxBufferSize="65536" maxBufferPoolSize="524288" maxReceivedMessageSize="65536"
                    messageEncoding="Text" textEncoding="utf-8" transferMode="Buffered"
                    useDefaultWebProxy="true">
                    <readerQuotas maxDepth="32" maxStringContentLength="8192" maxArrayLength="16384"
                        maxBytesPerRead="4096" maxNameTableCharCount="16384" />
                    <security mode="None">
                        <transport clientCredentialType="None" proxyCredentialType="None"
                            realm="" />
                        <message clientCredentialType="UserName" algorithmSuite="Default" />
                    </security>
                </binding>
            </basicHttpBinding>
        </bindings>
        <client>
            <endpoint address="http://localhost:8080/SampleService" binding="basicHttpBinding"
                bindingConfiguration="BasicHttpBinding_ISampleService" contract="ISampleService"
                name="BasicHttpBinding_ISampleService" />
        </client>
    </system.serviceModel>
</configuration>

// Implement the service. This is a very simple service.
class SampleService : ISampleService
{
  public string SampleMethod(string msg)
  {
    Console.WriteLine("The caller said: \"{0}\"", msg);
    return "The service greets you: " + msg;
  }
}

<configuration>
  <system.serviceModel>
    <bindings>
      <basicHttpBinding>
        <binding name="BasicHttpBinding_ISampleService" closeTimeout="00:01:00"
            openTimeout="00:01:00" receiveTimeout="00:10:00" sendTimeout="00:01:00"
            allowCookies="false" bypassProxyOnLocal="false" hostNameComparisonMode="StrongWildcard"
            maxBufferSize="65536" maxBufferPoolSize="524288" maxReceivedMessageSize="65536"
            messageEncoding="Text" textEncoding="utf-8" transferMode="Buffered"
            useDefaultWebProxy="true">
          <readerQuotas maxDepth="32" maxStringContentLength="8192" maxArrayLength="16384"
              maxBytesPerRead="4096" maxNameTableCharCount="16384" />
          <security mode="None">
            <transport clientCredentialType="None" proxyCredentialType="None"
                realm="" />
            <message clientCredentialType="UserName" algorithmSuite="Default" />
          </security>
        </binding>
      </basicHttpBinding>
    </bindings>
    <services>
      <service
          name="Microsoft.WCF.Documentation.SampleService">
        <endpoint address="http://localhost:8080/SampleService" binding="basicHttpBinding"
            bindingConfiguration="BasicHttpBinding_ISampleService" contract="Microsoft.WCF.Documentation.ISampleService"
            />
      </service>
    </services>
  </system.serviceModel>
</configuration>

方法: メタデータの取得および準拠サービスの実装をする

データを取得して準拠サービスを実装するには

例

関連項目

その他のリソース