Jako programista Androida, wszyscy używamy Android Studio do tworzenia naszych aplikacji. Istnieje wiele innych edytorów, które mogą być używane do rozwoju aplikacji na Androida, ale najlepszą częścią, która przyciąga mnie do korzystania z Android Studio jest wsparcie, które zapewnia deweloperom Androida. Wsparcie to może być w formie autosugestii lub może być w formie pokazywania błędów w naszym kodzie (we wszystkich plikach obecnych w naszym projekcie).
Więc, w tym blogu, zobaczymy jedną z najlepszych funkcji Android Studio, która pomaga nam poprawić nasz sposób pisania bezbłędnego kodu i tą funkcją jest Lint. Tematy, które zostaną omówione w tym blogu to:
- Co to jest Lint?
- Konfiguracja Lint
- Pomaganie Lint
- Używanie Baseline
- Ręcznie uruchamiane inspekcje
- Podsumowanie
Więc, zaczynajmy.
Co to jest Lint?
Lint jest narzędziem do skanowania kodu dostarczanym przez Android Studio w celu identyfikacji, sugerowania i poprawiania złego lub ryzykownego kodu obecnego w projekcie.
Lint jest jak pełnoprawny framework do analizy stosu
Wszyscy używamy Lint od kiedy zaczęliśmy używać Android Studio, ponieważ domyślnie Android Studio zapewnia wsparcie dla Lint w każdym naszym projekcie. Problemy wykryte w twoim kodzie przez Lint zostaną ci zgłoszone z pewnymi sugestiami i poziomem ostrzeżenia. Możesz użyć tych sugestii aby poprawić swój kod. Najlepszą częścią Linta jest to, że możesz go używać zgodnie z własnymi potrzebami. Jeśli chcesz zobaczyć konkretny typ błędu w swoim projekcie, Lint pokaże ci tylko ten typ błędu. Lint jest konfigurowalny w naturze. Domyślnie Android Studio uruchamia proces inspekcji za każdym razem, gdy budujesz swój projekt, ale oprócz tego, możesz sprawdzić swój kod za pomocą Lint ręcznie lub z linii poleceń.
Następujący obraz pokazuje działanie Lint:
Obraz dzięki uprzejmości: Android Developer website
Cały proces działania Lint można podsumować w trzech krokach:
- Tworzenie pliku lint.xml: Możesz dostosować kontrole Lint w pliku lint.xml. W tym pliku możesz napisać kontrole, które chcesz włączyć i zignorować kontrole, których nie chcesz włączyć. Na przykład, jeśli chcesz sprawdzić problem nieużywanej zmiennej i nie chcesz sprawdzać problemów z nazewnictwem, możesz to zrobić w pliku lint.xml. Oprócz tego, możesz również dostosować sprawdzanie Linta ręcznie. Zobaczymy, jak zrobić ręczne kontrole Lint w następnej części tego bloga.
- Plik źródłowy aplikacji: Następnym krokiem jest wybranie plików źródłowych, na których chcesz wykonać sprawdzanie Lint. Może to być twój plik .java lub plik .kt lub dowolny plik xml twojego projektu.
- Narzędzie Lint: Wreszcie, narzędzie lint bierze pliki źródłowe i lint.xml i sprawdza problemy strukturalne kodu i sugeruje pewne ulepszenia w kodzie, jeśli takie istnieją. Sugerowane jest użycie sugestii lint przed opublikowaniem naszej aplikacji.
Kiedy używać Lint?
Jeśli chcesz opublikować swoją aplikację w sklepie Play lub innym sklepie z aplikacjami, wtedy chciałbyś mieć aplikację wolną od błędów. W tym celu musisz wykonać tak wiele testów na swojej aplikacji ręcznie. Ale jeśli chcesz pozbyć się niektórych z ręcznego testowania, możesz użyć Lint w swoim projekcie. Możesz sprawdzić każdy plik swojego kodu, aby znaleźć jakiś błąd, a Lint zidentyfikuje błędy i zasugeruje kilka odpowiedzi. Te błędy lub ostrzeżenia mogą być z:
- Nieużywane zmienne
- Nieużywane wyjątki
- Importy, które nie są używane w projekcie, i wiele więcej
Tak więc, przed opublikowaniem swojej aplikacji, powinieneś użyć Lint, aby w pełni sprawdzić swój kod.
Możesz również skonfigurować sprawdzanie lint dla różnych poziomów twojego projektu:
- Globally (cały projekt)
- Moduł projektu
- Moduł produkcyjny
- Moduł testowy
- Otwarte pliki
- Klasa hierarchia
- Zakresy systemu kontroli wersji (VCS)
Konfiguracja Lint
Aby używać Lint lub po prostu uruchamiać inspekcje w swoim projekcie, możesz dodać inspekcję Lint w pliku lint.xml lub możesz ręcznie wybrać listę zagadnień, które mają być skonfigurowane przez Lint w twoim projekcie za pomocą Android Studio.
- Konfiguracja pliku lint: Aby określić ręczne sprawdzanie w swojej aplikacji, dodaj listę zagadnień do skonfigurowania w pliku lint.xml. Jeśli tworzysz nowy plik lint.xml, upewnij się, że umieścisz go w katalogu głównym swojego projektu Android.
Poniżej znajduje się przykład pliku lint.xml:
<?xml version="1.0" encoding="UTF-8"?><lint> <!-- Disable the given check in this project --> <issue severity="ignore" /> <!-- Ignore the ObsoleteLayoutParam issue in the specified files --> <issue> <ignore path="res/layout/activation.xml" /> <ignore path="res/layout-xlarge/activation.xml" /> </issue> <!-- Ignore the UselessLeaf issue in the specified file --> <issue> <ignore path="res/layout/main.xml" /> </issue> <!-- Change the severity of hardcoded strings to "error" --> <issue severity="error" /></lint>- Konfiguruj plik lint ręcznie: Domyślnie, lint sprawdza pewną liczbę błędów, ale nie wszystkie. Nie robi się tego, ponieważ jeśli uruchomisz wszystkie sprawdzenia, które lint może sprawdzić, wtedy wydajność Android Studio zostanie spowolniona. Tak więc, tylko ograniczona liczba sprawdzeń lint jest domyślnie używana w Android Studio. Ale możesz dodać więcej kontroli i usunąć kontrole z lint, wykonując poniższe kroki:
Go to Files > Settings > Editor > Inspections and then check the issue checks that you want to be performed by the lint
Helping Lint
Czasami zdarza się, że piszesz ryzykowny lub pełen błędów kod, ale lint nie pokazuje żadnego błędu lub ostrzeżenia dla twojego kodu. Na przykład, napisz poniższy kod w Android Studio:
fun updateUi() { // code goes here networkRequest()}fun networkRequest() { // code goes here }Powyższe linie kodu nie pokażą ci żadnego błędu, ale logicznie rzecz biorąc, powinny pokazać jakiś błąd, ponieważ podczas aktualizacji UI, żądanie sieciowe nie powinno być wywoływane. Tak więc, to co możesz tutaj zrobić, to pomóc lintowi.
Help Lint pomaga tobie
Tak, jeśli pomożesz lintowi, to lint pomoże również tobie. Tak więc, aby pomóc lintowi zrozumieć kod w bardziej precyzyjny sposób, zawsze staraj się używać adnotacji w swoim projekcie. Teraz napisz to samo, co napisałeś wcześniej, a następnie sprawdź błędy:
@UiThreadfun updateUi() { // code goes here networkRequest()}@WorkerThreadfun networkRequest() { // code goes here}Więc, pomóż Lintowi używając adnotacji w swoim kodzie.
Używanie linii bazowej
Jeśli pracujesz nad bardzo dużym projektem i jesteś zainteresowany znalezieniem przyszłych błędów, które mogą pojawić się podczas dodawania kolejnych kodów do projektu, możesz dodać linię bazową do swojego projektu i w ten sposób lint wygeneruje błędy, które wystąpiły po tej linii bazowej. Tak więc, lint zignoruje poprzednie problemy z kodem i ostrzeże cię tylko o nowych liniach kodu dodanych po linii bazowej.
Aby dodać linię bazową w twoim projekcie, dodaj poniższą linię w pliku build.gradle twojego projektu:
android { lintOptions { baseline file("lint-baseline.xml") }}To stworzy lint-baseline.xml, który ustanowi linię bazową twojego projektu. Aby dodać kolejną linię bazową, usuń plik i lint ponownie.
Inną rzeczą, którą możesz tutaj zrobić jest to, że możesz włączyć dowolny typ sprawdzania błędów tylko tutaj. Na przykład, aby włączyć sprawdzanie interoperacyjności Kotlina, napisz poniższy kod:
android { lintOptions { baseline file("lint-baseline.xml") }}enable "Interoperability"Ręcznie uruchamiaj inspekcje
Aby ręcznie sprawdzić plik w Android Studio, wykonaj poniższe kroki:
Krok 1: Przejdź do pliku, który chcesz sprawdzić.
Krok 2: Kliknij prawym przyciskiem myszy, a następnie przejdź do Analizuj > Inspekcja kodu. Poniższe okno zostanie otwarte:
Obraz dzięki uprzejmości: Android Developer website
W tym miejscu możesz wybrać zakres inspekcji, np. cały projekt, moduł lub po prostu plik. Po wybraniu zakresu kliknij na OK.
Otworzy się następujące okno:
Obraz dzięki uprzejmości: Android Developer website
Pojawi się lista kategorii błędów, typów i problemów. Możesz zobaczyć wynik inspekcji poprzez rozwinięcie błędu w lewym panelu widoku drzewa.
W drugim panelu tj. prawym panelu wyświetla raport z inspekcji dla wybranego błędu.
Wnioski
W tym blogu, dowiedzieliśmy się jak używać Lint w Android Studio. Zobaczyliśmy, że jeśli chcemy przeanalizować nasz kod to nie musimy tego robić ręcznie. Android Studio dostarcza narzędzie do sprawdzania kodu Lint, które pomaga nam oczyścić nasz kod i użyć niezbędnego i właściwego kodu do rozwoju aplikacji.
Więc, użyj Lint do usunięcia różnych typów błędów w twoim projekcie, a także pomóż Lint, aby pomóc tobie.
Keep Learning 🙂
Team MindOrks.
.