高效同步资源

本指南介绍了如何实现日历数据的增量同步。使用此方法，您可以保持所有日历集合的数据同步，同时节省带宽。

目录

概览

增量同步包含两个阶段：

  1. 初始完全同步：在开始时执行一次，以将客户端状态与服务器状态完全同步。客户端获取必须保留的同步令牌。

  2. 增量同步：重复执行，以使用自上次同步以来所做的所有 更改更新客户端。每次，客户端都会提供从服务器获取的先前同步令牌，并存储响应中的新同步令牌。

初始完全同步

初始完全同步是对您要同步的集合的所有资源的原始请求。如果您只想同步特定资源子集，可以选择使用请求参数来限制列表请求。

在对列表操作的响应中，响应包含一个名为 nextSyncToken 的字段，表示同步令牌。您必须存储 nextSyncToken 的值。如果结果集过大且响应已 分页，则 nextSyncToken 字段仅显示在最后一页上。

增量同步

借助增量同步，您可以检索自上次同步请求以来修改的所有资源。为此，请执行列表请求，并在 syncToken 字段中指定最新的同步令牌。 请注意，结果始终包含已删除的条目，因此客户端可以将其从存储空间中移除。

如果自上次增量同步请求以来更改了大量资源，您可能会在列表结果中找到 pageToken 而不是 syncToken。在这种情况下，请执行用于在增量同步中检索第一页的相同列表查询（使用相同的 syncToken），将 pageToken 附加到该查询，并通过后续请求进行分页，直到在最后一页上找到另一个 syncToken。存储此 syncToken 以用于下一个同步请求。

以下示例展示了增量分页同步：

原始查询

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

结果包含以下内容：

{
  "nextPageToken": "CiAKGjBpNDd2Nmp2Zml2cXRwYjBpOXA"
}

检索下一页

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

服务器要求的完全同步

服务器有时会因令牌过期或相关 ACL 发生更改而使同步令牌失效。在这种情况下，服务器会使用 HTTP 状态代码 410 响应增量请求。发生这种情况时，请清除客户端存储空间并执行新的完全同步。

示例代码

以下示例演示了如何将同步令牌与 Java 客户端库搭配使用。首次调用 run() 方法时，它会执行完全同步并存储同步令牌。 在后续每次执行时，它都会加载已保存的同步令牌并执行增量同步。

  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.");
  }

旧版同步

对于事件集合，您可以执行旧版同步，方法是保存事件列表请求中的 updated字段的值，然后使用 updatedMin字段检索更新后的事件。不再建议使用此方法，因为它更容易出错（例如，它不会强制执行查询限制），并且仅适用于事件。