Ulepszanie kodu za pomocą sprawdzania lintków

Oprócz tworzenia testów, które pozwalają sprawdzić, czy aplikacja spełnia wymagania funkcjonalne, ważne jest też uruchomienie kodu za pomocą narzędzia lint, aby upewnić się, że nie ma on problemów strukturalnych. Narzędzie lint pomaga znaleźć źle ustrukturyzowany kod, który może wpływać na niezawodność i wydajność aplikacji na Androida oraz utrudniać utrzymanie kodu. Zdecydowanie zalecamy poprawienie wszystkich błędów wykrytych przez narzędzie lint przed opublikowaniem aplikacji.

Jeśli na przykład pliki zasobów XML zawierają nieużywane przestrzenie nazw, zajmują one miejsce i wymagają niepotrzebnego przetwarzania. Inne problemy strukturalne, takie jak użycie wycofanych elementów lub wywołań interfejsu API, które nie są obsługiwane przez docelowe wersje interfejsu API, mogą powodować nieprawidłowe działanie kodu. Lint może pomóc Ci rozwiązać te problemy.

Aby poprawić wydajność analizy, możesz też dodać adnotacje do kodu.

Przegląd

Android Studio udostępnia narzędzie do skanowania kodu o nazwie lint, które pomaga identyfikować i rozwiązywać problemy ze strukturą kodu bez konieczności uruchamiania aplikacji czy pisania przypadków testowych. Każdy problem wykryty przez narzędzie jest zgłaszany z opisem i poziomem ważności, dzięki czemu możesz nadać priorytet krytycznym ulepszeniom, które należy wprowadzić. Możesz też obniżyć poziom ważności problemu, aby zignorować problemy, które nie są istotne dla Twojego projektu, lub podnieść poziom ważności, aby wyróżnić konkretne problemy.

Narzędzie lint sprawdza pliki źródłowe projektu aplikacji na Androida pod kątem potencjalnych błędów i możliwości optymalizacji, aby zapewnić poprawność, bezpieczeństwo, wydajność, użyteczność, ułatwienia dostępu i umiędzynarodowienie. Gdy używasz Android Studio, skonfigurowane kontrole narzędzia lint i IDE są uruchamiane podczas kompilowania aplikacji. Możesz jednak uruchamiać kontrole ręcznie lub uruchamiać narzędzie lint z wiersza poleceń, jak opisano na tej stronie.

Wbudowane narzędzie lint sprawdza kod, gdy używasz Android Studio. Ostrzeżenia i błędy możesz wyświetlać na 2 sposoby:

  • jako wyskakujący tekst w oknie edytora, Gdy narzędzie lint znajdzie problem, podświetla problematyczny kod na żółto. W przypadku poważniejszych problemów kod jest podkreślany na czerwono.
  • W oknie Inspection Results (Wyniki kontroli) po kliknięciu Code > Inspect Code (Kod > Sprawdź kod).

Uwaga: gdy kod jest kompilowany w Android Studio, uruchamiane są dodatkowe inspekcje kodu IntelliJ, które usprawniają jego sprawdzanie. Aktualizuj Android Studio, aby mieć dostęp do najnowszych reguł i kontroli linta.

Rysunek 1 pokazuje, jak narzędzie lint przetwarza pliki źródłowe aplikacji.

Przepływ pracy skanowania kodu za pomocą narzędzia lint.
Rysunek 1. Przepływ pracy skanowania kodu za pomocą narzędzia lint.
Pliki źródłowe aplikacji
Pliki źródłowe to pliki, które składają się na projekt aplikacji na Androida, w tym pliki Kotlin i plik XML, ikony oraz pliki konfiguracji ProGuard.
Plik lint.xml
Plik konfiguracji, za pomocą którego możesz określić kontrole lint, które chcesz wykluczyć, oraz dostosować poziomy ważności problemów.
Narzędzie lint
Narzędzie do skanowania kodu statycznego, które można uruchomić w projekcie aplikacji na Androida z poziomu wiersza poleceń lub w Android Studio. Narzędzie lint sprawdza, czy w kodzie nie ma problemów strukturalnych, które mogłyby wpłynąć na jakość i wydajność aplikacji na Androida.
Wyniki sprawdzania kodu
Wyniki działania narzędzia lint możesz wyświetlić w konsoli lub w oknie Inspection Results (Wyniki kontroli) w Android Studio. Jeśli uruchomisz lint z wiersza poleceń, wyniki zostaną zapisane w folderze build/. Więcej informacji znajdziesz w sekcji dotyczącej ręcznego przeprowadzania kontroli.

