Windows アプリのオフライン同期を有効にする

2019-06-25

概要

このチュートリアルでは、Azure Mobile App バックエンドを使用してユニバーサル Windows プラットフォーム (UWP) アプリにオフラインサポートを追加する方法について説明します。オフライン同期を使用すると、エンドユーザーは、ネットワーク接続がない場合でも、モバイルアプリの表示、追加、変更など、データを操作できます。変更はローカルデータベースに格納されます。デバイスがオンラインに戻ると、これらの変更はリモートバックエンドと同期されます。

このチュートリアルでは、チュートリアル「Azure Mobile Apps のオフライン機能をサポートする Windows アプリを作成する」から UWP アプリプロジェクトを更新します。ダウンロードしたクイックスタートサーバープロジェクトを使用しない場合は、データアクセス拡張機能パッケージをプロジェクトに追加する必要があります。サーバー拡張機能パッケージの詳細については、「.NET バックエンドサーバー SDK for Azure Mobile Appsを使用する」を参照してください。

オフライン同期機能の詳細については、「Azure Mobile Apps でのオフラインデータ同期」を参照してください。

必要条件

このチュートリアルでは、次の前提条件が必要です。

Windows 8.1 以降で実行されている Visual Studio 2013。
Windows アプリの作成の完了。
Azure Mobile Services SQLite ストア
ユニバーサル Windows プラットフォーム開発用 SQLite

オフライン機能をサポートするようにクライアントアプリを更新する

Azure Mobile App のオフライン機能を使用すると、オフラインシナリオの場合にローカルデータベースと対話できます。アプリでこれらの機能を使用するには、 SyncContext をローカルストアに初期化します。次に、 IMobileServiceSyncTable インターフェイスを使用してテーブルを参照します。 SQLite は、デバイス上のローカルストアとして使用されます。

ユニバーサル Windows プラットフォーム用の SQLite ランタイムをインストールします。
Visual Studio で、「 Windows アプリの作成」チュートリアルで完了した UWP アプリプロジェクトの NuGet パッケージマネージャーを開きます。 Microsoft.Azure.Mobile.Client.SQLiteStore NuGet パッケージを検索してインストールします。
ソリューションエクスプローラーで、[参照]>[参照の追加]...> を右クリックします。ユニバーサル Windows>拡張機能を使用して、ユニバーサル Windows プラットフォーム用の SQLite とユニバーサル Windows プラットフォームアプリ用の Visual C++ 2015 ランタイムの両方を有効にします。
MainPage.xaml.cs ファイルを開き、 #define OFFLINE_SYNC_ENABLED 定義のコメントを解除します。
Visual Studio で F5 キーを押して、クライアントアプリをリビルドして実行します。このアプリは、オフライン同期を有効にする前と同じように動作します。ただし、オフラインシナリオで使用できるデータがローカルデータベースに設定されるようになりました。

バックエンドから切断するようにアプリを更新する

このセクションでは、モバイルアプリバックエンドへの接続を切断して、オフラインの状況をシミュレートします。データ項目を追加すると、例外ハンドラーによって、アプリがオフラインモードであることが通知されます。この状態では、新しい項目がローカルストアに追加され、プッシュが次に接続状態で実行されるときにモバイルアプリバックエンドに同期されます。

共有プロジェクトのApp.xaml.csを編集します。 MobileServiceClient の初期化をコメントアウトし、無効なモバイルアプリ URL を使用する次の行を追加します。
```
  public static MobileServiceClient MobileService = new MobileServiceClient("https://your-service.azurewebsites.fail");
```
また、デバイス上の Wi-Fi ネットワークと携帯ネットワークを無効にするか、機内モードを使用してオフライン動作を示すこともできます。
F5 キーを押してアプリをビルドして実行します。アプリの起動時に更新時に同期が失敗したことを確認します。
新しい項目を入力し、[保存] をクリックするたびに CancelledByNetworkError 状態でプッシュが失敗することを確認 します。ただし、モバイルアプリバックエンドにプッシュできるようになるまで、新しい todo 項目はローカルストアに存在します。運用アプリでは、これらの例外を抑制すると、クライアントアプリはモバイルアプリバックエンドにまだ接続されているかのように動作します。
アプリを閉じて再起動し、作成した新しい項目がローカルストアに保存されていることを確認します。
(省略可能)Visual Studio で、 サーバーエクスプローラーを開きます。 Azure->SQL データベース内のデータベースに移動します。データベースを右クリックし、[ SQL Server オブジェクトエクスプローラーで開く] を選択します。これで、SQL データベーステーブルとその内容を参照できます。バックエンドデータベース内のデータが変更されていないことを確認します。
(省略可能)Fiddler や Postman などの REST ツールを使用して、 https://<your-mobile-app-backend-name>.azurewebsites.net/tables/TodoItem形式の GET クエリを使用して、モバイルバックエンドにクエリを実行します。

