有效率地同步處理資源

本指南說明如何實作日曆資料的「增量同步」。使用這個方法，您可以在節省頻寬的同時，讓所有日曆集合的資料保持同步。

目錄

總覽

增量同步包含兩個階段：

  1. 一開始會執行一次完整的初始同步作業，以便將用戶端狀態與伺服器狀態完全同步。用戶端會取得需要保存的同步符記。

  2. 系統會重複執行遞增同步作業，並將上次同步後的所有變更內容傳送給用戶端。每次用戶端都會提供從伺服器取得的上一個同步權杖，並儲存回應中的新同步權杖。

初始完整同步

初始完整同步處理作業是針對要同步處理的集合，發出所有資源的原始要求。如果只想同步處理特定資源子集，可以視需要使用要求參數限制清單要求。

在清單作業的回應中，您會找到名為 nextSyncToken 的欄位，代表同步符記。您需要儲存 nextSyncToken 的值，如果結果集過大且回應分頁，則 nextSyncToken 欄位只會出現在最後一頁。

遞增同步

增量同步可讓您擷取自上次同步要求後修改的所有資源。如要這麼做，您必須執行清單要求，並在 syncToken 欄位中指定最近一次的同步權杖。請注意，結果一律會包含已刪除的項目，以便用戶端有機會從儲存空間中移除這些項目。

如果自上次增量同步要求後，有大量資源發生變更，清單結果中可能會顯示 pageToken，而非 syncToken。在這些情況下，您需要執行與擷取增量同步的第一頁時完全相同的清單查詢 (具有完全相同的 syncToken)，將 pageToken 附加至該查詢，然後逐一查看所有後續要求，直到在最後一頁找到另一個 syncToken 為止。請務必儲存這個 syncToken，以供日後進行下一次同步要求。

以下是需要分頁同步處理增量的案例查詢範例：

原始查詢

GET /calendars/primary/events?maxResults=10&singleEvents=true&syncToken=CPDAlvWDx70CEPDAlvWDx

// Result contains the following

"nextPageToken":"CiAKGjBpNDd2Nmp2Zml2cXRwYjBpOXA",

正在擷取下一頁

GET /calendars/primary/events?maxResults=10&singleEvents=true&syncToken=CPDAlvWDx70CEPDAlvWDx&pageToken=CiAKGjBpNDd2Nmp2Zml2cXRwYjBpOXA

伺服器要求完整同步

有時伺服器會因各種原因 (包括權杖過期或相關 ACL 變更) 而使同步權杖失效。在這種情況下，伺服器會以回應碼 410 回應增量要求。這會觸發用戶端商店的完整清除作業，並執行新的完整同步作業。

程式碼範例

下列程式碼片段範例說明如何搭配使用同步權杖和 Java 用戶端程式庫。第一次呼叫執行方法時，系統會執行完整同步處理作業並儲存同步權杖。後續每次執行時，系統都會載入已儲存的同步權杖，並執行增量同步。

  private static void run() throws IOException {
    // Construct the {@link Calendar.Events.List} request, but don't execute it yet.
    Calendar.Events.List request = client.events().list("primary");

    // Load the sync token stored from the last execution, if any.
    String syncToken = syncSettingsDataStore.get(SYNC_TOKEN_KEY);
    if (syncToken == null) {
      System.out.println("Performing full sync.");

      // Set the filters you want to use during the full sync. Sync tokens aren't compatible with
      // most filters, but you may want to limit your full sync to only a certain date range.
      // In this example we are only syncing events up to a year old.
      Date oneYearAgo = Utils.getRelativeDate(java.util.Calendar.YEAR, -1);
      request.setTimeMin(new DateTime(oneYearAgo, TimeZone.getTimeZone("UTC")));
    } else {
      System.out.println("Performing incremental sync.");
      request.setSyncToken(syncToken);
    }

    // Retrieve the events, one page at a time.
    String pageToken = null;
    Events events = null;
    do {
      request.setPageToken(pageToken);

      try {
        events = request.execute();
      } catch (GoogleJsonResponseException e) {
        if (e.getStatusCode() == 410) {
          // A 410 status code, "Gone", indicates that the sync token is invalid.
          System.out.println("Invalid sync token, clearing event store and re-syncing.");
          syncSettingsDataStore.delete(SYNC_TOKEN_KEY);
          eventDataStore.clear();
          run();
        } else {
          throw e;
        }
      }

      List<Event> items = events.getItems();
      if (items.size() == 0) {
        System.out.println("No new events to sync.");
      } else {
        for (Event event : items) {
          syncEvent(event);
        }
      }

      pageToken = events.getNextPageToken();
    } while (pageToken != null);

    // Store the sync token from the last request to be used during the next execution.
    syncSettingsDataStore.set(SYNC_TOKEN_KEY, events.getNextSyncToken());

    System.out.println("Sync complete.");
  }
SyncTokenSample.java

舊版同步

對於事件集合，您仍可保留事件清單要求中更新欄位的值，然後使用 modifiedSince 欄位擷取更新的事件，以舊版方式進行同步。我們不再建議使用這種做法，因為如果錯過更新 (例如未強制執行查詢限制)，就更容易發生錯誤。此外，這項功能僅適用於活動。