W tym dokumencie opisujemy kilka technik, których możesz użyć, aby poprawić wydajność swojej aplikacji. W niektórych przypadkach do zilustrowania przedstawionych pomysłów użyliśmy przykładów z innych interfejsów API lub ogólnych interfejsów API. Te same pojęcia dotyczą jednak Android Over The Air API.
Kompresja za pomocą gzip
Kompresja gzip pozwala łatwo i wygodnie zmniejszyć przepustowość potrzebną do obsługi żądań. Mimo że dekompresja wyników wymaga dodatkowego czasu procesora, to kompresja kosztów sieciowych zazwyczaj jest bardzo korzystna.
Aby odebrać odpowiedź zakodowaną w formacie gzip, ustaw nagłówek Accept-Encoding i dodaj do klienta użytkownika ciąg tekstowy gzip. Oto przykład prawidłowo sformatowanych nagłówków HTTP, które umożliwiają włączenie kompresji gzip:
Accept-Encoding: gzip User-Agent: my program (gzip)
Praca z częściowymi zasobami
Innym sposobem na poprawę wydajności wywołań interfejsu API jest wysyłanie i odbieranie tylko części danych, które Cię interesują. Dzięki temu aplikacja nie musi przesyłać, analizować i przechowywać niepotrzebnych pól, a tym samym efektywniej wykorzystywać zasoby, w tym sieć, procesor i pamięć.
Istnieją 2 typy żądań częściowych:
- Odpowiedź częściowa: w tym żądaniu wybierasz, które pola mają znajdować się w odpowiedzi (użyj parametru żądania
fields). - Poprawka: w tym żądaniu aktualizacji wysyłasz tylko te pola, które chcesz zmienić (użyj czasownika HTTP
PATCH).
Więcej informacji na temat tworzenia częściowych żądań znajdziesz w sekcjach poniżej.
Odpowiedź częściowa
Po przetworzeniu żądań serwer domyślnie odsyła pełną reprezentację zasobu. Aby zwiększyć wydajność, możesz wysłać do serwera żądanie, by wysyłał tylko te pola, których potrzebujesz, i otrzymał odpowiedź częściową.
Aby wysłać takie żądanie, użyj parametru żądania fields, określając w nim pola, które chcesz odebrać w odpowiedzi. Tego parametru możesz użyć w przypadku każdego żądania, które zwraca dane odpowiedzi.
Pamiętaj, że parametr fields wpływa tylko na dane odpowiedzi. Nie ma wpływu na dane, które musisz wysłać. Aby zmniejszyć ilość danych wysyłanych po zmianie zasobów, użyj żądania poprawki.
Przykład
Poprawka (częściowa aktualizacja)
Nie musisz też wysyłać niepotrzebnych danych podczas modyfikowania zasobów. Aby wysłać tylko zaktualizowane dane pól, które zmieniasz, użyj czasownika HTTP PATCH. Semantyka poprawki opisana w tym dokumencie jest inna (i prostsza) niż w przypadku starszej implementacji częściowej aktualizacji GData.
Krótki przykład poniżej pokazuje, jak użycie poprawki pozwala zminimalizować ilość danych, które trzeba wysyłać przy dokonywaniu niewielkiej aktualizacji.
Przykład
Obsługa odpowiedzi na poprawkę
Po przetworzeniu prawidłowego żądania poprawki interfejs API zwraca kod odpowiedzi HTTP 200 OK i pełną reprezentację zmienionego zasobu. Jeśli interfejs API używa znaczników ETag, serwer aktualizuje wartości ETag po przetworzeniu żądania poprawki, tak jak w przypadku PUT.
Żądanie poprawki zwraca reprezentację całego zasobu, chyba że używasz parametru fields, aby zmniejszyć ilość zwracanych danych.
Jeśli żądanie poprawki powoduje ustawienie nowego stanu zasobu, który jest składniowo lub semantycznie nieprawidłowy, serwer zwraca kod stanu HTTP 400 Bad Request lub 422 Unprocessable Entity, a stan zasobu pozostaje bez zmian. Jeśli na przykład spróbujesz usunąć wartość pola wymaganego, serwer zwróci błąd.
Alternatywny zapis, gdy czasownik HTTP PATCH nie jest obsługiwany
Jeśli zapora sieciowa nie zezwala na żądania HTTP PATCH, wykonaj żądanie HTTP POST i ustaw nagłówek zastąpienia na PATCH, jak pokazano poniżej:
POST https://www.googleapis.com/... X-HTTP-Method-Override: PATCH ...
Różnica między poprawką a aktualizacją
Gdy wysyłasz dane żądania aktualizacji, które używa czasownika HTTP PUT, musisz wysłać tylko te pola, które są wymagane lub opcjonalne. Jeśli wyślesz wartości pól ustawionych przez serwer, zostaną one zignorowane. Może się to wydawać inny sposób przeprowadzenia częściowej aktualizacji, ale ma pewne ograniczenia. W przypadku aktualizacji, które używają czasownika HTTP PUT, żądanie nie powiedzie się, jeśli nie podasz wymaganych parametrów, oraz czyści ustawione wcześniej dane, jeśli nie podasz parametrów opcjonalnych.
Z tego powodu dużo bezpieczniejsze jest użycie poprawki. Podajesz tylko dane pól, które chcesz zmienić. Pominięte pola nie są opróżniane. Jedynym wyjątkiem od tej reguły są powtarzające się elementy lub tablice. Jeśli pominiesz je wszystkie, pozostaną niezmienione. Jeśli podasz którykolwiek z nich, cały zbiór zostanie zastąpiony przez Ciebie.