为 Xamarin.Android 移动应用启用脱机同步

概述

本教程介绍适用于 Xamarin.Android 的 Azure 移动应用的脱机同步功能。 脱机同步允许最终用户与移动应用交互(查看、添加或修改数据),即使在没有网络连接时也是如此。 在本地数据库中存储更改。 设备重新联机后,这些更改会与远程服务同步。

本教程会更新创建 Xamarin Android 应用 教程中的客户端项目,支持 Azure 移动应用的脱机功能。 如果不使用下载的快速入门服务器项目,必须将数据访问扩展包添加到项目。 有关服务器扩展包的详细信息,请参阅使用适用于 Azure 移动应用的 .NET 后端服务器 SDK

若要了解有关脱机同步功能的详细信息,请参阅 Offline Data Sync in Azure Mobile Apps(Azure 移动应用中的脱机数据同步)主题。

更新客户端应用以支持脱机功能

脱机情况下,可使用 Azure 移动应用脱机功能与本地数据库交互。 要在应用中使用这些功能,请将 SyncContext 初始化到本地存储。 然后,通过 [IMobileServiceSyncTable][IMobileServiceSyncTable] 接口引用表。 SQLite 在设备上用作本地存储。

  1. 在 Visual Studio 中,打开在创建 Xamarin Android 应用教程中完成的应用项目的 NuGet 包管理器。搜索并安装 Microsoft.Azure.Mobile.Client.SQLiteStore NuGet 包。

  2. 打开 ToDoActivity.cs 文件,并取消评论 #define OFFLINE_SYNC_ENABLED 定义。

  3. 在 Visual Studio 中,按 F5 键重新生成并运行客户端应用。应用的工作方式与启用脱机同步之前一样。但是,本地数据库中现在填充了可以在脱机方案中使用的数据。

更新应用以与后端断开连接

本部分断开与移动应用后端的连接,以模拟脱机情况。 添加数据项时,异常处理程序会指示该应用处于脱机模式。 在此状态下,新项会添加到本地存储,并且在以连接状态运行推送时,这些新项将同步到移动应用后端。

  1. 在共享项目中编辑 ToDoActivity.cs。 更改 applicationURL 以指向无效的 URL:

     const string applicationURL = @"https://your-service.chinacloudsites.fail";
    

    还可以通过在设备上禁用 wifi 和手机网络或使用飞行模式来演示脱机行为。

  2. F5 生成并运行应用。请注意,在应用启动时,同步刷新将失败。

  3. 输入新项,并注意每次单击“保存”时,推送将失败,并显示 [CancelledByNetworkError] 状态。 但是,新的待办事项在可被推送到移动应用后端之前,将存在于本地存储中。 在生产应用中,如果取消显示这些异常,客户端应用的行为将会像它仍连接到移动应用后端时一样。

  4. 关闭应用程序并重新启动它,以验证你创建的新项目是否已永久保存到本地存储中。

  5. (可选)在 Visual Studio 中,打开“服务器资源管理器”。 导航到“Azure”->“SQL 数据库”中的数据库。 右键单击数据库并选择“在 SQL Server 对象资源管理器中打开” 。 现在便可以浏览 SQL 数据库表及其内容。 验证确认后端数据库中的数据未更改。

  6. (可选)通过 Fiddler 或 Postman 之类的 REST 工具使用 https://<your-mobile-app-backend-name>.chinacloudsites.cn/tables/TodoItem 格式的 GET 查询,查询移动后端。

更新应用以重新连接移动应用后端

