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

इस गाइड में, कैलेंडर डेटा के "इंक्रीमेंटल सिंक" को लागू करने का तरीका बताया गया है. इस तरीके का इस्तेमाल करके, सभी कैलेंडर कलेक्शन का डेटा सिंक किया जा सकता है. साथ ही, बैंडविड्थ भी बचती है.

कॉन्टेंट

खास जानकारी

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

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

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

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

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

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

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

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

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