Konfiguracja biblioteki pomocy

Uwaga: wraz z Androidem 9.0 (poziom API 28) pojawiła się nowa wersja biblioteki pomocy o nazwie AndroidX, która jest częścią Jetpack. Biblioteka AndroidX zawiera dotychczasową bibliotekę pomocy, a także najnowsze komponenty Jetpack.

Możesz nadal korzystać z biblioteki pomocy. Artefakty historyczne (wersje 27 i starsze, spakowane jako android.support.*) pozostaną dostępne w Google Maven. Jednak wszystkie nowe biblioteki będą rozwijane w ramach biblioteki AndroidX.

We recommend using the AndroidX libraries in all new projects. Warto też rozważyć przeniesienie istniejących projektów na AndroidX.

Sposób konfiguracji bibliotek pomocy Androida w projekcie deweloperskim zależy od funkcji, których chcesz używać, oraz od zakresu wersji platformy Android, które chcesz obsługiwać w swojej aplikacji.

Z tego dokumentu dowiesz się, jak pobrać pakiet biblioteki pomocy i dodać biblioteki do środowiska programistycznego.

Biblioteki pomocy są teraz dostępne w repozytorium Maven Google. Nie obsługujemy już pobierania bibliotek za pomocą Menedżera pakietu SDK, a ta funkcja wkrótce zostanie usunięta.

Wybieranie bibliotek pomocy

Zanim dodasz bibliotekę pomocy do aplikacji, zdecyduj, jakie funkcje chcesz uwzględnić i jakie najstarsze wersje Androida chcesz obsługiwać. Więcej informacji o funkcjach poszczególnych bibliotek znajdziesz w artykule Funkcje biblioteki pomocy.

Dodawanie bibliotek pomocy

Aby korzystać z biblioteki pomocy, musisz zmodyfikować zależności ścieżki klas projektu aplikacji w środowisku programistycznym. Musisz wykonać tę procedurę w przypadku każdej biblioteki pomocy, której chcesz używać.

Aby dodać bibliotekę pomocy do projektu aplikacji:

  1. Dodaj repozytorium Maven firmy Google do pliku settings.gradle projektu.
    dependencyResolutionManagement {
        repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
        repositories {
            google()
    
            // If you're using a version of Gradle lower than 4.1, you must
            // instead use:
            //
            // maven {
            //     url 'https://maven.google.com'
            // }
        }
    }
  2. W przypadku każdego modułu, w którym chcesz używać biblioteki pomocy, dodaj ją w bloku dependencies pliku build.gradle modułu. Na przykład, aby dodać bibliotekę v4 core-utils, dodaj ten kod:
    dependencies {
        ...
        implementation "com.android.support:support-core-utils:28.0.0"
    }

Ostrzeżenie: używanie zależności dynamicznych (np. palette-v7:23.0.+) może powodować nieoczekiwane aktualizacje wersji i niezgodności regresyjne. Zalecamy wyraźne określenie wersji biblioteki (np. palette-v7:28.0.0).

Korzystanie z interfejsów API biblioteki pomocy

Klasy biblioteki pomocy, które obsługują istniejące interfejsy API platformy, mają zwykle taką samą nazwę jak klasy platformy, ale znajdują się w android.supportpakietach klas*Compat lub mają sufiks *Compat.

Ostrzeżenie: podczas korzystania z klas z biblioteki pomocy upewnij się, że importujesz klasę z odpowiedniego pakietu. Na przykład podczas stosowania klasy ActionBar:

  • android.support.v7.app.ActionBar podczas korzystania z biblioteki pomocy.
  • android.app.ActionBar, jeśli tworzysz aplikację tylko na interfejs API na poziomie 11 lub wyższym.

Uwaga: po dodaniu biblioteki pomocy do projektu aplikacji zdecydowanie zalecamy zmniejszenie, zaciemnienie i zoptymalizowanie aplikacji przed jej opublikowaniem. Oprócz ochrony kodu źródłowego za pomocą zaciemniania zmniejszanie usuwa nieużywane klasy z bibliotek dołączonych do aplikacji, co pozwala utrzymać jak najmniejszy rozmiar pobierania aplikacji.

Dodatkowe wskazówki dotyczące korzystania z niektórych funkcji biblioteki pomocy znajdziesz w kursach, przewodnikach i przykładach dla deweloperów Androida. Więcej informacji o poszczególnych klasach i metodach biblioteki pomocy znajdziesz w android.supportpakietach w dokumentacji interfejsu API.

Zmiany w deklaracji manifestu

Jeśli zwiększasz zgodność wsteczną istniejącej aplikacji z wcześniejszą wersją interfejsu API Androida za pomocą biblioteki pomocy, pamiętaj o zaktualizowaniu pliku manifestu aplikacji. W szczególności zaktualizuj element android:minSdkVersion tagu <uses-sdk> w pliku manifestu do nowego, niższego numeru wersji, jak pokazano poniżej:

  <uses-sdk
      android:minSdkVersion="14"
      android:targetSdkVersion="23" />

Ustawienie w pliku manifestu informuje Google Play, że aplikację można zainstalować na urządzeniach z Androidem 4.0 (poziom interfejsu API 14) lub nowszym.

Jeśli używasz plików kompilacji Gradle, ustawienie minSdkVersion w pliku kompilacji zastępuje ustawienia manifestu.

plugins {
  id 'com.android.application'
}

android {
    ...

    defaultConfig {
        minSdkVersion 16
        ...
    }
    ...
}

W tym przypadku ustawienie pliku kompilacji informuje Google Play, że domyślną odmianę kompilacji aplikacji można zainstalować na urządzeniach z Androidem 4.1 (poziom API 16) i nowszym. Więcej informacji o wariantach kompilacji znajdziesz w omówieniu systemu kompilacji.

Uwaga: jeśli dołączasz kilka bibliotek pomocy, minimalna wersja pakietu SDK musi być najwyższą wersją wymaganą przez którąkolwiek z określonych bibliotek. Jeśli na przykład aplikacja zawiera bibliotekę obsługi preferencji w wersji 14bibliotekę Leanback w wersji 17, minimalna wersja pakietu SDK musi wynosić 17 lub więcej.