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

2019-06-25

概要

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

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

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

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

Azure Mobile App のオフライン機能を使用すると、オフラインシナリオの場合にローカルデータベースと対話できます。アプリでこれらの機能を使用するには、 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 App バックエンドと同期します。
(省略可能)SQL Server オブジェクトエクスプローラーまたは Fiddler などの REST ツールを使用して、更新されたデータを表示します。 Azure Mobile App バックエンドデータベースとローカルストアの間でデータが同期されていることに注意してください。
アプリで、いくつかの項目の横にあるチェックボックスをクリックして、ローカルストアで完了します。

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

クライアント同期コードを確認する

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

テーブル操作を実行する前に、ローカルストアを初期化する必要があります。ローカルストアデータベースは、QSTodoListViewController.ViewDidLoad()の実行時QSTodoService.InitializeStoreAsync()初期化されます。このメソッドは、Azure Mobile App クライアント 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);
  }
```
todoTableのQSTodoServiceメンバーは、IMobileServiceSyncTableではなくIMobileServiceTable型です。 IMobileServiceSyncTable は、すべての作成、読み取り、更新、および削除 (CRUD) テーブル操作をローカルストアデータベースに転送します。

これらの変更が Azure Mobile App バックエンドにプッシュされるタイミングを決定するには、 IMobileServiceSyncContext.PushAsync()を呼び出します。同期コンテキストは、クライアントアプリが呼び出されたときにクライアントアプリが変更したすべてのテーブルの変更を追跡してプッシュすることで、テーブルのリレーションシップ PushAsync を保持するのに役立ちます。

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

指定されたコードでは、リモート TodoItem テーブル内のすべてのレコードがクエリされますが、クエリ ID とクエリを PushAsyncに渡すことでレコードをフィルター処理することもできます。詳細については、「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);
      }
  }
```

その他のリソース

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

次の方法で共有

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

概要

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

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

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

クライアント同期コードを確認する

その他のリソース

その他のリソース

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

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

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