Azure Service Fabric での Reliable Collection オブジェクトのシリアル化

  • [アーティクル]

Reliable Collection では項目がレプリケートおよび永続化されるため、コンピューターの不具合や電源障害が発生しても、これらの項目が影響を受けることはありません。 項目をレプリケートおよび永続化するには、Reliable Collection でシリアル化する必要があります。

Reliable Collection では、Reliable State Manager を使用して、型に適したシリアライザーを取得します。 Reliable State Manager には組み込みのシリアライザーが格納されており、型に応じてカスタムのシリアライザーを登録できます。

組み込みのシリアライザー

Reliable State Manager には一般的な型のための組み込みのシリアライザーが含まれているため、既定で効率的にシリアル化できます。 その他の型については、Reliable State Manager は DataContractSerializer を使用します。 型が変わらないことが明らかで、型の名前などの情報を含める必要がないため、組み込みのシリアライザーの方が効率的です。

Reliable State Manager には、次の型用の組み込みのシリアライザーがあります。

  • Guid
  • [bool]
  • byte
  • sbyte
  • byte[]
  • char
  • string
  • decimal
  • double
  • float
  • INT
  • uint
  • long
  • ulong
  • short
  • ushort

カスタムのシリアル化

カスタムのシリアライザーは通常、パフォーマンスを向上させたり、ネットワーク上とディスクのデータを暗号化したりするために使用します。 その主な理由は、型に関する情報をシリアル化する必要がないため、汎用シリアライザーに比べて、一般的にカスタム シリアライザーの方が効率性に優れているためです。

IReliableStateManager.TryAddStateSerializer<T> を使用して、特定の型 T 用のカスタム シリアライザーを登録します。復元が開始される前にすべての Reliable Collection が適切なシリアライザーにアクセスして永続化されたデータを読み取れるようにするため、この登録は StatefulServiceBase の作成時に行う必要があります。

public StatefulBackendService(StatefulServiceContext context)
  : base(context)
  {
    if (!this.StateManager.TryAddStateSerializer(new OrderKeySerializer()))
    {
      throw new InvalidOperationException("Failed to set OrderKey custom serializer");
    }
  }

Note

カスタム シリアライザーは組み込みのシリアライザーよりも優先されます。 たとえば int 型のカスタム シリアライザーを登録すると、整数のシリアル化には int 型用の組み込みのシリアライザーではなく、カスタム シリアライザーが使用されます。

カスタム シリアライザーの実装方法

カスタム シリアライザーは、IStateSerializer<T> インターフェイスを実装する必要があります。

Note

IStateSerializer<T> には、ベース値と呼ばれる追加の T を受け取る書き込みと読み取りのオーバーロードが含まれています。 この API は差分のシリアル化に使用します。 現在、差分のシリアル化機能は公開されていません。 そのため、差分のシリアル化が公開されて有効になるまで、これら 2 つのオーバーロードは呼び出されません。

4 つのプロパティを含み、OrderKey と呼ばれるカスタムの型の例を次に示します。

public class OrderKey : IComparable<OrderKey>, IEquatable<OrderKey>
{
    public byte Warehouse { get; set; }

    public short District { get; set; }

    public int Customer { get; set; }

    public long Order { get; set; }

    #region Object Overrides for GetHashCode, CompareTo and Equals
    #endregion
}

IStateSerializer<OrderKey> の実装例を次に示します。 baseValue を受け取る読み取りと書き込みのオーバーロードが、上位互換性のためにそれぞれのオーバーロードを呼び出していることに注意してください。

public class OrderKeySerializer : IStateSerializer<OrderKey>
{
  OrderKey IStateSerializer<OrderKey>.Read(BinaryReader reader)
  {
      var value = new OrderKey();
      value.Warehouse = reader.ReadByte();
      value.District = reader.ReadInt16();
      value.Customer = reader.ReadInt32();
      value.Order = reader.ReadInt64();

      return value;
  }

  void IStateSerializer<OrderKey>.Write(OrderKey value, BinaryWriter writer)
  {
      writer.Write(value.Warehouse);
      writer.Write(value.District);
      writer.Write(value.Customer);
      writer.Write(value.Order);
  }
  
  // Read overload for differential de-serialization
  OrderKey IStateSerializer<OrderKey>.Read(OrderKey baseValue, BinaryReader reader)
  {
      return ((IStateSerializer<OrderKey>)this).Read(reader);
  }

  // Write overload for differential serialization
  void IStateSerializer<OrderKey>.Write(OrderKey baseValue, OrderKey newValue, BinaryWriter writer)
  {
      ((IStateSerializer<OrderKey>)this).Write(newValue, writer);
  }
}

アップグレード可能性

アプリケーションのローリング アップグレードでは、アップグレードはノードのサブセットに、一度に 1 つのアップグレード ドメインのみに適用されます。 このプロセス中に、一部のアップグレード ドメインがアプリケーションの新しいバージョンになり、一部のアップグレード ドメインはアプリケーションの以前のバージョンになります。 ロールアウト時に、アプリケーションの新しいバージョンは、古いバージョンのデータを、アプリケーションの古いバージョンは新しいバージョンのデータを読み取ることができる必要があります。 データ形式の上位互換性と下位互換性がない場合は、アップグレードが失敗するか、データが失われたり、破損したりするおそれがあります。

組み込みのシリアライザーを使用している場合は、互換性について心配する必要はありません。 一方、カスタム シリアライザーや DataContractSerializer を使用している場合は、データの下位互換性と上位互換性を確保する必要があります。 つまり各バージョンのシリアライザーは、型のどのバージョンもシリアル化と逆シリアル化ができる必要があります。

データ コントラクト ユーザーは、フィールドの追加、削除、変更用に適切に定義されたバージョン管理規則に従う必要があります。 またデータ コントラクトでは、不明なフィールドの処理、シリアル化と逆シリアル化プロセスへのフッキング、クラスの継承に対するサポートもあります。 詳細については、「データ コントラクトの使用」をご覧ください。

カスタム シリアライザーのユーザーは、下位互換性と上位互換性を確保するために、使用するシリアライザーのガイドラインに従う必要があります。 すべてのバージョンをサポートする一般的な方法は、最初にサイズ情報を追加したら、後はオプションのプロパティ情報のみを追加することです。 こうすることで、各バージョンで可能な限りの読み取りを実行でき、ストリームの残りの部分を省略できます。

次のステップ