Dokumentacja atrybutów narzędzi

Chociaż Jetpack Compose obsługuje narzędzia do projektowania interfejsu bezpośrednio w języku Kotlin, przestrzeń nazw tools: jest nadal niezbędna do konfiguracji na poziomie projektu. Standardowe pliki XML Androida, takie jak AndroidManifest.xml i res/raw/keep.xml, używają atrybutów tools: do zarządzania ostrzeżeniami Lint i konfigurowania narzędzia do zmniejszania zasobów.

Podczas tworzenia aplikacji narzędzia do kompilacji usuwają te atrybuty, dzięki czemu nie mają one wpływu na rozmiar pliku APK ani na działanie aplikacji.

Aby użyć tych atrybutów, dodaj przestrzeń nazw tools do elementu głównego każdego pliku XML, w którym chcesz ich użyć, jak pokazano poniżej:

<RootTag xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools" >

Atrybuty obsługi błędów

Te atrybuty pomagają ukrywać komunikaty ostrzegawcze linta:

tools:ignore

Przeznaczenie: dowolny element.

Używane przez: Lint

Ten atrybut akceptuje listę identyfikatorów problemów z linterem rozdzieloną przecinkami, które narzędzia mają ignorować w przypadku tego elementu lub jego elementów podrzędnych.

Możesz na przykład nakazać narzędziom ignorowanie błędu MissingTranslation:

<string name="show_all_apps" tools:ignore="MissingTranslation">All</string>

tools:targetApi

Przeznaczenie: dowolny element

Używane przez: Lint

Ten atrybut działa tak samo jak adnotacja @TargetApi w kodzie Java lub adnotacja @RequiresApi w kodzie Kotlin. Umożliwia określenie poziomu interfejsu API (jako liczby całkowitej lub kryptonimu), który obsługuje ten element.

Dzięki temu narzędzia do analizy kodu będą wiedzieć, że ten element i wszystkie elementy podrzędne są używane tylko na określonym poziomie interfejsu API lub wyższym. Dzięki temu narzędzie lint nie będzie wyświetlać ostrzeżeń, jeśli dany element lub jego atrybuty nie są dostępne na poziomie interfejsu API określonym jako minSdkVersion.

Możesz na przykład użyć tego atrybutu, ponieważ deklarujesz element <service> w pliku AndroidManifest.xml, który używa typu usługi na pierwszym planie dostępnego tylko na poziomie interfejsu API 34 lub wyższym, ale wartość minSdkVersion w projekcie jest niższa:

<service
    android:name=".playback.MediaPlaybackService"
    android:foregroundServiceType="mediaPlayback"
    xmlns:tools="http://schemas.android.com/tools"
    tools:targetApi="34" />

tools:locale

Przeznaczenie: <resources>

Używane przez: Lint, edytor Android Studio

Dzięki temu narzędzia wiedzą, jaki jest domyślny język lub region zasobów w danym elemencie <resources>, co pozwala uniknąć ostrzeżeń ze strony modułu sprawdzania pisowni. W przeciwnym razie narzędzie zakłada, że językiem jest angielski.

Wartość musi być prawidłowym kwalifikatorem języka.

Możesz na przykład dodać ten kod do domyślnego pliku values/strings.xml, aby wskazać, że językiem używanym w domyślnych ciągach tekstowych jest hiszpański, a nie angielski:

<resources xmlns:tools="http://schemas.android.com/tools"
    tools:locale="es">

Atrybuty zmniejszania zasobów

Te atrybuty umożliwiają włączenie ścisłej kontroli plików referencyjnych i określenie, czy zachować, czy odrzucić określone zasoby podczas korzystania ze zmniejszania zasobów.

Aby włączyć zmniejszanie zasobów, ustaw właściwość shrinkResources na true w pliku build.gradle, obok minifyEnabled na potrzeby zmniejszania kodu.

Na przykład:

Dynamiczny

