Xamarin iOS モバイルアプリのオフライン同期を有効にする

[アーティクル]
06/25/2019

概要

このチュートリアルでは、Xamarin iOS 向けの Azure モバイルアプリのオフライン同期機能について説明します。オフライン同期を使用すると、エンドユーザーはネットワークにアクセスできなくても、データの表示、追加、変更など、モバイルアプリケーションとやり取りできます。変更は、ローカルデータベースに格納されます。デバイスが再びオンラインになると、これらの変更がリモートサービスと同期されます。

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

オフラインの同期機能の詳細については、トピック「 Azure Mobile Apps でのオフラインデータ同期」をご覧ください。

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

Azure モバイルアプリのオフライン機能を使用すると、オフラインになっている状況でも、ローカルデータベースとやり取りすることができます。アプリケーションでこれらの機能を使用するには、SyncContext をローカルストアに初期化します。 [IMobileServiceSyncTable] インターフェイスを使用してテーブルを参照します。 SQLite は、デバイス上のローカルストアとして使用されます。

「Xamarin iOS アプリの作成」チュートリアルで完了したプロジェクトで NuGet パッケージマネージャーを開き、Microsoft.Azure.Mobile.Client.SQLiteStore パッケージを検索してインストールNuGetします。
QSTodoService.cs ファイルを開き、#define OFFLINE_SYNC_ENABLED の定義をコメント解除します。
クライアントアプリの再構築と実行アプリは、オフライン同期を有効にする前と同じように動作します。ただし今度は、オフラインシナリオで使用できるデータがローカルデータベースに格納されます。

アプリを更新してバックエンドから切断する

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

共有プロジェクトの QSToDoService.cs を編集します。 applicationURL を、無効な URL を指すように変更します。
```
  const string applicationURL = @"https://your-service.azurewebsites.fail";
```
また、デバイス上で Wi-Fi および移動体通信ネットワークを無効にするか、機内モードを使用して、オフライン動作をデモンストレーションすることもできます。
アプリケーションをビルドし、実行します。アプリを起動した際の更新時には同期が失敗することに注意してください。
新しい項目を入力し、 [保存] をクリックするたびに [CancelledByNetworkError] ステータスでプッシュが失敗することを確認します。ただし、新しい todo 項目は、モバイルアプリバックエンドにプッシュされるまでは、ローカルストア内に存在します。運用アプリでは、これらの例外を抑制した場合、クライアントアプリはモバイルアプリバックエンドにまだ接続されているかのように動作します。
アプリケーションを終了し、再起動して、作成した新しい項目がローカルストアに保存されていることを確認します。
(省略可能) PC に Visual Studio がインストールされている場合は、サーバーエクスプローラーを開きます。 Azure-SQL>データベースに移動します。データベースを右クリックし、 [SQL Server オブジェクトエクスプローラーで開く] を選択します。これで SQL データベースのテーブルとその内容を参照できます。バックエンドデータベース内のデータが変更されていないことを確認します。
(省略可能) Fiddler や Postman などの REST ツールを使用して、モバイルのバックエンドをクエリします。その際、https://<your-mobile-app-backend-name>.azurewebsites.net/tables/TodoItem の形式で、GET クエリを使用します。

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

ここでは、アプリをモバイルアプリバックエンドに再接続します。これは、アプリケーションがオフライン状態から、モバイルアプリバックエンドとのオンライン状態に移行したことをシミュレートします。ネットワーク接続を無効にしてネットワーク破損をシミュレートした場合、コードを変更する必要はありません。ネットワークを再び有効にします。初めてアプリケーションを実行すると、RefreshDataAsync メソッドが呼び出されます。これが次に SyncAsync を呼び出し、ローカルストアとバックエンドのデータベースを同期します。

共有プロジェクトの QSToDoService.cs を開き、applicationURL プロパティの変更を元に戻します。
アプリケーションを再構築して実行します。アプリは、OnRefreshItemsSelected メソッドが実行されると、プッシュとプルの操作によって、ローカルでの変更を Azure Mobile Apps バックエンドに同期します。
(省略可能) SQL Server Object Explorer または Fiddler などの REST ツールを使用して、更新データを表示します。データが同期されるのは、Azure モバイルアプリのバックエンドのデータベースとローカルストアの間であることに注意してください。
アプリケーションで、ローカルストアで完了させる項目の横にあるチェックボックスをクリックします。

