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

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

概要

このチュートリアルでは、iOS 向け Azure App Service Mobile Apps 機能を使用したオフライン同期について説明します。オフライン同期により、エンドユーザーはネットワークに接続していなくても、モバイルアプリを操作してデータを表示、追加、または変更できます。変更は、ローカルデータベースに格納されます。デバイスが再びオンラインになると、変更がリモートバックエンドと同期されます。

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

オフライン同期機能の詳細については、Mobile Apps でのオフラインデータ同期に関する記事をご覧ください。

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

「iOS アプリの作成」チュートリアルでダウンロードしたクライアントプロジェクトには、ローカルの Core Data に基づいたデータベースを使用したオフライン同期をサポートするコードが既に含まれています。このセクションでは、チュートリアルのコードに既に含まれているものについて簡単に説明します。機能の概念的な概要については、Mobile Apps でのオフラインデータ同期に関する記事をご覧ください。

Mobile Apps のオフラインデータ同期機能を使用すると、エンドユーザーは、ネットワークにアクセスできない場合でもローカルデータベースを操作できます。アプリケーションでこれらの機能を使用するには、 MSClient の同期コンテキストを初期化して、ローカルストアを参照します。次に、MSSyncTable インターフェイスを使用してテーブルを参照します。

QSTodoService.m (Objective-C) または ToDoTableViewController.swift (Swift) では、メンバー syncTable の型は MSSyncTable です。オフライン同期では、MSTable の代わりにこの同期テーブルインターフェイスを使用します。同期テーブルを使用すると、すべての操作はローカルストアを参照し、明示的なプッシュ操作とプル操作を使用してリモートバックエンドとのみ同期されます。

同期テーブルへの参照を取得するには、MSClient で syncTableWithName メソッドを使用します。オフライン同期機能を削除するには、tableWithName を使用します。

テーブル操作を実行する前に、ローカルストアを初期化する必要があります。関連するコードを次に示します。

Objective-C: QSTodoService.init メソッドのコードを次に示します。

MSCoreDataStore *store = [[MSCoreDataStore alloc] initWithManagedObjectContext:context];
self.client.syncContext = [[MSSyncContext alloc] initWithDelegate:nil dataSource:store callback:nil];

Swift: ToDoTableViewController.viewDidLoad メソッドのコードを次に示します。
```
let client = MSClient(applicationURLString: "http:// ...") // URI of the Mobile App
let managedObjectContext = (UIApplication.sharedApplication().delegate as! AppDelegate).managedObjectContext!
self.store = MSCoreDataStore(managedObjectContext: managedObjectContext)
client.syncContext = MSSyncContext(delegate: nil, dataSource: self.store, callback: nil)
```
このメソッドでは、Mobile Apps SDK で提供される MSCoreDataStore インターフェイスを使用してローカルストアを作成します。 MSSyncContextDataSource プロトコルを実装することで、別のローカルストアを提供することもできます。また、MSSyncContext の最初のパラメーターは、競合ハンドラーを指定するために使用します。ここでは nil を渡したため、既定の競合ハンドラーが取得されます。この競合ハンドラーは、競合が発生すると失敗します。

では、実際の同期操作を実行し、リモートバックエンドからデータを取得してみましょう。

Objective-C: syncData で新しい変更をプッシュしてから pullData を呼び出すことで、リモートバックエンドからデータを取得します。次に、pullData メソッドがクエリに一致する新しいデータを取得します。

-(void)syncData:(QSCompletionBlock)completion
{
     // Push all changes in the sync context, and then pull new data.
     [self.client.syncContext pushWithCompletion:^(NSError *error) {
         [self logErrorIfNotNil:error];
         [self pullData:completion];
     }];
}

-(void)pullData:(QSCompletionBlock)completion
{
     MSQuery *query = [self.syncTable query];

     // Pulls data from the remote server into the local table.
     // We're pulling all items and filtering in the view.
     // Query ID is used for incremental sync.
     [self.syncTable pullWithQuery:query queryId:@"allTodoItems" completion:^(NSError *error) {
         [self logErrorIfNotNil:error];

         // Lets the caller know that we have finished.
         if (completion != nil) {
             dispatch_async(dispatch_get_main_queue(), completion);
         }
     }];
}

Swift:

func onRefresh(sender: UIRefreshControl!) {
    UIApplication.sharedApplication().networkActivityIndicatorVisible = true

    self.table!.pullWithQuery(self.table?.query(), queryId: "AllRecords") {
        (error) -> Void in

        UIApplication.sharedApplication().networkActivityIndicatorVisible = false

        if error != nil {
            // A real application would handle various errors like network conditions,
            // server conflicts, etc. via the MSSyncContextDelegate
            print("Error: \(error!.description)")

            // We will discard our changes and keep the server's copy for simplicity
            if let opErrors = error!.userInfo[MSErrorPushResultKey] as? Array<MSTableOperationError> {
                for opError in opErrors {
                    print("Attempted operation to item \(opError.itemId)")
                    if (opError.operation == .Insert || opError.operation == .Delete) {
                        print("Insert/Delete, failed discarding changes")
                        opError.cancelOperationAndDiscardItemWithCompletion(nil)
                    } else {
                        print("Update failed, reverting to server's copy")
                        opError.cancelOperationAndUpdateItem(opError.serverItem!, completion: nil)
                    }
                }
            }
        }
        self.refreshControl?.endRefreshing()
    }
}

Objective C バージョンでは、syncData で同期コンテキストの最初に pushWithCompletion を呼び出しています。このメソッドは、すべてのテーブルに対して変更をプッシュするため、(同期テーブル自体ではなく) MSSyncContext のメンバーです。 (CUD 操作によって) 何らかの方法でローカルで変更されたレコードだけがサーバーに送信されます。次に、ヘルパー pullData が呼び出されます。このヘルパーが MSSyncTable.pullWithQuery を呼び出してリモートデータを取得し、ローカルデータベースに格納します。

Swift バージョンでは、プッシュ操作は必ずしも必要ではなかったため、pushWithCompletion の呼び出しはありません。プッシュ操作を行っているテーブルの同期コンテキストで保留中の変更がある場合は、プルは必ず最初にプッシュを発行します。ただし、複数の同期テーブルを使用している場合は、関連するテーブル全体で整合性を確保するために、プッシュを明示的に呼び出すことをお勧めします。

Objective-C と Swift のどちらのバージョンでも、pullWithQuery メソッドを使用して、取得するレコードをフィルター処理するクエリを指定できます。この例のクエリでは、リモートの TodoItem テーブルのすべてのレコードを取得します。

pullWithQuery の 2 番目のパラメーターは、増分同期に使用するクエリ ID です。増分同期では、レコードの UpdatedAt タイムスタンプ (ローカルストアでは updatedAt と呼ばれます) を使用して、前回の同期以降に変更されたレコードだけを取得します。クエリ ID は、アプリ内の各論理クエリに対して一意の、わかりやすい文字列にする必要があります。増分同期を解除するには、クエリ ID として nil を渡します。この方法では、プル操作のたびにすべてのレコードを取得するため、非効率的になる可能性があります。

Objective-C のアプリは、データを変更または追加したとき、ユーザーが更新操作を実行したとき、および起動時に同期します。

Swift のアプリは、ユーザーが更新操作を実行したときと起動時に同期します。

アプリはデータが変更されたとき (Objective-C) またはアプリの起動時 (Objective-C と Swift) に同期するため、ユーザーがオンラインであることを前提としています。後のセクションで、ユーザーがオフラインのときでも編集できるようにアプリを更新します。

Core Data モデルの確認

Core Data オフラインストアを使用するときは、データモデルで特定のテーブルとフィールドを定義する必要があります。サンプルアプリケーションには、あらかじめ適切な形式でデータモデルが含まれています。このセクションでは、これらのテーブルとその使用方法について説明します。

QSDataModel.xcdatamodeld を開きます。 4 つのテーブルが定義されています。3 つは SDK で使用され、1 つは To Do 項目自体に使用されます。

MS_TableOperations:サーバーと同期する必要がある項目を追跡します。
MS_TableOperationErrors:オフライン同期中に発生したエラーを追跡します。
MS_TableConfig:すべてのプル操作に対する最後の同期操作の最終更新時刻を追跡します。
TodoItem:To Do アイテムを格納します。システム列 createdAt、updatedAt、および version は省略可能なシステムプロパティです。

Note

Mobile Apps SDK では、" `` " で始まる列名を予約しています。このプレフィックスは、システム列以外のものに使用しないでください。そうしないと、リモートバックエンドの使用時に列名が変更されます。

オフライン同期機能を使用するときは、3 つのシステムテーブルと、データテーブルを定義します。

システムテーブル

MS_TableOperations

MS_TableOperations テーブルの属性

属性	Type
id	Integer 64
itemId	String
properties	Binary Data
table	String
tableKind	Integer 16

MS_TableOperationErrors

MS_TableOperationErrors テーブルの属性

属性	Type
id	String
operationId	Integer 64
properties	Binary Data
tableKind	Integer 16

