Azure モバイル アプリでのオフライン データ同期

  • [アーティクル]

オフライン データ同期について

オフライン データ同期は、ネットワーク接続なしで機能するアプリを開発者が作成しやすくする、Azure モバイル アプリのクライアントおよびサーバーの SDK 機能です。

アプリがオフライン モードの場合でもデータを作成および変更できますが、それらのデータはローカル ストアに保存されます。 アプリは、オンラインに復帰するとローカルの変更内容を Azure モバイル アプリ バックエンドと同期します。 この機能には、クライアントとバックエンドの両方で同じレコードが変更された場合の競合検出のサポートも含まれています。 検出された競合は、サーバーまたはクライアントのどちらでも処理することができます。

オフライン同期には、次のような複数の利点があります。

  • サーバー データをデバイスにローカルでキャッシュすることにより、アプリケーションの応答性を向上させる。
  • ネットワークの問題がある場合でも使用可能な信頼性の高いアプリを作成する。
  • エンド ユーザーがネットワークにアクセスできなくてもデータを作成および変更できるようにすることで、接続がほとんどまたはまったく得られないような状況をサポートする。
  • 複数のデバイス間でデータを同期させ、同じレコードが 2 つのデバイスによって変更されたときに競合を検出する。
  • 待ち時間の長いネットワークや従量制ネットワークの使用を制限する。

以下のチュートリアルで、Azure モバイル アプリ を使用してモバイル アプリにオフライン同期を追加する方法について説明しています。

同期テーブルについて

Azure Mobile クライアント SDK では、"/tables" エンドポイントにアクセスするために IMobileServiceTable (.NET クライアント SDK) や MSTable (iOS クライアント) などのインターフェイスを提供しています。 これらの API は直接 Azure モバイル アプリ バックエンドに接続しているため、クライアント デバイスのネットワーク接続がなくなると機能しなくなります。

オフラインでの使用をサポートするには、代わりに IMobileServiceSyncTable (.NET クライアント SDK) や MSSyncTable (iOS クライアント) などの同期テーブル API をアプリで使用する必要があります。 通常の CRUD 操作 (作成、読み取り、更新、削除) はすべて同期テーブル API に対して行われますが、読み取りまたは書き込みをローカル ストアに対して行うようになる点だけが異なります。 同期テーブル操作を実行する前に、ローカル ストアを初期化する必要があります。

ローカル ストアについて

ローカル ストアは、クライアント デバイス上のデータ永続化レイヤーです。 Azure モバイル アプリ クライアントの SDK では、既定のローカル ストアの実装を提供します。 ローカル ストアのベースは、Windows、Xamarin、および Android では SQLite です。 iOS では Core Data です。

Windows Phone または Microsoft Store で SQLite ベースの実装を使用するには、SQLite の拡張機能をインストールする必要があります。 詳細については、「ユニバーサル Windows プラットフォーム: オフライン同期を有効にする」を参照してください。Android と iOS には、デバイスのオペレーティングシステム自体に SQLite のバージョンが付属しているため、独自のバージョンの SQLite を参照する必要はありません。

開発者は、独自のローカル ストアを実装することもできます。 たとえば、データを暗号化された形式でモバイル クライアント上に保存する必要がある場合は、SQLCipher を使用して暗号化を行うローカル ストアを定義できます。

同期コンテキストについて

同期コンテキストはモバイル クライアント オブジェクト (IMobileServiceClient や MSClient など) に関連付けられており、同期テーブルに対して行われた変更を追跡します。 同期コンテキストにより、後でサーバーに送信される CUD 操作 (作成、更新、削除) の順序付きリストを保持する "操作のキュー" が維持されます。

ローカルストアは、 .net クライアント SDKのなどの initialize メソッド IMobileServicesSyncContext.InitializeAsync(localstore) を使用して同期コンテキストに関連付けられます。

オフライン同期のしくみ

同期テーブルを使用する場合、クライアント コードによって、ローカルの変更内容が Azure モバイル アプリ バックエンドと同期される時期が制御されます。 ローカルの変更を プッシュする 呼び出しが行われるまで、バックエンドには何も送信されません。 同様に、ローカル ストアに新しいデータが入力されるのは、データを プルする 呼び出しが行われる場合のみです。

  • プッシュ: プッシュは同期コンテキストに対する操作であり、最後のプッシュ以降の CUD に関するすべての変更を送信します。 個々のテーブルの変更だけを送信すると操作の順番が間違って送信される可能性があるため、このような送信を行うことができないことに注意してください。 プッシュは Azure モバイル アプリ バックエンドに対して一連の REST 呼び出しを実行し、呼び出しを受けたバックエンドがサーバー データベースを変更します。

  • プル: プルはテーブルごとに実行され、クエリを使用してサーバー データのサブセットのみを取得するようにカスタマイズできます。 その後、Azure Mobile クライアント SDK が結果のデータをローカル ストアに挿入します。

  • 暗黙的なプッシュ: 保留中のローカルの更新があるテーブルに対してプルが実行された場合、プルはまず同期コンテキストに対して push() を実行します。 このプッシュにより、キュー済みの変更とサーバーの新規データとの競合が最小限に抑えられます。

  • 増分同期: プル操作の最初のパラメーターは クエリ名 であり、これはクライアントでのみ使用されます。 Null 以外のクエリ名を使用すると、Azure Mobile SDK は 増分同期を実行します。プル操作が結果のセットを返すたびに、その結果セットの最新 updatedAt のタイムスタンプが SDK ローカルシステムテーブルに格納されます。 それ以降のプル操作では、そのタイムスタンプより後のレコードだけが取得されます。

    増分同期を使用するには、サーバーが意味のある updatedAt 値を返すとともに、このフィールドでの並べ替えをサポートしている必要があります。 ただし、SDK はupdatedAt フィールドに独自の並べ替えを追加するため、固有の orderBy 句を含むプル クエリは使用できません。

    クエリ名は任意の文字列にすることができますが、アプリ内の論理クエリごとに一意である必要があります。 一意でない場合、異なるプル操作によって同じ増分同期のタイムスタンプが上書きされて、クエリが誤った結果を返す可能性があります。

    クエリでパラメーターを使用する場合、一意のクエリ名を作成する 1 つの方法はパラメーター値を組み込むことです。 たとえば、userid でフィルター処理をする場合、クエリ名は次のようにすることができます (C# を使用)。

      await todoTable.PullAsync("todoItems" + userid,
      syncTable.Where(u => u.UserId == userid));

    増分同期を無効にする場合は、 null をクエリ ID として渡します。 この場合、PullAsync への呼び出しごとにすべてのレコードが再取得されるため、場合によっては非効率となります。

  • 消去: ローカル ストアのコンテンツは IMobileServiceSyncTable.PurgeAsync を使用して削除できます。 消去は、クライアント データベースに古くなったデータがある場合、または保留中の変更をすべて破棄する場合に行う必要があります。

    消去により、ローカル ストアからテーブルがクリアされます。 サーバー データベースとの同期待ちの操作がある場合、force purge パラメーターを設定しない限り消去では例外がスローされます。

    クライアント上の古くなったデータの例として、"todo list" サンプルでデバイス 1 が未完了のアイテムだけを取得するとします。 別のデバイスによって、サーバー上の TodoItem "Buy milk" が完了とマークされたとします。 ただし、デバイス 1 は完了とマークされていないアイテムだけをプルするので、デバイス 1 はローカル ストアに "Buy milk" TodoItem を残しています。 消去により、この古い項目がクリアされます。

次のステップ