CompleteItemAsync は SyncAsync を呼び出し、完了した各項目をモバイルアプリバックエンドと同期します。 SyncAsync はプッシュとプルの両方を呼び出します。クライアントが変更を行ったテーブルに対してプルを実行するたびに、クライアントの同期コンテキストへのプッシュが常に最初に自動的に実行されます。暗黙的なプッシュは、ローカルストアのすべてのテーブルとリレーションシップの一貫性を確実に保つためです。この動作については、「 Azure Mobile Apps でのオフラインデータ同期」を参照してください。

クライアント同期コードの確認

チュートリアル「 Xamarin.iOS アプリを作成する」を完了した際にダウンロードした Xamarin クライアントプロジェクトには、ローカルの SQLite データベースを使用したオフライン同期をサポートするコードがすでに含まれてます。チュートリアルのコードにすでに含まれているものの概要を示します。機能の概念的な概要については、「 Azure Mobile Apps でのオフラインデータ同期」をご覧ください。

テーブル操作を実行する前に、ローカルストアを初期化する必要があります。 QSTodoListViewController.ViewDidLoad() が QSTodoService.InitializeStoreAsync() を実行すると、ローカルストアのデータベースが初期化されます。このメソッドにより、Azure Mobile Apps クライアント SDK で提供される MobileServiceSQLiteStore クラスを使用して、新しいローカルの SQLite データベースが作成されます。

DefineTable メソッドを実行すると、提供された型のフィールドに一致するテーブルがローカルストアに作成されます。この例では、ToDoItem になります。この型に、リモートデータベース内のすべての列を含める必要はありません。列のサブセットのみ格納できます。
```
  // QSTodoService.cs

  public async Task InitializeStoreAsync()
  {
      var store = new MobileServiceSQLiteStore(localDbPath);
      store.DefineTable<ToDoItem>();

      // Uses the default conflict handler, which fails on conflict
      await client.SyncContext.InitializeAsync(store);
  }
```
QSTodoService の todoTable メンバーは、IMobileServiceTable ではなく、IMobileServiceSyncTable 型です。 IMobileServiceSyncTable は、テーブルの作成、読み取り、更新、削除 (CRUD) などのすべての操作がローカルストアデータベースに対して行われるようにします。

IMobileServiceSyncContext.PushAsync()を呼び出すことによって、これらの変更がいつ Azure モバイルアプリバックエンドにプッシュされるかを決定します。同期コンテキストは、 PushAsync が呼び出されたときに、クライアントアプリが変更を行ったすべてのテーブルで、変更を追跡およびプッシュすることで、テーブルの関係を保持するのに役立ちます。

todoitem リストの更新、または todoitem の追加や完了があれば、提供されているコードは QSTodoService.SyncAsync() を呼び出して同期します。アプリは、ローカルの変更があるたびに同期されます。コンテキストによって追跡された保留中のローカル更新のあるテーブルに対してプルが実行される場合、そのプル操作はコンテキストのプッシュを最初に自動的にトリガーします。

提供されたコードでは、リモートの TodoItem テーブルのすべてのレコードはクエリされますが、クエリ ID やクエリを PushAsync に渡すことでレコードをフィルター処理することも可能です。詳細については、「 Azure Mobile Apps でのオフラインデータ同期 」の「 Azure Mobile Apps でのオフラインデータ同期」セクションを参照してください。
```
  // QSTodoService.cs
  public async Task SyncAsync()
  {
      try
      {
          await client.SyncContext.PushAsync();
          await todoTable.PullAsync("allTodoItems", todoTable.CreateQuery()); // query ID is used for incremental sync
      }

      catch (MobileServiceInvalidOperationException e)
      {
          Console.Error.WriteLine(@"Sync Failed: {0}", e.Message);
      }
  }
```

次の方法で共有

Xamarin iOS モバイルアプリのオフライン同期を有効にする

概要

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

アプリを更新してバックエンドから切断する

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

クライアント同期コードの確認

その他のリソース

その他のリソース

次の方法で共有

Xamarin iOS モバイル アプリのオフライン同期を有効にする

概要

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

アプリを更新してバックエンドから切断する

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

クライアント同期コードの確認

その他のリソース

その他のリソース

Xamarin iOS モバイルアプリのオフライン同期を有効にする

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

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