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

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

सामग्री

खास जानकारी

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

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

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

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

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

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

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

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

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