Uruchamianie narzędzia lint z wiersza poleceń

Jeśli używasz Androida Studio lub Gradle, użyj opakowania Gradle, aby wywołać zadanie lint dla projektu, wpisując jedno z tych poleceń w katalogu głównym projektu:

Uwaga: aby korzystać z najnowszych reguł linta, dbaj o to, aby wtyczka Androida do obsługi Gradle była zawsze aktualna.

  • Windows:
    gradlew lint
    
  • W systemie Linux lub macOS:
    ./gradlew lint
    

Zostaną wyświetlone dane wyjściowe podobne do tych:

> Task :app:lintDebug
Wrote HTML report to file:<path-to-project>/app/build/reports/lint-results-debug.html

Po zakończeniu sprawdzania narzędzie lint podaje ścieżki do wersji XML i HTML raportu. Następnie możesz przejść do raportu HTML i otworzyć go w przeglądarce, jak pokazano na rysunku 2.

Przykładowy raport HTML lint
Rysunek 2. Przykładowy raport HTML lint.

Jeśli projekt zawiera warianty kompilacji, lint sprawdza tylko wariant domyślny. Jeśli chcesz uruchomić lint w innym wariancie, musisz zapisać nazwę wariantu wielkimi literami i dodać przed nią prefiks lint.

./gradlew lintRelease

Uwaga: Lint nie jest automatycznie uruchamiany w ramach kompilacji. Zdecydowanie zalecamy uruchamianie narzędzia lint w ramach kompilacji w trybie ciągłej integracji, aby podczas kompilowania istniejącego kodu źródłowego widzieć najnowsze wyniki sprawdzania.

Więcej informacji o uruchamianiu zadań Gradle z wiersza poleceń znajdziesz w artykule Kompilowanie aplikacji z wiersza poleceń.

Uruchamianie narzędzia lint jako samodzielnego narzędzia

Jeśli nie używasz Android Studio ani Gradle, zainstaluj narzędzia wiersza poleceń Android SDK, aby korzystać z samodzielnego narzędzia lint. Narzędzie do analizy kodu znajdziesz w android_sdk/cmdline-tools/version/bin/lint.

Uwaga: jeśli spróbujesz uruchomić samodzielne narzędzie w projekcie Gradle, pojawi się błąd. Do uruchamiania narzędzia lint w projekcie Gradle zawsze używaj polecenia gradle lint (w systemie Windows) lub ./gradlew lint (w systemie macOS lub Linux).

Aby uruchomić analizę statyczną na liście plików w katalogu projektu, użyj tego polecenia:

lint [flags] <project directory>

Możesz na przykład wydać to polecenie, aby przeskanować pliki w katalogu myproject i jego podkatalogach. Identyfikator problemu MissingPrefix informuje narzędzie lint, że ma skanować tylko atrybuty XML, które nie mają prefiksu przestrzeni nazw Androida.

lint --check MissingPrefix myproject 

Aby wyświetlić pełną listę flag i argumentów wiersza poleceń obsługiwanych przez narzędzie, użyj tego polecenia:

lint --help

Poniższy przykład pokazuje dane wyjściowe konsoli po uruchomieniu polecenia lint w projekcie o nazwie Earthquake:

$ lint Earthquake

Scanning Earthquake: ...............................................................................................................................
Scanning Earthquake (Phase 2): .......
AndroidManifest.xml:23: Warning: <uses-sdk> tag appears after <application> tag [ManifestOrder]
  <uses-sdk android:minSdkVersion="7" />
  ^