モバイルアプリバックエンドを再接続するようにアプリを更新する

このセクションでは、アプリをモバイルアプリバックエンドに再接続します。これらの変更は、アプリでのネットワーク再接続をシミュレートします。

アプリケーションを初めて実行すると、 OnNavigatedTo イベントハンドラーによって InitLocalStoreAsyncが呼び出されます。このメソッドは、 SyncAsync を呼び出して、ローカルストアをバックエンドデータベースと同期します。アプリは起動時に同期を試みます。

共有プロジェクトでApp.xaml.csを開き、以前の MobileServiceClient の初期化のコメントを解除して、正しいモバイルアプリの URL を使用します。
F5 キーを押して、アプリをリビルドして実行します。アプリは、 OnNavigatedTo イベントハンドラーの実行時にプッシュ操作とプル操作を使用して、ローカルの変更を Azure Mobile App バックエンドと同期します。
(省略可能)SQL Server オブジェクトエクスプローラーまたは Fiddler などの REST ツールを使用して、更新されたデータを表示します。 Azure Mobile App バックエンドデータベースとローカルストアの間でデータが同期されていることに注意してください。
アプリで、いくつかの項目の横にあるチェックボックスをクリックして、ローカルストアで完了します。

UpdateCheckedTodoItem は SyncAsync を呼び出して、完了した各項目をモバイルアプリバックエンドと同期します。 SyncAsync はプッシュとプルの両方を呼び出します。ただし、 クライアントが変更したテーブルに対してプルを実行するたびに、プッシュは常に自動的に実行されます。この動作により、ローカルストア内のすべてのテーブルとリレーションシップの一貫性が維持されます。この動作により、予期しないプッシュが発生する可能性があります。この動作の詳細については、「 Azure Mobile Apps でのオフラインデータ同期」を参照してください。

API の概要

モバイルサービスのオフライン機能をサポートするために、 IMobileServiceSyncTable インターフェイスを使用し、ローカル SQLite データベースで MobileServiceClient.SyncContext を初期化しました。オフラインの場合、Mobile Apps の通常の CRUD 操作は、ローカルストアに対する操作の実行中にアプリがまだ接続されているかのように動作します。ローカルストアをサーバーと同期するには、次のメソッドを使用します。

PushAsync このメソッドは IMobileServicesSyncContext のメンバーであるため、すべてのテーブルの変更がバックエンドにプッシュされます。ローカルの変更を含むレコードのみがサーバーに送信されます。
PullAsyncIMobileServiceSyncTable からプルが開始されます。テーブルに変更が追跡されると、暗黙的なプッシュが実行され、ローカルストア内のすべてのテーブルとリレーションシップの一貫性が維持されます。 pushOtherTables パラメーターは、コンテキスト内の他のテーブルを暗黙的なプッシュでプッシュするかどうかを制御します。 クエリ パラメーターは、IMobileServiceTableQuery<T> または OData クエリ文字列を受け取り、返されたデータをフィルター処理します。 queryId パラメーターは、増分同期を定義するために使用されます。詳細については、「Azure Mobile Apps でのオフラインデータ同期」を参照してください。
PurgeAsync アプリでは、このメソッドを定期的に呼び出して、古いデータをローカルストアから消去する必要があります。まだ同期されていない変更を消去する必要がある場合は、 force パラメーターを使用します。

これらの概念の詳細については、「 Azure Mobile Apps でのオフラインデータ同期」を参照してください。

詳細情報

次のトピックでは、Mobile Apps のオフライン同期機能に関するその他の背景情報について説明します。

Azure Mobile Apps におけるオフラインデータ同期
Azure Mobile Apps .NET SDK の使用方法

次の方法で共有