MS_TableConfig

属性	Type
id	String
key	String
keyType	Integer 64
table	String
value	String

データテーブル

TodoItem

属性	Type	Note
id	String、必須のマーク	リモートストア内のプライマリキー
complete	Boolean	To Do 項目フィールド
text	String	To Do 項目フィールド
createdAt	Date	(省略可能) createdAt システムプロパティにマップします。
updatedAt	Date	(省略可能) updatedAt システムプロパティにマップします。
version	String	(省略可能) 競合の検出に使用され、バージョンにマップします。

アプリケーションの同期動作を変更する

このセクションでは、アプリの起動時または項目を挿入および更新したときに同期しないように、アプリを変更します。更新操作ボタンが実行されたときにのみ同期します。

Objective-C:

QSTodoListViewController.m で viewDidLoad メソッドを変更して、メソッドの最後にある [self refresh] への呼び出しを削除します。これで、アプリの起動時にデータはサーバーと同期されなくなります。代わりに、ローカルストアの内容と同期されます。
QSTodoService.m で addItem の定義を変更して、項目の挿入後に同期しないようにします。 self syncData ブロックを削除し、代わりに次を配置します。
```
if (completion != nil) {
    dispatch_async(dispatch_get_main_queue(), completion);
}
```
前述のように、completeItem の定義を変更します。 self syncData のブロックを削除し、次のコードに置き換えます。
```
if (completion != nil) {
    dispatch_async(dispatch_get_main_queue(), completion);
}
```

Swift:

viewDidLoad の ToDoTableViewController.swift で、次に示す 2 行をコメントアウトしてアプリの起動時に同期しないようにします。この記事の執筆時点では、Swift Todo アプリはユーザーが項目を追加または完了したときにはサービスを更新せず、アプリの起動時にのみサービスを更新しています。

self.refreshControl?.beginRefreshing()
self.onRefresh(self.refreshControl)

アプリケーションをテストする

ここでは、無効な URL に接続してオフラインシナリオをシミュレートします。データ項目を追加すると、ローカル Core Data ストアに保持されますが、モバイルアプリバックエンドとは同期されません。

QSTodoService.m のモバイルアプリ URL を無効な URL に変更し、アプリをもう一度実行します。

Objective-C: QSTodoService.m のコードを次に示します。
```
self.client = [MSClient clientWithApplicationURLString:@"https://sitename.azurewebsites.net.fail"];
```
Swift: ToDoTableViewController.swift のコードを次に示します。
```
let client = MSClient(applicationURLString: "https://sitename.azurewebsites.net.fail")
```
To Do 項目をいくつか追加します。シミュレーターを終了し (またはアプリを強制的に閉じて)、再起動します。変更内容が保持されていることを確認します。
リモートの TodoItem テーブルの内容を表示します。
- Node.js バックエンドの場合は、Azure Portal に移動し、モバイルアプリバックエンドで [簡易テーブル]>、[TodoItem] をクリックします。
- .NET バックエンドの場合は、SQL Server Management Studio などの SQL ツール、または Fiddler や Postman などの REST クライアントを使用します。
新しい項目がサーバーと同期されなかったことを確認します。
QSTodoService.m の URL を正しい URL に変更し、アプリを再実行します。
項目の一覧をプルダウンして更新操作を実行します。
進行状況を示すスピナーが表示されます。
TodoItem データをもう一度表示します。今回は、新しい To Do 項目と変更された To Do 項目が表示されます。

まとめ

オフライン同期機能をサポートするために、MSSyncTable インターフェイスを使用し、ローカルストアで MSClient.syncContext を初期化しました。この例では、ローカルストアは Core Data に基づいたデータベースでした。

Core Data ローカルストアを使用するときは、正しいシステムプロパティを使用して、複数のテーブルを定義する必要があります。

モバイルアプリでの通常の作成、読み取り、更新、削除 (CRUD) の各操作は、アプリがまだ接続されていても、すべての操作がローカルストアに対して発生したかのように動作します。

ローカルストアをサーバーと同期するときに、MSSyncTable.pullWithQuery メソッドを使用しました。

その他のリソース

Mobile Apps でのオフラインデータ同期
クラウドカバー: Azure Mobile Services でのオフライン同期 (ビデオは Mobile Services に関するものですが、Mobile Apps のオフライン同期も同様の方法で動作します)。

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

概要

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

Core Data モデルの確認

システム テーブル

データ テーブル

アプリケーションの同期動作を変更する

アプリケーションをテストする

まとめ

その他のリソース

その他のリソース

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

システムテーブル

データテーブル