AndroidManifest.xml:23: Warning: <uses-sdk> tag should specify a target API level (the highest verified version; when running on later versions, compatibility behaviors may be enabled) with android:targetSdkVersion="?" [UsesMinSdkAttributes]
  <uses-sdk android:minSdkVersion="7" />
  ^
res: Warning: Missing density variation folders in res: drawable-xhdpi [IconMissingDensityFolder]
0 errors, 4 warnings

Przykładowe dane wyjściowe zawierają 3 ostrzeżenia i żadnych błędów.

Dwa ostrzeżenia dotyczą pliku AndroidManifest.xml projektu:

  • ManifestOrder
  • UsesMinSdkAttributes

Jedno ostrzeżenie dotyczy katalogu res: IconMissingDensityFolder.

Konfigurowanie narzędzia lint w celu pomijania ostrzeżeń

Domyślnie, gdy uruchamiasz skanowanie lint, narzędzie sprawdza wszystkie problemy, które obsługuje lint. Możesz też ograniczyć problemy, które ma sprawdzać lint, i przypisać im poziomy ważności. Możesz na przykład pominąć sprawdzanie pod kątem konkretnych problemów, które nie są istotne dla Twojego projektu, i skonfigurować narzędzie lint tak, aby zgłaszało problemy niekrytyczne na niższym poziomie ważności.

Poziomy ważności:

  • enable
  • disable lub ignore
  • informational
  • warning
  • error
  • fatal

Możesz skonfigurować sprawdzanie błędów na różnych poziomach:

  • Globalnie (cały projekt)
  • Moduł projektu
  • Moduł produkcyjny
  • Testowanie modułu
  • Otwórz pliki
  • Hierarchia klas
  • Zakresy systemu kontroli wersji (VCS)

Konfigurowanie pliku lint

Ustawienia sprawdzania błędów możesz określić w pliku lint.xml. Jeśli tworzysz ten plik ręcznie, umieść go w katalogu głównym projektu aplikacji na Androida.

Plik lint.xml składa się z otaczającego tagu nadrzędnego <lint>, który zawiera co najmniej 1 element podrzędny <issue>. Lint definiuje unikalną wartość atrybutu id dla każdego elementu <issue>:

<?xml version="1.0" encoding="UTF-8"?>
<lint>
    <!-- list of issues to configure -->
</lint>

Aby zmienić poziom ważności problemu lub wyłączyć sprawdzanie błędów, ustaw atrybut ważności w tagu <issue>.

Wskazówka: aby wyświetlić pełną listę problemów obsługiwanych przez narzędzie lint i odpowiadających im identyfikatorów, uruchom polecenie lint --list. Opcję --list należy uruchomić z samodzielnego narzędzia lint.

Przykładowy plik lint.xml

Ten przykład pokazuje zawartość pliku lint.xml:

<?xml version="1.0" encoding="UTF-8"?>
<lint>
    <!-- Disable the ComposableNaming check in this project -->
    <issue id="ComposableNaming" severity="ignore" />

    <!-- Ignore the ComposeUnrememberedState issue in the specified files -->
    <issue id="ComposeUnrememberedState">
        <ignore path="src/main/java/com/example/myapp/MainActivity.kt" />
        <ignore path="src/main/java/com/example/myapp/ui/components/SpecialButton.kt" />
    </issue>

    <!-- Ignore the ComposeModifierMissing issue in the specified file -->
    <issue id="ComposeModifierMissing">
        <ignore path="src/main/java/com/example/myapp/ui/screens/HomeScreen.kt" />
    </issue>

    <!-- Change the severity of hardcoded strings to "error" -->
    <issue id="HardcodedText" severity="error" />
</lint>

Ten przykład pokazuje, jak skonfigurowane są różne typy problemów. Sprawdzanie ComposableNaming jest całkowicie wyłączone, a sprawdzanie ComposeUnrememberedState jest wyłączone tylko w plikach określonych w załączonych deklaracjach <ignore ... />.

Konfigurowanie sprawdzania błędów w plikach źródłowych Kotlin i XML