本部分将应用重新连接到移动应用后端。 首次运行该应用程序时,OnCreate 事件处理程序将调用 OnRefreshItemsSelected。 而此方法将调用 SyncAsync,将本地存储与后端数据库同步。

  1. 在共享项目中,打开 ToDoActivity.cs,撤消对 applicationURL 属性所作的更改。

  2. F5 键重新生成并运行应用。 执行 OnRefreshItemsSelected 方法时,应用使用推送和拉取操作将本地更改与 Azure 移动应用后端同步。

  3. (可选)使用 SQL Server 对象资源管理器或 Fiddler 之类的 REST 工具查看更新后的数据。请注意,数据已在 Azure 移动应用后端数据库和本地存储之间进行同步。

  4. 在应用程序中,单击要在本地存储区中完成的几个项旁边的复选框。

    CheckItem 调用 SyncAsync,将每个已完成项与移动应用后端同步。 SyncAsync 同时调用推送和拉取操作。 每当对客户端已更改的表执行拉取操作时,始终会自动执行推送操作。 这可确保本地存储中的所有表以及关系都保持一致。 此行为可能会导致意外的推送。 有关此行为的详细信息,请参阅 Offline Data Sync in Azure Mobile Apps

查看客户端同步代码

完成教程 创建 Xamarin Android 应用 时下载的 Xamarin 客户端项目已包含使用本地 SQLite 数据库支持脱机同步的代码。 下面简要概述了在教程代码中已包含的内容。 有关功能的概念性概述,请参阅 Offline Data Sync in Azure Mobile Apps

  • 表操作之前,必须初始化本地存储区。 ToDoActivity.OnCreate() 执行 ToDoActivity.InitLocalStoreAsync() 时,对本地存储数据库进行初始化。 此方法使用 Azure 移动应用客户端 SDK 提供的 MobileServiceSQLiteStore 类创建一个本地 SQLite 数据库。

    DefineTable 方法与所提供类型(此例中为 ToDoItem)中的字段相匹配的本地存储中创建一个表。 该类型无需包括远程数据库中的所有列。 可以只存储列的子集。

    // ToDoActivity.cs
    private async Task InitLocalStoreAsync()
    {
        // new code to initialize the SQLite store
        string path = Path.Combine(System.Environment
            .GetFolderPath(System.Environment.SpecialFolder.Personal), localDbFilename);
    
        if (!File.Exists(path))
        {
            File.Create(path).Dispose();
        }
    
        var store = new MobileServiceSQLiteStore(path);
        store.DefineTable<ToDoItem>();
    
        // Uses the default conflict handler, which fails on conflict
        // To use a different conflict handler, pass a parameter to InitializeAsync.
        // For more details, see http://go.microsoft.com/fwlink/?LinkId=521416.
        await client.SyncContext.InitializeAsync(store);
    }
    
  • ToDoActivitytoDoTable 成员属于 IMobileServiceSyncTable 类型而不是 IMobileServiceTable 类型。IMobileServiceSyncTable 会将所有创建、读取、更新和删除 (CRUD) 表操作定向到本地存储数据库。

    通过调用 IMobileServiceSyncContext.PushAsync() 确定将更改推送到 Azure 移动应用后端的时间。对于调用 PushAsync 时客户端应用修改的所有表,此同步上下文通过跟踪和推送这些表中的更改来帮助保持表关系。

    每当刷新 todoitem 列表或者添加或完成 todoitem 时,所提供的代码便会调用 ToDoActivity.SyncAsync() 进行同步。 每次本地更改后,该代码同步。

    在所提供的代码中,将查询远程 TodoItem 表中的所有记录,但它还可以筛选记录,只需将查询 ID 和查询传递给 PushAsync 即可。 有关详细信息,请参阅 Azure 移动应用中的脱机数据同步 中的 Offline Data Sync in Azure Mobile Apps部分。

    // ToDoActivity.cs
    private async Task SyncAsync()
    {
        try {
            await client.SyncContext.PushAsync();
            await toDoTable.PullAsync("allTodoItems", toDoTable.CreateQuery()); // query ID is used for incremental sync
        } catch (Java.Net.MalformedURLException) {
            CreateAndShowDialog (new Exception ("There was an error creating the Mobile Service. Verify the URL"), "Error");
        } catch (Exception e) {
            CreateAndShowDialog (e, "Error");
        }
    }
    

其他资源