データ コントラクトのバージョン管理

  • [アーティクル]

アプリケーションの進化に伴って、サービスが使用するデータ コントラクトを変更することが必要になる場合があります。 ここでは、データ コントラクトをバージョン管理する方法について説明します。 データ コントラクトのバージョン管理のメカニズムについても説明します。 バージョン管理全般の概要および規範となるガイダンスについては、「ベスト プラクティス: データ コントラクトのバージョン管理」を参照してください。

互換性に影響する変更と影響しない変更

データ コントラクトへの変更には、互換性に影響するものと影響しないものとがあります。 互換性に影響しない方法でデータ コントラクトを変更すると、古いバージョンのコントラクトを使用するアプリケーションは新しいバージョンを使用するアプリケーションと通信できます。また、新しいバージョンを使用するアプリケーションも古いバージョンを使用するアプリケーションと通信できます。 一方、互換性に影響する変更では、一方向または双方向で通信できなくなります。

型を変更してもその送受信方法に影響しない場合は、互換性に影響しない変更と呼びます。 このような変更では、データ コントラクトは変更されず、基になる型のみが変更されます。 たとえば、フィールドの名前を変更した後で Name の DataMemberAttribute プロパティを以前のバージョン名に設定すれば、互換性に影響しません。 次のコードに、バージョン 1 のデータ コントラクトを示します。

// Version 1
[DataContract]
public class Person
{
    [DataMember]
    private string Phone;
}

' Version 1
<DataContract()> _
Public Class Person
    <DataMember()> _
    Private Phone As String
End Class

互換性に影響しない変更を次のコードに示します。

// Version 2. This is a non-breaking change because the data contract
// has not changed, even though the type has.
[DataContract]
public class Person
{
    [DataMember(Name = "Phone")]
    private string Telephone;
}

' Version 2. This is a non-breaking change because the data contract 
' has not changed, even though the type has.
<DataContract()> _
Public Class Person
    <DataMember(Name:="Phone")> _
    Private Telephone As String
End Class

変更によっては、送信されるデータを変更しても、必ずしも互換性に影響しない場合もあります。 次の変更は常に互換性に影響します。

  • データ コントラクトの Name 値または Namespace 値の変更。

  • Order の DataMemberAttribute プロパティを使用したデータ メンバーの順序の変更。

  • データ メンバーの名前の変更。

  • データ メンバーのデータ コントラクトの変更 (たとえば、データ メンバーの型を整数型から文字列型に変更したり、"Customer" という名前のデータ コントラクトを持つ型を "Person" という名前のデータ コントラクトを持つ型に変更したりするなど)。

以下のような変更も考えられます。

データ メンバーの追加と削除

厳密なスキーマ検証 (古いスキーマに基づく新しいインスタンスの検証) が必要ではない限り、多くの場合、データ メンバーの追加または削除は互換性に影響する変更ではありません。

追加のフィールドを持つ型が、そのフィールドを持たない型に逆シリアル化された場合、追加のフィールドにある情報は無視されます (ラウンド トリップのために、この情報が保存される場合もあります。詳細については、「上位互換性のあるデータ コントラクト」を参照してください)。

一部のフィールドが足りない型が、追加のフィールドを持つ型に逆シリアル化された場合、追加のフィールドは既定値 (通常はゼロまたは null) のままになります (既定値は変更される場合があります。詳細については、「バージョン トレラントなシリアル化コールバック」を参照してください)。

たとえば、クライアントで CarV1 クラスを使用し、サービスで CarV2 クラスを使用することも、サービスで CarV1 クラスを使用し、クライアントで CarV2 クラスを使用することもできます。

// Version 1 of a data contract, on machine V1.
[DataContract(Name = "Car")]
public class CarV1
{
    [DataMember]
    private string Model;
}

// Version 2 of the same data contract, on machine V2.
[DataContract(Name = "Car")]
public class CarV2
{
    [DataMember]
    private string Model;

    [DataMember]
    private int HorsePower;
}

' Version 1 of a data contract, on machine V1.
<DataContract(Name:="Car")> _
Public Class CarV1
    <DataMember()> _
    Private Model As String
End Class

' Version 2 of the same data contract, on machine V2.
<DataContract(Name:="Car")> _
Public Class CarV2
    <DataMember()> _
    Private Model As String

    <DataMember()> _
    Private HorsePower As Integer
End Class

バージョン 2 のエンドポイントからバージョン 1 のエンドポイントに正常にデータを送信できます。 Car データ コントラクトのバージョン 2 をシリアル化すると、次のような XML が生成されます。

<Car>  
    <Model>Porsche</Model>  
    <HorsePower>300</HorsePower>  
</Car>

バージョン 1 の逆シリアル化エンジンでは、HorsePower フィールドに一致するデータ メンバーを見つけられないため、データは破棄されます。

また、バージョン 1 のエンドポイントからバージョン 2 のエンドポイントにデータを送信することもできます。 Car データ コントラクトのバージョン 1 をシリアル化すると、次のような XML が生成されます。

<Car>  
    <Model>Porsche</Model>  
</Car>