Możesz wyłączyć sprawdzanie błędów w plikach źródłowych Kotlin i XML w oknie Ustawienia:

  1. Wybierz Plik > Ustawienia (w systemie Windows) lub Android Studio > Preferencje (w systemie macOS lub Linux).
  2. Wybierz Editor > Inspections (Edytor > Inspekcje).
  3. Aby wyłączyć, odznacz odpowiedni plik źródłowy.

Możesz je ustawić dla IDE lub poszczególnych projektów, wybierając odpowiedni profil.

Konfigurowanie sprawdzania błędów w języku Kotlin

Aby wyłączyć sprawdzanie błędów w klasie lub funkcji w projekcie aplikacji na Androida, dodaj do tego kodu adnotację @SuppressLint.

Poniższy przykład pokazuje, jak wyłączyć sprawdzanie błędów w przypadku problemu NewApi w określonej funkcji. Narzędzie lint nadal sprawdza, czy w innych funkcjach tej klasy nie występuje problem NewApi.

@SuppressLint("NewApi")
fun logNotificationChannelInfo() {
    // Uses NotificationChannel (requires API 26+)
    // ...
}

To samo można zrobić w przypadku dowolnego elementu kompozycyjnego. Poniższy fragment kodu pokazuje, jak wyłączyć sprawdzanie NewApi w dowolnym elemencie Composable.

@SuppressLint("NewApi")
@Composable
fun MyComposable() {
    // ...
}

Poniższy przykład pokazuje, jak wyłączyć sprawdzanie błędów Lint w przypadku problemu ParserError w klasie FeedProvider:

@SuppressLint("ParserError")
class FeedProvider : ContentProvider() {

Aby pominąć sprawdzanie wszystkich problemów z analizą statyczną w pliku, użyj słowa kluczowego all:

@SuppressLint("all")

Możesz użyć tej samej adnotacji, aby pominąć sprawdzanie błędów w dowolnej funkcji typu „composable”.

Konfigurowanie sprawdzania błędów w pliku XML

Użyj atrybutu tools:ignore, aby wyłączyć sprawdzanie błędów w określonych sekcjach plików XML. Wpisz tę wartość przestrzeni nazw w pliku lint.xml, aby narzędzie lint rozpoznało atrybut:

namespace xmlns:tools="http://schemas.android.com/tools"

Poniższy przykład pokazuje, jak wyłączyć sprawdzanie błędów w przypadku problemu UnusedResources w elemencie <resources> pliku strings.xml. Atrybut ignore jest dziedziczony przez elementy podrzędne elementu nadrzędnego, w którym jest zadeklarowany. W tym przykładzie kontrola błędów jest też wyłączona dla wszystkich elementów <string>:

<resources
    xmlns:tools="http://schemas.android.com/tools"
    tools:ignore="UnusedResources" >

