启用与 iOS 移动应用进行脱机同步

• Android
• Cordova
• iOS
• Windows
• Xamarin.Android
• Xamarin.Forms
• Xamarin.iOS

概述

本教程介绍如何使用适用于 iOS 的 Azure 应用服务的“移动应用”功能进行脱机同步。 使用脱机同步，即使没有网络连接，最终用户也可与移动应用交互，以便查看、添加或修改数据。 更改存储在本地数据库中。 设备重新联机后，这些更改会与远程后端同步。

对于首次体验“移动应用”的用户，请先完成创建 iOS 应用教程。 如果不使用下载的快速入门服务器项目，则必须将数据访问扩展包添加到项目。 有关服务器扩展包的详细信息，请参阅使用适用于 Azure 移动应用的 .NET 后端服务器 SDK。

若要了解有关脱机同步功能的详细信息，请参阅移动应用中的脱机数据同步。

查看客户端同步代码

创建 iOS 应用教程中下载的客户端项目已包含使用基于 Core Data 的本地数据库支持脱机同步的代码。 本部分汇总了教程代码中已包含的内容。 有关该功能的概念性概述，请参阅移动应用中的脱机数据同步。

使用移动应用的脱机数据同步功能，即使网络不可访问，最终用户也能够与本地数据库交互。 要在应用中使用这些功能，可以初始化 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)
  

  此方法将使用移动应用 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 的第二个参数是用于增量同步的查询 ID。增量同步使用该记录的 UpdatedAt 时间戳（在本地存储中称为 updatedAt），只检索自上次同步后修改过的记录。该查询 ID 应该是描述性字符串，它对于你应用中的每个逻辑查询都是独一无二的。 若选择不使用增量同步，请传递 nil 作为查询 ID。 此方法可能会降低效率，因为它会检索每个提取操作的所有记录。

在修改或添加数据时，在用户执行刷新手势时，以及在启动时，Objective-C 应用会同步。

当用户执行刷新手势时以及在启动时，Swift 应用会同步。

由于每当修改数据 (Objective-C) 或启动应用（Objective-C 和 Swift）时应用就会同步，因此，应用假设用户已联机。 在后面的一个部分中，我们将更新应用，以便即使在脱机时用户也能进行编辑。

查看 Core Data 模型

在使用 Core Data 脱机存储时，必须在数据模型中定义特定的表和字段。 示例应用已包含具有正确格式的数据模型。 在本部分中，我们会逐步介绍这些表以便说明其用法。

打开 QSDataModel.xcdatamodeld。 已定义四个表，其中三个由 SDK 使用，一个用于待办事项本身：

• MS_TableOperations：跟踪需要与服务器同步的项。
• MS_TableOperationErrors：跟踪脱机同步期间发生的任何错误。
• MS_TableConfig：跟踪所有提取操作最后一次同步操作的上次更新时间。
• TodoItem：存储待办事项。 系统列 createdAt、updatedAt 和 version 都是可选的系统属性。

注意

移动应用 SDK 会保留以“``”开头的列名称。 请不要将此前缀用于系统列以外的任何项。 否则，在使用远程后端时，列名称会被修改。

使用脱机同步功能时，请定义下面的三个系统表和一个数据表。

系统表

MS_TableOperations

Attribute	类型
id	64 位整数
itemId	字符串
properties	Binary Data
table	字符串
tableKind	16 位整数

MS_TableOperationErrors

Attribute	类型
id	字符串
operationId	64 位整数
properties	Binary Data
tableKind	16 位整数

MS_TableConfig

属性	类型
id	字符串
key	字符串
keyType	64 位整数
table	字符串
value	字符串

数据表

TodoItem

属性	类型	备注
id	字符串（标记为必需）	远程存储中的主键
complete	Boolean	待办事项字段
text	字符串	待办事项字段
createdAt	日期	（可选）映射到 createdAt 系统属性
updatedAt	Date	（可选）映射到 updatedAt 系统属性
版本	字符串	（可选）用于检测冲突，映射到版本

更改应用的同步行为

在本部分，将修改应用，以便在应用启动时或插入和更新项时应用不会进行同步。 仅当按刷新手势按钮时，应用才会同步。

Objective-C：

1. 在 QSTodoListViewController.m 中更改 viewDidLoad 方法，删除方法末尾的 [self refresh] 调用。 现在，数据将不会在应用启动时与服务器同步。 相反，它将与本地存储的内容同步。

2. 在 QSTodoService.m 中修改 addItem 的定义，使其不会在插入项后同步。 删除 self syncData 块并将它替换为以下内容：

   if (completion != nil) {
       dispatch_async(dispatch_get_main_queue(), completion);
   }
   

3. 修改 completeItem 的定义，如前所述。 删除 self syncData 的块并将它替换为以下内容：

   if (completion != nil) {
       dispatch_async(dispatch_get_main_queue(), completion);
   }
   

Swift：

在 ToDoTableViewController.swift 中的 viewDidLoad 内，注释掉以下两行，停止在应用启动时同步。 在编写本文时，当某人添加或完成某个项时，Swift Todo 应用不会更新服务。 它仅在应用启动时更新服务。

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

测试应用

在本部分，将连接到无效的 URL，以模拟脱机方案。 添加数据项时，数据项将保存在本地 Core Data 存储中，而不会与移动应用后端同步。

1. 将 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")
   

2. 添加一些待办事项。 退出模拟器（或强行关闭应用），并重新启动它。 验证更改是否已保存。

3. 查看远程 TodoItem 表的内容：

   • 对于 Node.js 后端，请转到 Azure 门户，在移动应用后端中单击“简易表”>“TodoItem”。
   • 对于 .NET 后端，请使用 SQL 工具（如 SQL Server Management Studio）或 REST 客户端（如 Fiddler 或 Postman）。

4. 验证新项是否未与服务器同步。

5. 将 QSTodoService.m 中的 URL 更改回正确的 URL，然后重新运行应用。

6. 通过下拉项列表来执行刷新手势。
   此时会显示进度微调控件。

7. 再次查看 TodoItem 数据。 现在应显示新的和更改的待办事项。

总结

为了支持脱机同步功能，我们使用了 MSSyncTable 接口，并使用本地存储初始化了 MSClient.syncContext。 在这种情况下，本地存储是基于 Core Data 的数据库。

使用 Core Data 本地存储时，必须使用正确的系统属性定义多个表。

移动应用的常规创建、读取、更新和删除 (CRUD) 操作执行起来就像此应用仍处于连接状态一样，但所有操作都针对本地存储进行。

将本地存储与服务器同步时，我们使用了 MSSyncTable.pullWithQuery 方法。

其他资源

• 移动应用中的脱机数据同步
• 云封面：Azure 移动服务中的脱机同步 (视频与移动服务有关，但移动应用脱机同步的工作方式类似。)