受信 XML に一致するデータがないため、バージョン 2 のデシリアライザーでは HorsePower フィールドを何に設定するのか判別できません。 そのため、このフィールドには既定値である 0 が設定されます。

必須データ メンバー

IsRequired の DataMemberAttribute プロパティを true に設定すると、データ メンバーを必須のデータ メンバーとしてマークできます。 逆シリアル化中に必須データがない場合、データ メンバーは既定値に設定されず、代わりに例外がスローされます。

必須のデータ メンバーの追加は、互換性に影響する変更です。 つまり、新しい型を古い型のエンドポイントに送信することはできますが、その逆はできなくなります。 以前のバージョンで必須としてマークされていたデータ メンバーを削除することも、互換性に影響する変更です。

IsRequired プロパティの値を true から false に変更することは互換性に影響しませんが、false から true に変更すると、これよりも以前のいずれかのバージョンの型にこのデータ メンバーが存在していない場合、互換性に影響することがあります。

Note

IsRequired プロパティが true に設定されていても、受信データは NULL またはゼロの場合があるので、型ではこの可能性を処理できるようにしておく必要があります。 不適切な受信データに対するセキュリティ保護メカニズムとして IsRequired を使用しないでください。

既定値の省略

「データ メンバーの既定値」で説明したように、DataMemberAttribute 属性の EmitDefaultValue プロパティを false に設定できます (ただし、この設定はお勧めしません)。 このプロパティが false に設定されている場合、データ メンバーが既定値 (通常 NULL またはゼロ) に設定されていても、そのデータ メンバーは出力されません。 これにより、次の 2 つの点で、異なるバージョンの必須データ メンバーの互換性が失われます。

  • あるバージョンで必須になっているデータ メンバーを持つデータ コントラクトは、データ メンバーの EmitDefaultValue が false に設定されている別のバージョンから既定 (NULL またはゼロ) のデータを受信できません。

  • EmitDefaultValue が false に設定されている必須データ メンバーは、既定値 (NULL またはゼロ) をシリアル化で使用できませんが、逆シリアル化ではこのような値を受信できます。 これによりラウンド トリップの問題が発生します (データを読み取ることはできますが、書き込むことができません)。 そのため、あるバージョンにおいて IsRequired が true であり、EmitDefaultValue が false である場合、どのバージョンのデータ コントラクトにおいてもラウンド トリップを発生させる値を生成できるように、これ以外のすべてのバージョンに同じ組み合わせを適用する必要があります。

スキーマの考慮事項

データ コントラクト型用に生成されるスキーマについては、「データ コントラクト スキーマの参照」を参照してください。

データ コントラクト型用に WCF で生成されるスキーマは、バージョン管理に対応していません。 つまり、あるバージョンの型からエクスポートされたスキーマには、そのバージョンに存在するデータ メンバーのみが含まれます。 IExtensibleDataObject インターフェイスを実装しても、型のスキーマは変更されません。

データ メンバーは、既定でオプション要素としてスキーマにエクスポートされます。 つまり、minOccurs (XML 属性) の値は 0 に設定されています。 minOccurs を 1 に設定した場合、必須データ メンバーがエクスポートされます。

スキーマを厳密に遵守する必要がある場合、互換性に影響しないと思われる変更の多くが、実際には互換性に影響します。 前述の例では、CarV1 要素だけを持つ Model インスタンスは、CarV2 スキーマ (Model と Horsepower の 2 つの要素を持ちますが、いずれも省略可能です) に対して有効です。 しかし、この逆は真ではありません。つまり、CarV2 インスタンスは CarV1 スキーマに対して検証が失敗します。

ラウンド トリップにもいくつかの考慮事項があります。 詳細については、「上位互換性のあるデータ コントラクト」のスキーマの考慮事項に関するセクションを参照してください。

許可されるその他の変更

IExtensibleDataObject インターフェイスの実装は、互換性に影響しない変更です。 ただし、IExtensibleDataObject が実装されていた型のバージョンより前のバージョンでは、ラウンド トリップはサポートされていません。 詳細については、「上位互換性のあるデータ コントラクト」を参照してください。

列挙

列挙体メンバーの追加や削除は、互換性に影響する変更です。 EnumMemberAttribute 属性を使用して古いバージョンのコントラクト名を保持しない限り、列挙体メンバーの名前の変更は互換性に影響します。 詳細については、「データ コントラクトの列挙型」を参照してください。

コレクション

コレクション型の大半はデータ コントラクト モデル内で交換可能であるため、多くの場合、コレクションの変更は互換性に影響しません。 ただし、カスタマイズされていないコレクションからカスタマイズされたコレクションへの変更またはその逆の変更は、互換性に影響する変更です。 また、コレクションのカスタマイズ設定の変更 (データ コントラクトの名前と名前空間の変更、要素名、キー要素名、および値要素名の反復) も互換性に影響します。 コレクションのカスタマイズの詳細については、「データ コントラクトのコレクション型」を参照してください。
また、コレクションの内容のデータ コントラクトの変更 (整数のリストから文字列のリストへの変更など) は互換性に影響する変更です。

関連項目