    <string name="app_name">My App</string>
    <string name="unused_string">Unused String</string>
</resources>

Aby wyłączyć więcej niż 1 problem, podaj je w ciągu znaków rozdzielonych przecinkami. Przykład:

tools:ignore="NewApi,StringFormatInvalid"

Aby pominąć sprawdzanie wszystkich problemów z lintem w elemencie XML, użyj słowa kluczowego all:

tools:ignore="all"

Konfigurowanie opcji analizatora kodu za pomocą Gradle

Wtyczka Androida do obsługi Gradle umożliwia konfigurowanie niektórych opcji linta, np. kontroli, które mają być uruchamiane lub ignorowane, za pomocą bloku lint{} w pliku build.gradle na poziomie modułu.

Poniższy fragment kodu pokazuje niektóre właściwości, które możesz skonfigurować:

Kotlin

android {
    ...
    lint {
        // Turns off checks for the issue IDs you specify.
        disable += "TypographyFractions" + "TypographyQuotes"
        // Turns on checks for the issue IDs you specify. These checks are in
        // addition to the default lint checks.
        enable += "RtlHardcoded" + "RtlCompat" + "RtlEnabled"
        // To enable checks for only a subset of issue IDs and ignore all others,
        // list the issue IDs with the 'check' property instead. This property overrides
        // any issue IDs you enable or disable using the properties above.
        checkOnly += "NewApi" + "InlinedApi"
        // If set to true, turns off analysis progress reporting by lint.
        quiet = true
        // If set to true (default), stops the build if errors are found.
        abortOnError = false
        // If set to true, lint only reports errors.
        ignoreWarnings = true
        // If set to true, lint also checks all dependencies as part of its analysis.
        // Recommended for projects consisting of an app with library dependencies.
        checkDependencies = true
    }
}
...

Dynamiczny

android {
    ...
    lint {
        // Turns off checks for the issue IDs you specify.
        disable 'TypographyFractions','TypographyQuotes'
        // Turns on checks for the issue IDs you specify. These checks are in
        // addition to the default lint checks.
        enable 'RtlHardcoded','RtlCompat', 'RtlEnabled'
        // To enable checks for only a subset of issue IDs and ignore all others,
        // list the issue IDs with the 'check' property instead. This property overrides
        // any issue IDs you enable or disable using the properties above.
        checkOnly 'NewApi', 'InlinedApi'
        // If set to true, turns off analysis progress reporting by lint.
        quiet true
        // If set to true (default), stops the build if errors are found.
        abortOnError false
        // If set to true, lint only reports errors.
        ignoreWarnings true
        // If set to true, lint also checks all dependencies as part of its analysis.
        // Recommended for projects consisting of an app with library dependencies.
        checkDependencies true
    }
}
...

Wszystkie metody analizy kodu, które zastępują dany poziom ważności problemu, uwzględniają kolejność konfiguracji. Na przykład ustawienie problemu jako krytycznego w finalizeDsl() zastępuje wyłączenie go w głównym DSL.

Tworzenie punktu odniesienia dla ostrzeżeń

Możesz utworzyć zrzut bieżącego zestawu ostrzeżeń projektu, a następnie użyć go jako punktu odniesienia dla przyszłych uruchomień kontroli, aby zgłaszane były tylko nowe problemy. Zrzut bazowy pozwala zacząć używać linta do niepowodzenia kompilacji bez konieczności cofania się i rozwiązywania wszystkich istniejących problemów.

Aby utworzyć zrzut stanu bazowego, zmodyfikuj plik build.gradle projektu w ten sposób:

Kotlin

android {
    lint {
        baseline = file("lint-baseline.xml")
    }
}

Dynamiczny

android {
    lintOptions {
        baseline file("lint-baseline.xml")
    }
}

Gdy po raz pierwszy dodasz ten wiersz, zostanie utworzony plik lint-baseline.xml, który będzie stanowić punkt odniesienia. Od tego momentu narzędzia tylko odczytują plik, aby określić punkt odniesienia. Jeśli chcesz utworzyć nowy plan bazowy, ręcznie usuń plik i ponownie uruchom narzędzie lint, aby go odtworzyć.

Następnie uruchom narzędzie lint w IDE, wybierając Code > Inspect Code (Kod > Sprawdź kod), lub w wierszu poleceń w ten sposób: W wyniku wyświetli się lokalizacja pliku lint-baseline.xml. Lokalizacja pliku w Twojej konfiguracji może się różnić od tej, która jest pokazana tutaj:

$ ./gradlew lintDebug -Dlint.baselines.continue=true
...
Wrote XML report to file:///app/lint-baseline.xml
Created baseline file /app/lint-baseline.xml

Uruchomienie polecenia lint powoduje zapisanie wszystkich bieżących problemów w pliku lint-baseline.xml. Zestaw bieżących problemów jest nazywany punktem odniesienia. Jeśli chcesz udostępnić plik lint-baseline.xml innym osobom, możesz go dodać do systemu kontroli wersji.

Dostosowywanie punktu odniesienia

Jeśli chcesz dodać do bazy tylko określone typy problemów, wskaż je, edytując plik build.gradle projektu w ten sposób:

Kotlin

android {
    lint {
        checkOnly += "NewApi" + "HandlerLeak"
        baseline = file("lint-baseline.xml")
    }
}

Dynamiczny

android {
    lintOptions {
        checkOnly 'NewApi', 'HandlerLeak'
        baseline file("lint-baseline.xml")
    }
}

Jeśli po utworzeniu punktu odniesienia dodasz do bazy kodu nowe ostrzeżenia, narzędzie lint wyświetli tylko nowo wprowadzone błędy.

Ostrzeżenie dotyczące punktu odniesienia

Gdy obowiązuje punkt odniesienia, otrzymasz ostrzeżenie informujące, że co najmniej 1 problem został odfiltrowany, ponieważ znajduje się w punkcie odniesienia. To ostrzeżenie przypomina, że masz skonfigurowany punkt odniesienia i musisz w pewnym momencie rozwiązać wszystkie problemy.

To ostrzeżenie informacyjne śledzi też problemy, które nie są już zgłaszane. Dzięki tym informacjom dowiesz się, czy problemy zostały faktycznie rozwiązane, i będziesz mieć możliwość ponownego utworzenia punktu odniesienia, aby zapobiec ponownemu wystąpieniu błędu bez wykrycia.

Uwaga: punkty bazowe są włączone, gdy przeprowadzasz inspekcje w trybie wsadowym w IDE, ale są ignorowane w przypadku kontroli w edytorze, które są przeprowadzane w tle podczas edytowania pliku. Wynika to z tego, że bazy są przeznaczone do sytuacji, gdy baza kodu zawiera dużą liczbę istniejących ostrzeżeń, ale chcesz rozwiązać problemy lokalnie podczas pracy nad kodem.

Ręczne przeprowadzanie kontroli

Aby ręcznie uruchomić skonfigurowane kontrole linta i inne kontrole IDE, wybierz Code > Inspect Code (Kod > Sprawdź kod). Wyniki kontroli pojawią się w oknie Wyniki kontroli.

Ustawianie zakresu i profilu kontroli

Wybierz pliki, które chcesz przeanalizować (zakres inspekcji), oraz inspekcje, które chcesz przeprowadzić (profil inspekcji):

