Эффективно синхронизируйте ресурсы

В этом руководстве описывается, как реализовать «добавочную синхронизацию» данных календаря. Используя этот метод, вы можете синхронизировать данные для всех коллекций календаря, сохраняя при этом пропускную способность.

Содержание

Обзор

Инкрементальная синхронизация состоит из двух этапов:

  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

Полная синхронизация требуется сервером

Иногда токены синхронизации становятся недействительными сервером по разным причинам, включая истечение срока действия токена или изменения в связанных списках управления доступом. В таких случаях сервер ответит на инкрементный запрос кодом ответа 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.");
  }
SyncTokenSample.java

Устаревшая синхронизация

Для коллекций событий по-прежнему можно выполнить синхронизацию традиционным способом, сохранив значение обновленного поля из запроса списка событий, а затем используя поле modifiedSince для получения обновленных событий. Этот подход больше не рекомендуется, поскольку он более подвержен ошибкам в отношении пропущенных обновлений (например, если не применяются ограничения запросов). Кроме того, он доступен только для событий.