啟用 Cordova 行動應用程式的離線同步處理

發行項
06/25/2019

概觀

此教學課程介紹適用於 Cordova 之 Azure 行動應用程式的離線同步處理功能。離線同步處理可讓使用者與行動應用程式互動，即使沒有網路連線，也能夠檢視、新增或修改資料。變更會儲存在本機資料庫中。裝置恢復上線後，這些變更就會與遠端服務進行同步處理。

本教學課程是根據您完成教學課程 Apache Cordova 快速入門時所建立之 Mobile Apps 的 Cordova 快速入門方案。在本教學課程中，您將會更新快速入門方案來新增 Azure Mobile Apps 的離線功能。我們也會在應用程式中反白顯示離線特有的程式碼。

若要深入了解離線同步處理功能，請參閱 Azure Mobile Apps 中的離線資料同步處理主題。 API 使用方式的詳細資訊，請參閱 API 文件。

在快速入門方案中新增離線同步處理

應用程式中必須新增離線同步處理程式碼。離線同步處理需要 cordova-sqlite-storage 外掛程式，此外掛程式會在專案中納入 Azure Mobile Apps 外掛程式時自動新增至應用程式。快速入門專案包含上述兩個外掛程式。

在 Visual Studio 的 [方案總管] 中開啟 index.js，並將下列程式碼

 var client,            // Connection to the Azure Mobile App backend
    todoItemTable;      // Reference to a table endpoint on backend

使用此程式碼取代：

 var client,            // Connection to the Azure Mobile App backend
    todoItemTable,      // Reference to a table endpoint on backend
    syncContext;        // Reference to offline data sync context

接下來，將下列程式碼：
```
 client = new WindowsAzure.MobileServiceClient('http://yourmobileapp.azurewebsites.net');
```
使用此程式碼取代：
```
 client = new WindowsAzure.MobileServiceClient('http://yourmobileapp.azurewebsites.net');
 var store = new WindowsAzure.MobileServiceSqliteStore('store.db');

 store.defineTable({
   name: 'todoitem',
   columnDefinitions: {
       id: 'string',
       text: 'string',
       complete: 'boolean',
       version: 'string'
   }
 });

 // Get the sync context from the client
 syncContext = client.getSyncContext();
```
前面新增的程式碼會初始化本機存放區，並定義與 Azure 後端所使用的資料行值相符的本機資料表 (您不需要在此程式碼中包含所有資料行值。) 此 version 欄位是由行動後端維護，並用於衝突解決。

您可以藉由呼叫 getSyncContext取得同步處理內容的參考。當呼叫 .push() 時，透過追蹤和推送所有用戶端應用程式修改之資料表中的變更，同步處理內容可協助保存資料表關聯性。
將應用程式的 URL 更新為行動應用程式的應用程式 URL。

接下來，將此程式碼：

 todoItemTable = client.getTable('todoitem'); // todoitem is the table name