  1. W widoku Android otwórz projekt i wybierz projekt, folder lub plik, który chcesz przeanalizować.
  2. Na pasku menu kliknij Code > Inspect Code (Kod > Sprawdź kod).
  3. W oknie dialogowym Specify Inspection Scope (Określ zakres kontroli) sprawdź ustawienia.

    Sprawdzanie ustawień zakresu kontroli
    Rysunek 3. Sprawdź ustawienia zakresu kontroli.

    Opcje, które pojawiają się w oknie Określ zakres kontroli, różnią się w zależności od tego, czy wybrano projekt, folder czy plik:

    • Gdy wybierzesz jeden projekt, plik lub katalog, w oknie Określ zakres kontroli wyświetli się ścieżka do wybranego projektu, pliku lub katalogu.
    • Gdy wybierzesz więcej niż 1 projekt, plik lub katalog, w oknie Określ zakres kontroli pojawi się zaznaczony przycisk Wybrane pliki.

    Aby zmienić element do sprawdzenia, wybierz jeden z pozostałych przycisków opcji. Opis wszystkich możliwych pól w oknie Określ zakres kontroli znajdziesz w sekcji Okno Określ zakres kontroli.

  4. W sekcji Profil kontroli wybierz profil, którego chcesz użyć.
  5. Aby przeprowadzić inspekcję, kliknij OK.

    Rysunek 4 przedstawia wyniki analizy narzędzia lint i innych kontroli IDE po uruchomieniu Inspect Code (Sprawdź kod):

    Wybierz problem, aby zobaczyć, jak go rozwiązać.
    Rysunek 4. Wyniki sprawdzania. Wybierz problem, aby zobaczyć, jak go rozwiązać.
  6. W panelu Wyniki kontroli wyświetl wyniki kontroli, rozwijając i wybierając kategorie, typy lub problemy związane z błędami.

    W panelu Raport z kontroli wyświetlany jest raport z kontroli dotyczący kategorii, typu lub problemu wybranego w panelu Wyniki kontroli oraz nazwa i lokalizacja błędu. W stosownych przypadkach raport ze sprawdzania zawiera inne informacje, np. podsumowanie problemu, które pomogą Ci go rozwiązać.

