संसाधनों को बेहतर तरीके से सिंक करें

इस गाइड में, कैलेंडर के डेटा को धीरे-धीरे सिंक करने का तरीका बताया गया है. इस तरीके का इस्तेमाल करके, बैंडविड्थ को सेव करते हुए, सभी कैलेंडर कलेक्शन के डेटा को सिंक में रखा जा सकता है.

सामग्री

खास जानकारी

इंक्रीमेंटल सिंक्रनाइज़ेशन में दो चरण होते हैं:

  1. शुरुआती फ़ुल सिंक: यह प्रोसेस, शुरुआत में एक बार की जाती है. इससे क्लाइंट की स्थिति को सर्वर की स्थिति के साथ पूरी तरह से सिंक किया जाता है. क्लाइंट को एक सिंक टोकन मिलता है, जिसे उसे सेव करके रखना होता है.

  2. इंक्रीमेंटल सिंक: यह प्रोसेस बार-बार की जाती है, ताकि क्लाइंट को पिछली बार सिंक करने के बाद हुए सभी बदलावों के बारे में अपडेट किया जा सके. हर बार, क्लाइंट सर्वर से मिला पिछला सिंक टोकन देता है और रिस्पॉन्स से मिले नए सिंक टोकन को सेव करता है.

पहली बार पूरा डेटा सिंक करना

शुरुआती फ़ुल सिंक, उस कलेक्शन के सभी संसाधनों के लिए किया गया ओरिजनल अनुरोध होता है जिसे आपको सिंक करना है. अगर आपको सिर्फ़ संसाधनों के किसी खास सबसेट को सिंक करना है, तो अनुरोध पैरामीटर का इस्तेमाल करके, सूची के अनुरोध को सीमित किया जा सकता है.

सूची बनाने के ऑपरेशन के जवाब में, एक फ़ील्ड होता है. इसका नाम nextSyncToken होता है. यह सिंक टोकन को दिखाता है. आपको nextSyncToken एट्रिब्यूट की वैल्यू सेव करनी होगी. अगर नतीजों का सेट बहुत बड़ा है और जवाब को पेज के हिसाब से बांटा गया है, तो nextSyncToken फ़ील्ड सिर्फ़ आखिरी पेज पर मौजूद होता है.

इंक्रीमेंटल सिंक

इंक्रीमेंटल सिंक की मदद से, उन सभी संसाधनों को वापस पाया जा सकता है जिनमें आखिरी सिंक के बाद बदलाव किया गया है. इसके लिए, syncToken फ़ील्ड में दिए गए सबसे हाल के सिंक टोकन के साथ, सूची बनाने का अनुरोध करें. ध्यान रखें कि नतीजे में हमेशा मिटाई गई एंट्री शामिल होती हैं, ताकि क्लाइंट उन्हें स्टोरेज से हटा सकें.

अगर पिछली बार इंक्रीमेंटल सिंक के अनुरोध के बाद से, कई संसाधनों में बदलाव हुआ है, तो आपको सूची के नतीजे में syncToken के बजाय pageToken दिख सकता है. इन मामलों में, सूची के लिए वही क्वेरी चलाएं जिसका इस्तेमाल इंक्रीमेंटल सिंक में पहले पेज को वापस पाने के लिए किया गया था (उसी 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

सर्वर को पूरा डेटा सिंक करने की ज़रूरत है

कभी-कभी सर्वर, सिंक टोकन को अमान्य कर देता है. ऐसा टोकन की समयसीमा खत्म होने या उससे जुड़ी एसीएल में बदलाव होने की वजह से होता है. ऐसे मामलों में, सर्वर, इंक्रीमेंटल अनुरोध का जवाब एचटीटीपी स्टेटस कोड 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 फ़ील्ड का इस्तेमाल करें. अब इस तरीके का इस्तेमाल करने का सुझाव नहीं दिया जाता, क्योंकि इसमें गड़बड़ियां होने की आशंका ज़्यादा होती है. उदाहरण के लिए, यह क्वेरी पर पाबंदियां लागू नहीं करता. साथ ही, यह सिर्फ़ इवेंट के लिए उपलब्ध है.