android {
    ...
    buildTypes {
        release {
            shrinkResources true
            minifyEnabled true
            proguardFiles getDefaultProguardFile('proguard-android.txt'),
                    'proguard-rules.pro'
        }
    }
}

Kotlin

android {
    ...
    buildTypes {
        getByName("release") {
            isShrinkResources = true
            isMinifyEnabled = true
            proguardFiles(
                getDefaultProguardFile("proguard-android.txt"),
                "proguard-rules.pro"
            )
        }
    }
}

tools:shrinkMode

Przeznaczenie: <resources>

Używane przez: narzędzia do kompilacji ze zmniejszaniem zasobów

Ten atrybut pozwala określić, czy narzędzia do kompilacji mają używać:

  • Tryb bezpieczny: zachowaj wszystkie zasoby, które są wyraźnie cytowane i mogą być dynamicznie przywoływane przez wywołanie Resources.getIdentifier.
  • Tryb ścisły: zachowuje tylko te zasoby, które są wyraźnie wymienione w kodzie lub w innych zasobach.

Domyślnie używany jest tryb bezpieczny (shrinkMode="safe"). Aby zamiast tego używać trybu ścisłego, dodaj shrinkMode="strict" do tagu <resources>, jak pokazano tutaj:

<?xml version="1.0" encoding="utf-8"?>
<resources xmlns:tools="http://schemas.android.com/tools"
    tools:shrinkMode="strict" />

Po włączeniu trybu ścisłego może być konieczne użycie tools:keep, aby zachować zasoby, które zostały usunięte, ale których potrzebujesz, oraz tools:discard, aby wyraźnie usunąć jeszcze więcej zasobów.

Więcej informacji znajdziesz w artykule o zmniejszaniu zasobów.

tools:keep

Przeznaczenie: <resources>

Używane przez: narzędzia do kompilacji ze zmniejszaniem zasobów

Gdy używasz zmniejszania zasobów do usuwania nieużywanych zasobów, ten atrybut pozwala określić zasoby, które mają zostać zachowane, zwykle dlatego, że są one przywoływane w sposób pośredni w czasie działania, np. przez przekazanie dynamicznie generowanej nazwy zasobu do Resources.getIdentifier.

Aby użyć tej funkcji, utwórz plik XML w katalogu zasobów (np. res/raw/keep.xml) z tagiem <resources> i określ każdy zasób, który chcesz zachować, w atrybucie tools:keep jako listę rozdzieloną przecinkami. Możesz użyć gwiazdki jako symbolu wieloznacznego.

Na przykład:

<?xml version="1.0" encoding="utf-8"?>
<resources xmlns:tools="http://schemas.android.com/tools"
    tools:keep="@layout/used_1,@layout/used_2,@layout/*_3" />

Więcej informacji znajdziesz w sekcji Zmniejszanie zasobów.

tools:discard

Przeznaczenie: <resources>

Używane przez: narzędzia do kompilacji ze zmniejszaniem zasobów

Gdy używasz zmniejszania zasobów do usuwania nieużywanych zasobów, ten atrybut pozwala określić zasoby, które chcesz ręcznie odrzucić, zwykle dlatego, że zasób jest przywoływany, ale w sposób, który nie wpływa na aplikację, lub dlatego, że wtyczka Gradle nieprawidłowo wywnioskowała, że zasób jest przywoływany.

Aby użyć tej funkcji, utwórz plik XML w katalogu zasobów (np. res/raw/keep.xml) z tagiem <resources> i określ każdy zasób do odrzucenia w atrybucie tools:discard jako listę rozdzieloną przecinkami. Możesz użyć gwiazdki jako symbolu wieloznacznego.

Na przykład:

<?xml version="1.0" encoding="utf-8"?>
<resources xmlns:tools="http://schemas.android.com/tools"
    tools:discard="@layout/unused_1" />

Więcej informacji znajdziesz w artykule o zmniejszaniu zasobów.

Dodatkowe materiały

Wyświetla treści