  7. W widoku drzewa w panelu Wyniki kontroli kliknij prawym przyciskiem myszy kategorię, typ lub problem, aby wyświetlić menu kontekstowe.

    W zależności od kontekstu możesz:

    • Przejdź do źródła.
    • Wyklucz i uwzględnij wybrane elementy.
    • Ukryj problemy.
    • Zmień ustawienia.
    • Zarządzanie alertami dotyczącymi kontroli.
    • ponownie przeprowadzić sprawdzanie,

Opisy przycisków paska narzędzi, elementów menu kontekstowego i pól raportu z kontroli znajdziesz w artykule Okno narzędzia Wyniki kontroli.

Używanie zakresu niestandardowego

Użyj jednego z niestandardowych zakresów dostępnych w Android Studio w ten sposób:

  1. W oknie Specify Inspection Scope (Określ zakres kontroli) wybierz Custom scope (Zakres niestandardowy).
  2. Kliknij listę Zakres niestandardowy, aby wyświetlić opcje:

    Wybierz zakres kontroli, którego chcesz użyć
    Rysunek 5. Wybierz zakres niestandardowy, którego chcesz użyć.
    • Wszystkie miejsca: wszystkie pliki.
    • Pliki projektu: wszystkie pliki w bieżącym projekcie.
    • Pliki źródłowe projektu: tylko pliki źródłowe w bieżącym projekcie.
    • Pliki produkcyjne projektu: tylko pliki produkcyjne w bieżącym projekcie.
    • Pliki testowe projektu: tylko pliki testowe w bieżącym projekcie.
    • Scratches and Consoles (Pliki tymczasowe i konsole): tylko pliki tymczasowe i konsole otwarte w bieżącym projekcie.
    • Ostatnio wyświetlane pliki: tylko ostatnio wyświetlane pliki w bieżącym projekcie.
    • Bieżący plik: tylko bieżący plik w bieżącym projekcie. Pojawia się, gdy wybierzesz plik lub folder.
    • Wybrany katalog: tylko bieżący folder w bieżącym projekcie. Pojawia się, gdy masz wybrany folder.
    • Hierarchia klas: gdy wybierzesz tę opcję i klikniesz OK, pojawi się okno ze wszystkimi klasami w bieżącym projekcie. W oknie użyj pola Wyszukaj według nazwy, aby przefiltrować i wybrać klasy do sprawdzenia. Jeśli nie przefiltrujesz listy klas, kontrola kodu sprawdzi wszystkie klasy.
  3. Jeśli masz skonfigurowany system kontroli wersji dla projektu, możesz też ograniczyć wyszukiwanie tylko do zmodyfikowanych plików.

  4. Kliknij OK.

Tworzenie zakresu niestandardowego

Jeśli chcesz sprawdzić wybór plików i katalogów, który nie jest objęty żadnym z dostępnych zakresów niestandardowych, możesz utworzyć zakres niestandardowy:

  1. W oknie Specify Inspection Scope (Określ zakres kontroli) wybierz Custom scope (Zakres niestandardowy).
  2. Kliknij 3 kropki obok listy Zakres niestandardowy.

    Okno Określ zakres kontroli
    Rysunek 6. Specify Inspection Scope (Określ zakres kontroli).

    Pojawi się okno Zakresy.

    Tworzenie zakresu niestandardowego
    Rysunek 7. Utwórz zakres niestandardowy.
  3. Kliknij przycisk w lewym górnym rogu okna, aby zdefiniować nowy zakres.
  4. Na wyświetlonej liście Dodaj zakres wybierz Lokalny.

    W projekcie używane są zarówno zakresy lokalne, jak i udostępnione, na potrzeby funkcji Inspect Code (Sprawdź kod). Zakresu Udostępniony można też używać z innymi funkcjami projektu, które mają pole zakresu. Na przykład gdy klikniesz Edytuj ustawienia , aby zmienić ustawienia opcji Znajdź użycia, w wyświetlonym oknie dialogowym pojawi się pole Zakres, w którym możesz wybrać zakres udostępniony.

