Sincronizar recursos com eficiência

Este guia descreve como implementar a "sincronização incremental" de dados de calendário. Com esse método, você pode manter os dados de todas as coleções de calendário sincronizados, economizando largura de banda.

Conteúdo

Visão geral

A sincronização incremental consiste em duas etapas:

  1. A sincronização completa inicial é realizada uma vez no início para sincronizar totalmente o estado do cliente com o estado do servidor. O cliente vai receber um token de sincronização que precisa ser mantido.

  2. A sincronização incremental é realizada repetidamente e atualiza o cliente com todas as mudanças que ocorreram desde a sincronização anterior. A cada vez, o cliente fornece o token de sincronização anterior que ele recebeu do servidor e armazena o novo token de sincronização da resposta.

Sincronização completa inicial

A sincronização completa inicial é a solicitação original de todos os recursos da coleção que você quer sincronizar. Você pode restringir a solicitação de lista usando parâmetros de solicitação se quiser sincronizar apenas um subconjunto específico de recursos.

Na resposta à operação de lista, você encontra um campo chamado nextSyncToken, que representa um token de sincronização. Você vai precisar armazenar o valor de nextSyncToken. Se o conjunto de resultados for muito grande e a resposta for paginada, o campo nextSyncToken vai estar presente apenas na última página.

Sincronização incremental

A sincronização incremental permite recuperar todos os recursos que foram modificados desde a última solicitação de sincronização. Para isso, você precisa realizar uma solicitação de lista com o token de sincronização mais recente especificado no campo syncToken. O resultado sempre vai conter entradas excluídas, para que os clientes possam removê-las do armazenamento.

Nos casos em que um grande número de recursos mudou desde o último pedido de sincronização incremental, é possível encontrar um pageToken em vez de um syncToken no resultado da lista. Nesses casos, você precisa executar a mesma consulta de lista usada para recuperar a primeira página na sincronização incremental (com o mesmo syncToken), anexar o pageToken a ela e paginar todas as solicitações seguintes até encontrar outro syncToken na última página. Armazene esse syncToken para a próxima solicitação de sincronização no futuro.

Confira exemplos de consultas para um caso que exige sincronização paginada incremental:

Consulta original

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

// Result contains the following

"nextPageToken":"CiAKGjBpNDd2Nmp2Zml2cXRwYjBpOXA",

Buscando a próxima página

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

Sincronização completa necessária pelo servidor

Às vezes, os tokens de sincronização são invalidados pelo servidor por vários motivos, incluindo a expiração do token ou mudanças nas ACLs relacionadas. Nesses casos, o servidor vai responder a uma solicitação incremental com um código de resposta 410. Isso vai acionar uma limpeza completa da loja do cliente e uma nova sincronização completa.

Código de amostra

O snippet de código de exemplo abaixo demonstra como usar tokens de sincronização com a biblioteca cliente Java. Na primeira vez que o método de execução for chamado, ele vai realizar uma sincronização completa e armazenar o token de sincronização. Em cada execução subsequente, ele carrega o token de sincronização salvo e realiza uma sincronização incremental.

  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

Sincronização legada

Para coleções de eventos, ainda é possível fazer a sincronização de forma legada, preservando o valor do campo atualizado de uma solicitação de lista de eventos e usando o campo modifiedSince para extrair eventos atualizados. Essa abordagem não é mais recomendada, porque é mais propensa a erros em relação a atualizações perdidas (por exemplo, se não aplicar restrições de consulta). Além disso, ele está disponível apenas para eventos.