使用此程式碼取代：

 // Initialize the sync context with the store
 syncContext.initialize(store).then(function () {

 // Get the local table reference.
 todoItemTable = client.getSyncTable('todoitem');

 syncContext.pushHandler = {
     onConflict: function (pushError) {
         // Handle the conflict.
         console.log("Sync conflict! " + pushError.getError().message);
         // Update failed, revert to server's copy.
         pushError.cancelAndDiscard();
       },
       onError: function (pushError) {
           // Handle the error
           // In the simulated offline state, you get "Sync error! Unexpected connection failure."
           console.log("Sync error! " + pushError.getError().message);
       }
 };

 // Call a function to perform the actual sync
 syncBackend();

 // Refresh the todoItems
 refreshDisplay();

 // Wire up the UI Event Handler for the Add Item
 $('#add-item').submit(addItemHandler);
 $('#refresh').on('click', refreshDisplay);

上述程式碼會初始化同步處理內容，然後呼叫 getSyncTable (而不是 getTable) 來取得本機資料表的參考。

此程式碼使用本機資料庫來進行所有建立、讀取、更新和刪除 (CRUD) 資料表作業。

這個範例會對同步處理衝突執行簡單的錯誤處理。實際的應用程式會處理各種錯誤，例如網路狀況、伺服器衝突及其他問題。如需程式碼範例，請參閱離線同步處理範例。

接著，新增此函式以執行實際的同步處理。

 function syncBackend() {

   // Sync local store to Azure table when app loads, or when login complete.
   syncContext.push().then(function () {
       // Push completed

   });

   // Pull items from the Azure table after syncing to Azure.
   syncContext.pull(new WindowsAzure.Query('todoitem'));
 }

您可以呼叫 syncContext.push()，以決定何時將變更推送至行動應用程式後端。例如，您可以在繫結至同步處理按鈕的按鈕事件處理常式中呼叫 syncBackend。

離線同步處理考量

在範例中，只有在應用程式啟動時，才會於登入的回呼函式中呼叫 syncContext 的 push 方法。在實際的應用程式中，您也可以透過手動方式或在網路狀態變更時觸發此同步處理功能。

對資料表執行提取時，如果該資料表有內容所追蹤的擱置中本機更新，則提取作業會自動觸發推送。在此範例中重新整理、新增和完成項目時，您可以省略明確的 push 呼叫，因為它可能是多餘的。

在提供的程式碼中，遠端 todoItem 資料表中的所有記錄都會進行查詢，但是也可能透過將查詢識別碼與查詢傳遞至 push來篩選記錄。如需詳細資訊，請參閱Azure Mobile Apps 中離線資料同步的累加同步一節。

(選擇性) 停用驗證

如果您不想在測試離線同步處理之前設定驗證，請將登入的回呼函式註解化，但讓回呼函式內部的程式碼保持取消註解狀態。將登入那幾行註解化之後，程式碼如下︰

  // Login to the service.
  // client.login('twitter')
  //    .then(function () {
    syncContext.initialize(store).then(function () {
      // Leave the rest of the code in this callback function  uncommented.
            ...
    });
  // }, handleError);

現在，當您執行應用程式，應用程式會與 Azure 後端同步處理。

執行用戶端應用程式

離線同步現在已啟用，您可以在每個平台執行用戶端應用程式至少一次，以填入本機存放區資料庫。稍後，模擬一個離線案例，並在應用程式離線時修改本機存放區中的資料。

(選擇性) 測試同步處理行為

在本節中，您將修改用戶端專案，使用對後端而言無效的應用程式 URL，以模擬離線案例。當您新增或變更資料項目時，這些變更會保留在本機存放區，直到重新建立連接時，才會同步處理至後端資料存放區。

在方案總管中，開啟index.js專案檔，並將應用程式 URL 變更為指向不正確 URL，如下列程式碼所示：
```
 client = new WindowsAzure.MobileServiceClient('http://yourmobileapp.azurewebsites.net-fail');
```

在 index.html 中，以相同的無效 URL 更新 CSP <meta> 元素。

 <meta http-equiv="Content-Security-Policy" content="default-src 'self' data: gap: http://yourmobileapp.azurewebsites.net-fail; style-src 'self'; media-src *">

建置並執行用戶端應用程式，並請注意，當應用程式嘗試在登入之後與後端進行同步處理時，主控台會記錄例外狀況。您新增的任何項目在推送至行動後端之前，只存在於本機存放區。用戶端應用程式運作時就如同已連接至後端一樣。
關閉應用程式並重新加以開啟，以驗證您所建立的新項目持續存留於本機存放區中。
(選擇性) 使用 Visual Studio 檢視您的 Azure SQL Database 資料表，以查看後端資料庫中的資料並無變更。

在 Visual Studio 中，開啟 [伺服器總管]。流覽至Azure-SQL>Database中的資料庫。在資料庫上按一下滑鼠右鍵，並選取 [在 SQL Server 物件總管中開啟] 。現在您可以瀏覽至您的 SQL Database 資料表和其內容。

(選擇性) 測試與行動後端的重新連線

在本節中，您會將應用程式重新連接至行動後端，以模擬應用程式回到線上狀態。當您登入時，資料會同步處理至行動後端。

重新開啟 index.js，並還原應用程式 URL。
重新開啟 index.html，並修正 CSP <meta> 元素中的應用程式 URL。
重建並執行用戶端應用程式。應用程式在登入後會嘗試與行動應用程式後端同步處理。請確認偵錯主控台沒有記錄任何例外狀況。
(選擇性) 使用 SQL Server 物件總管或 REST 工具 (例如 Fiddler) 檢視已更新的資料。請注意，後端資料庫與本機存放區之間尚未同步處理資料。

請注意，資料庫與本機存放區之間的資料已同步處理，並包含應用程式中斷連接時您所新增的項目。

其他資源

後續步驟

在離線同步處理範例中，檢閱更進階的離線同步處理功能，例如衝突解決
在 API 文件中，檢閱離線同步處理 API 參考

Share via

啟用 Cordova 行動應用程式的離線同步處理

概觀

在快速入門方案中新增離線同步處理

離線同步處理考量

(選擇性) 停用驗證

執行用戶端應用程式

(選擇性) 測試同步處理行為

(選擇性) 測試與行動後端的重新連線

其他資源

後續步驟

其他資源