    Wybieranie zakresu udostępniania w oknie Znajdź użycia
    Rysunek 8. Wybierz zakres udostępniony w oknie Znajdź zastosowania.
  5. Nadaj zakresowi nazwę i kliknij OK.

    W panelu po prawej stronie okna Zakresy pojawią się opcje, które umożliwiają zdefiniowanie zakresu niestandardowego.

  6. Z listy wybierz Projekt.

    Pojawi się lista dostępnych projektów.

    Uwaga: zakres niestandardowy możesz utworzyć dla projektów lub pakietów. Czynności są takie same.

  7. Rozwiń foldery projektu, wybierz, co chcesz dodać do zakresu niestandardowego, i określ, czy chcesz to uwzględnić czy wykluczyć.

    Definiowanie zakresu niestandardowego
    Rysunek 9. Zdefiniuj zakres niestandardowy.
    • Uwzględnij: uwzględnij ten folder i jego pliki, ale nie uwzględniaj żadnych podfolderów.
    • Uwzględnij rekurencyjnie: uwzględnij ten folder i jego pliki, a także jego podfoldery i ich pliki.
    • Wyklucz: wyklucz ten folder i jego pliki, ale nie wykluczaj żadnych podfolderów.
    • Wyklucz rekurencyjnie: wyklucz ten folder i jego pliki, a także podfoldery i ich pliki.

    Rysunek 10 pokazuje, że folder main jest uwzględniony, a foldery java i res są uwzględnione rekurencyjnie. Niebieski oznacza folder częściowo uwzględniony, a zielony – foldery i pliki uwzględnione rekurencyjnie.

    Przykładowy wzorzec zakresu niestandardowego
    Rysunek 10. Przykładowy wzorzec zakresu niestandardowego.
    • Jeśli wybierzesz folder java i klikniesz Wyklucz rekurencyjnie, zielone podświetlenie zniknie z folderu java oraz wszystkich znajdujących się w nim folderów i plików.
    • Jeśli wybierzesz podświetlony na zielono plik MainActivity.kt i klikniesz Exclude (Wyklucz), plik MainActivity.kt nie będzie już podświetlony na zielono, ale wszystkie inne elementy w folderze java pozostaną zielone.
  8. Kliknij OK. Zakres niestandardowy pojawi się u dołu listy.

Sprawdzanie i edytowanie profili kontroli

Android Studio zawiera wybór profili analizy statycznej i innych profili kontroli, które są aktualizowane w ramach aktualizacji Androida. Możesz używać tych profili w ich obecnej postaci lub edytować ich nazwy, opisy, poziomy ważności i zakresy. Możesz też aktywować i dezaktywować całe grupy profili lub poszczególne profile w grupie.

Aby uzyskać dostęp do ustawień Inspekcje:

  1. Wybierz Plik > Ustawienia. (w systemie Windows) lub Android Studio > Preferences (w systemie macOS lub Linux).
  2. Wybierz Editor > Inspections (Edytor > Inspekcje).
  3. Panel Inspekcje zawiera listę obsługiwanych inspekcji i ich opisy.

    Obsługiwane kontrole i ich opisy
    Rysunek 11. Obsługiwane kontrole i ich opisy.
  4. Wybierz listę Profil, aby przełączać się między inspekcjami Domyślne (Android Studio) i Domyślne dla projektu (aktywny projekt).

    Więcej informacji znajdziesz na stronie IntelliJ Zarządzanie profilami.

  5. Na liście Inspekcje w lewym panelu wybierz kategorię profilu najwyższego poziomu lub rozwiń grupę i wybierz konkretny profil.

    Gdy wybierzesz kategorię profilu, możesz edytować wszystkie kontrole w tej kategorii jako jedną kontrolę.

  6. Wybierz listę Pokaż działania schematu Ikona wyświetlania działań schematu, aby kopiować, zmieniać nazwy, dodawać opisy, eksportować i importować kontrole.
  7. Gdy skończysz, kliknij OK.