W tym dokumencie opisujemy techniki, które mogą poprawić wydajność Twojej aplikacji. Aby przedstawić niektóre rozwiązania, użyliśmy przykładów z innych interfejsów API lub ogólnych interfejsów API. Jednak te same pojęcia są używane w interfejsie Android Over The Air API.
Kompresja za pomocą gzip
Kompresja gzip pozwala łatwo i wygodnie zmniejszyć przepustowość potrzebną do obsługi żądań. Dekompresja wyników wymaga dodatkowego czasu pracy procesora, jednak w zestawieniu z kosztami związanymi z siecią to rozwiązanie wypada bardzo korzystnie.
Aby odebrać odpowiedź zakodowaną w formacie gzip, ustaw nagłówek Accept-Encoding i dodaj do klienta użytkownika tekst gzip. Oto przykład poprawnych nagłówków HTTP, za pomocą których włączysz kompresję 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 zapisywać niepotrzebnych pól, co pozwala wydajniej wykorzystywać zasoby, w tym sieć, procesor i pamięć.
Istnieją 2 typy częściowych żądań:
- 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 żądań częściowych znajdziesz w sekcjach poniżej.
Odpowiedź częściowa
Po przetworzeniu żądań serwer domyślnie odsyła pełną reprezentację zasobu. Aby uzyskać lepsze wyniki, możesz wysłać do serwera żądanie o odpowiedź częściową, czyli dostarczenie tylko tych pól, których potrzebujesz.
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 każdym żądaniu, które zwraca dane odpowiedzi.
Parametr fields wpływa tylko na dane odpowiedzi. Nie ma wpływu na dane, które chcesz wysłać. Aby zmniejszyć ilość danych wysyłanych po zmianie zasobów, użyj żądania poprawki.
Poprawka (częściowa aktualizacja)
Po zmianie zasobów nie musisz wysyłać niepotrzebnych danych. Aby wysłać tylko zaktualizowane dane pól, które zmieniasz, użyj czasownika HTTP PATCH. Opisana w tym dokumencie semantyka poprawki jest inna (i prostsza) niż w implementacji interfejsu GData częściowej aktualizacji.
Krótki przykład podany poniżej pokazuje, jak dzięki poprawce można zminimalizować ilość wysyłanych danych i zmniejszyć rozmiar aktualizacji.
Przykład
Obsługa odpowiedzi na poprawkę
Po przetworzeniu prawidłowego żądania poprawki interfejs API zwraca kod stanu 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, o ile nie użyto parametru fields, aby zmniejszyć ilość zwracanych danych.
Jeśli żądanie poprawki powoduje ustawienie nowego stanu żądania, 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.
Inny zapis w sytuacji, 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 pokazujemy poniżej:
POST https://www.googleapis.com/... X-HTTP-Method-Override: PATCH ...
Różnica między poprawką a aktualizacją
Kiedy wysyłasz dane żądania aktualizacji, które używa czasownika HTTP PUT, musisz wysłać tylko pola wymagane lub opcjonalne. Jeśli wyślesz wartości pól ustawionych przez serwer, zostaną one zignorowane. Może to wyglądać jak inna metoda wykonania częściowej aktualizacji, jednak ma to swoje ograniczenia. W przypadku aktualizacji, które używają czasownika HTTP PUT, żądanie nie uda się, jeśli nie podasz wymaganych parametrów, oraz wyczyści wcześniej ustawione dane, jeśli nie podasz parametrów opcjonalnych.
Z tego względu 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ą bez zmian. Jeśli podasz którekolwiek z nich, cały zbiór zostanie zastąpiony zbiorem, który podasz.