У каждого ресурса есть поле версии, которое меняется каждый раз при изменении ресурса — поле etag
. Etags являются стандартной частью HTTP и поддерживаются в API календаря в двух случаях:
- при изменении ресурса, чтобы гарантировать, что в это время в этот ресурс не производилось других записей (условная модификация)
- при извлечении ресурса, чтобы получать данные о ресурсе только в том случае, если ресурс изменился (условное извлечение)
Условная модификация
Если вы хотите обновить или удалить ресурс только в том случае, если он не изменился с момента его последнего извлечения, вы можете указать заголовок If-Match
, содержащий значение etag из предыдущего извлечения. Это очень полезно для предотвращения потери изменений ресурсов. Клиенты имеют возможность повторно получить ресурс и повторно применить изменения.
Если запись (и ее etag) не изменилась с момента последнего извлечения, модификация завершится успешно, и будет возвращена новая версия ресурса с новым etag. В противном случае вы получите код ответа 412 (предварительное условие не выполнено).
В приведенном ниже фрагменте кода показано, как выполнять условные изменения с помощью клиентской библиотеки 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; } } }