既知の型

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

KnownTypes のサンプルでは、データコントラクト内の派生型に関する情報を指定する方法を示します。データコントラクトを使用すると、サービスと構造化データをやり取りできます。オブジェクト指向プログラミングでは、別の型から継承される型を元の型の代わりに使用できます。サービス指向プログラミングでは、型ではなくスキーマが伝達されるので、型と型との関係は保持されません。 KnownTypeAttribute 属性を使用すると、派生型に関する情報をデータコントラクトに含めることができます。この機構を使用しない場合は、基本型が予期される箇所では派生型を送受信できません。

Note

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

サービスのサービスコントラクトでは複素数を使用します。次のサンプルコードを参照してください。

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

DataContractAttribute と DataMemberAttribute は ComplexNumber クラスに適用され、クライアントとサービスの間で渡されるクラスのフィールドを示します。 ComplexNumberWithMagnitude 派生クラスは、ComplexNumber の代わりに使用できます。これは、KnownTypeAttribute 型の ComplexNumber 属性で指定します。

[DataContract(Namespace="http://Microsoft.ServiceModel.Samples")]
[KnownType(typeof(ComplexNumberWithMagnitude))]
public class ComplexNumber
{
    [DataMember]
    public double Real = 0.0D;
    [DataMember]
    public double Imaginary = 0.0D;

    public ComplexNumber(double real, double imaginary)
    {
        this.Real = real;
        this.Imaginary = imaginary;
    }
}

ComplexNumberWithMagnitude 型は ComplexNumber から派生しますが、追加のデータメンバ Magnitude が追加されます。

[DataContract(Namespace="http://Microsoft.ServiceModel.Samples")]
public class ComplexNumberWithMagnitude : ComplexNumber
{
    public ComplexNumberWithMagnitude(double real, double imaginary) :
        base(real, imaginary) { }

    [DataMember]
    public double Magnitude
    {
        get { return Math.Sqrt(Imaginary*Imaginary  + Real*Real); }
        set { throw new NotImplementedException(); }
    }
}

既知の型の機能を示すため、サービスは、加算と減算に対してのみ ComplexNumberWithMagnitude を返すという方法で実装されています。 (コントラクトで ComplexNumber を指定している場合でも、コントラクトの KnownTypeAttribute 属性によりこの実装は許可されます)。乗算と除算では、そのまま基本の ComplexNumber 型が返されます。

public class DataContractCalculatorService : IDataContractCalculator
{
    public ComplexNumber Add(ComplexNumber n1, ComplexNumber n2)
    {
        //Return the derived type.
        return new ComplexNumberWithMagnitude(n1.Real + n2.Real,
                                      n1.Imaginary + n2.Imaginary);
    }

    public ComplexNumber Subtract(ComplexNumber n1, ComplexNumber n2)
    {
        //Return the derived type.
        return new ComplexNumberWithMagnitude(n1.Real - n2.Real,
                                 n1.Imaginary - n2.Imaginary);
    }

    public ComplexNumber Multiply(ComplexNumber n1, ComplexNumber n2)
    {
        double real1 = n1.Real * n2.Real;
        double imaginary1 = n1.Real * n2.Imaginary;
        double imaginary2 = n2.Real * n1.Imaginary;
        double real2 = n1.Imaginary * n2.Imaginary * -1;
        //Return the base type.
        return new ComplexNumber(real1 + real2, imaginary1 +
                                                  imaginary2);
    }

    public ComplexNumber Divide(ComplexNumber n1, ComplexNumber n2)
    {
        ComplexNumber conjugate = new ComplexNumber(n2.Real,
                                     -1*n2.Imaginary);
        ComplexNumber numerator = Multiply(n1, conjugate);
        ComplexNumber denominator = Multiply(n2, conjugate);
        //Return the base type.
        return new ComplexNumber(numerator.Real / denominator.Real,
                                             numerator.Imaginary);
    }
}

クライアントでは、サービスコントラクトとデータコントラクトの両方が、ServiceModel メタデータユーティリティツール (Svcutil.exe) によってサービスメタデータから生成されるソースファイル generatedClient.cs で定義されます。 KnownTypeAttribute 属性はサービスのデータコントラクト内で指定されるので、クライアントはサービスを使用する際に ComplexNumber クラスと ComplexNumberWithMagnitude クラスの両方を受け取ることができます。クライアントは、ComplexNumberWithMagnitude を取得したかどうかを検出し、適切な出力を生成します。

// Create a client
DataContractCalculatorClient client =
    new DataContractCalculatorClient();

// Call the Add service operation.
ComplexNumber value1 = new ComplexNumber() { real = 1, imaginary = 2 };
ComplexNumber value2 = new ComplexNumber() { real = 3, imaginary = 4 };
ComplexNumber result = client.Add(value1, value2);
Console.WriteLine("Add({0} + {1}i, {2} + {3}i) = {4} + {5}i",
    value1.real, value1.imaginary, value2.real, value2.imaginary,
    result.real, result.imaginary);
if (result is ComplexNumberWithMagnitude)
{
    Console.WriteLine("Magnitude: {0}",
        ((ComplexNumberWithMagnitude)result).Magnitude);
}
else
{
    Console.WriteLine("No magnitude was sent from the service");
}

このサンプルを実行する場合は、操作の要求や応答はクライアントのコンソールウィンドウに表示されます。サービスの実装方法により、加算と減算に対しては大きさが出力されますが、乗算と除算に対しては出力されません。クライアントをシャットダウンするには、クライアントウィンドウで Enter キーを押します。

Add(1 + 2i, 3 + 4i) = 4 + 6i
Magnitude: 7.21110255092798
Subtract(1 + 2i, 3 + 4i) = -2 + -2i
Magnitude: 2.82842712474619
Multiply(2 + 3i, 4 + 7i) = -13 + 26i
No magnitude was sent from the service
Divide(3 + 7i, 5 + -2i) = 0.0344827586206897 + 41i
No magnitude was sent from the service

    Press <ENTER> to terminate client.

サンプルをセットアップ、ビルド、および実行するには

Windows Communication Foundation サンプルの 1 回限りのセットアップの手順を実行したことを確認します。
ソリューションの C# 版または Visual Basic .NET 版をビルドするには、「 Building the Windows Communication Foundation Samples」の手順に従います。
単一または複数コンピューター構成でサンプルを実行するには、「Windows Communication Foundation サンプルの実行」の手順に従います。

次の方法で共有

既知の型

サンプルをセットアップ、ビルド、および実行するには

その他のリソース