每個資源都有一個版本欄位,會在資源每次變更時變更 (etag
欄位)。Etag 是 HTTP 的標準部分,且適用於 Calendar API,有兩種情況:
- 資源修改作業,確保在此期間沒有任何其他寫入資源 (條件式修改)
- 擷取資源時,只在資源變更時擷取資源資料 (條件式擷取)
條件式修改
如果資源自您上次擷取後並未變更,才想要更新或刪除該資源,您可以指定包含先前擷取作業中 etag 值的 If-Match
標頭。這非常實用,可以防止資源遺失。用戶端可以選擇重新擷取資源並重新套用變更。
如果項目 (及其 etag) 自上次擷取後未變更,則修改成功,系統會傳回包含新 etag 的新版本資源。否則,您會收到 412 (Precondition failed) 回應代碼。
下列程式碼範例示範如何使用 Java 用戶端程式庫執行條件修改。
private static void run() throws IOException { // Create a test event. Event event = Utils.createTestEvent(client, "Test Event"); System.out.println(String.format("Event created: %s", event.getHtmlLink())); // Pause while the user modifies the event in the Calendar UI. System.out.println("Modify the event's description and hit enter to continue."); System.in.read(); // Modify the local copy of the event. event.setSummary("Updated Test Event"); // Update the event, making sure that we don't overwrite other changes. int numAttempts = 0; boolean isUpdated = false; do { Calendar.Events.Update request = client.events().update("primary", event.getId(), event); request.setRequestHeaders(new HttpHeaders().setIfMatch(event.getEtag())); try { event = request.execute(); isUpdated = true; } catch (GoogleJsonResponseException e) { if (e.getStatusCode() == 412) { // A 412 status code, "Precondition failed", indicates that the etag values didn't // match, and the event was updated on the server since we last retrieved it. Use // {@link Calendar.Events.Get} to retrieve the latest version. Event latestEvent = client.events().get("primary", event.getId()).execute(); // You may want to have more complex logic here to resolve conflicts. In this sample we're // simply overwriting the summary. latestEvent.setSummary(event.getSummary()); event = latestEvent; } else { throw e; } } numAttempts++; } while (!isUpdated && numAttempts <= MAX_UPDATE_ATTEMPTS); if (isUpdated) { System.out.println("Event updated."); } else { System.out.println(String.format("Failed to update event after %d attempts.", numAttempts)); } }
條件式擷取
如果只想擷取自上次擷取後有所變更的資源,可以指定 If-None-Match
標頭,其中包含先前擷取的 etag 值。如果項目 (及其 etag) 自上次擷取後有所變更,系統將傳回包含新 etag 的新版本資源。否則,您就會收到 304 (未經修改) 回應代碼。
下列程式碼範例示範如何使用 Java 用戶端程式庫執行條件式擷取。
private static void run() throws IOException { // Create a test event. Event event = Utils.createTestEvent(client, "Test Event"); System.out.println(String.format("Event created: %s", event.getHtmlLink())); // Pause while the user modifies the event in the Calendar UI. System.out.println("Modify the event's description and hit enter to continue."); System.in.read(); // Fetch the event again if it's been modified. Calendar.Events.Get getRequest = client.events().get("primary", event.getId()); getRequest.setRequestHeaders(new HttpHeaders().setIfNoneMatch(event.getEtag())); try { event = getRequest.execute(); System.out.println("The event was modified, retrieved latest version."); } catch (GoogleJsonResponseException e) { if (e.getStatusCode() == 304) { // A 304 status code, "Not modified", indicates that the etags match, and the event has // not been modified since we last retrieved it. System.out.println("The event was not modified, using local version."); } else { throw e; } } }