Co to jest i jak czytać StackTrace?

Wiesz już, czym są wyjątki w Java, wiesz też jak je rzucać… ale czy wiesz jak je interpretować? W szczególności jak czytać StackTrace, który zawsze towarzyszy wyjątkowi?

Wśród programistów krąży powiedzenie, że kod jest czytany więcej razy niż pisany (dlatego musi być napisany w prosty i zrozumiały sposób). Podobnie jest z wyjątkami, częściej będziesz je czytał niż, rzucał w swojej aplikacji. Dlatego też warto nauczyć się je czytać zawczasu i nie domyślać się “co tak naprawdę to znaczy”.

Zanim zapoznasz się z samym StackTrace’em warto, żebyś wiedział, że stuktura danych, na której on bazuje, zwana jest stosem (ang. stack). Opisałem ją dokładnie w tym wpisie.

Można powiedzieć, że StackTrace to “ścieżka”, którą podążało wykonanie programu do momentu powstania błędu. Więc w StackTrace znajduje się lista wszystkich metod, które są „aktualnie” wykonywane i w takiej kolejności doprowadziły do wyjątku.

Mówiąc jeszcze inaczej, patrząc na StackTrace, będziesz widział listę metod wywołanych na poszczególnych poziomach aplikacji. Wywołania te doprowadziły do wystąpienia tego wyjątku. Co ważne, nie zobaczysz tutaj wartości zmiennych, oraz wartości atrybutów (pól) klasy.

Samo pojęcie StackTrace związane jest ze stosem wykonania, jednak w Java potocznie rozumie się przez to sam stos wykonania wraz z wyjątkiem (lub wyjątkami), w jaki jest on “opakowany”.

Javowy StackTrace, zaczyna się od nazwy wyjątku, który go spowodował. W tej samej linii znajduje się też dodatkowa informacja dołączona przez programistę. “Zazwyczaj”, gdyż sporo osób nie dołącza do wyjątku żadnej “wiadomości”. Przyśpiesza to i ułatwia programowanie, bo nie trzeba się zastanawiać co tam napisać. Jednak jest to jedyny sposób, w jaki możemy sobie sami pomóc, kiedy to przyjdzie nam analizować ten wyjątek. W tej wiadomości możemy dodać informacje o wartości lokalnych zmiennych, które wpłynęły na wystąpienie właśnie tego wyjątku. Dlatego zawsze dodawaj “wiadomość” do każdego wyjątku, jaki rzucasz.

Każda linia zaczynająca się od “at” podaje:

  • w pełni kwalifikowaną nazwę metody (czyli nazwę pakietu, klasy oraz metody),
  • nazwę pliku źródłowego (w nawiasach okrągłych) oraz,
  • po dwukropku, numer linii.

Taki zapis pozwala jednoznacznie określić miejsce w aplikacji (lub bibliotece zewnętrznej), które było aktualnie wykonywane.

Na samym dole znajduje się tzw. metoda wejściowa, w prostych aplikacjach konsolowych, będzie to zawsze metoda main(String []). Natomiast na samym końcu znajduje się metoda, w której to wystąpił wyjątek.

Zazwyczaj nazwa pakietu Twojej aplikacji będzie znajdowała się na samej górze… gdyż zazwyczaj błędy popełniamy my, a nie autorzy bibliotek, których używamy. Czasami jednak nasza nazwa pakietu znajduje się gdzieś w “środku” StackTrace, wtedy zazwyczaj oznacza to, że przekazaliśmy złe parametry do wywołania metody z danej biblioteki. Baaaardzo rzadko oznacza to błąd w bibliotece.

Przyjrzyjmy się przykładowemu wyjątkowi:

Widzimy tutaj NullPointerException w 16 linii klasy Book z pakietu pl.kursprogramisty w metodzie getTitle(). Metoda ta została wywołana przez Author.getBookTitles(), która znajduje się w pliku Author.java w linii 25. Z kolei metoda getBookTitles() wołana jest z Bootstrap.main(), z pliku Bootstrap.java w linii 14.

Jak to bywa zazwyczaj z wyjątkami typu NullPoinerException, pewnie jedno z pól (właściwości) klasy Book bądź nie zostało zainicjalizowane, bądź zostało zainicjalizowane wartością null (czyli, tak jak by w ogóle nie zostało zainicjalizowane). Takie zachowanie skutkuje właśnie takim wyjątkiem w momencie próby wykonania jakiejkolwiek metody, na której zmiennej wartość jest null.

Często widzi się w kodzie, że w bloku catch, złapany wyjątek opakowywany jest w inny typ, który jest następnie rzucany. Poniżej znajduje się przykład takiego kodu:

W takim przypadku należy rozumieć, że wyjątek MyProjectServletException został spowodowany przez (ang. caused by) ConstraintViolationException. Wtedy w StackTrace zobaczymy linię zaczynającą się od “Caused by: ConstraintViolationException”. Co może skutkować takim przykładowym StackTrace:

Przełóżmy to na trochę prostszy przykład. Załóżmy, że piszesz prosty kalkulator:

W powyższym przykładzie CalculationException spowodowany został przez AdditionException, gdyż próbujemy dodać dwie liczby, z których jedna jest spoza karesu przyjętego przez nas za obsługiwany.

To tyle, jeżeli chodzi o czytanie wyjątków ze zrozumieniem. Jeżeli coś jest jeszcze nie jasne, zapraszam do komentarzy.

Co to jest Stos (ang. stack)?

Mentos

Źródło: https://www.flickr.com/photos/hellokitae/4291992600

Jedną z podstawowych struktura danych w informatyce jest stos (ang. stack). Chociaż nie jest on często stosowany w kodzie aplikacji (częściej spotkasz się z listami, setami oraz mapami) to bez niego nie funkcjonowałaby maszyna wirtualna Javy oraz komputery.

Dlaczego? Otóż stos wykorzystywany jest w celu “zlezienia drogi powrotnej” po wykonaniu metody, funkcji czy też instrukcji procesora. W momencie wywołania metody “A” adres aktualnego miejsca w programie jest odkładany na stos wywołania programu, następnie wykonywane są instrukcje z metody “B” (jeżeli w jej ciele odwołujemy się do kolejnej metody (“C”) to odkładamy na stos adres metody “B”, żeby wykonać metodę “C”). Kiedy metoda “B” zostanie wykonana, do końca JVM pobiera adres, do którego ma wrócić ze stosu wykonania… i wraca, zwracając wartość wyliczoną przez metodę “B”. Tak w sporym uproszczeniu można opisać, jak działa JVM.

Innym bardziej “namacalnym” zastosowaniem stosu jest tzw. StackTrace (tzn. stos wywołań) który możesz zobaczyć na ekranie w momencie wystąpienia wyjątku (ang. exception) w programie.

Jak sobie wyobrazić taki stos? Wyobraź sobie (lub po prostu kup) Mentos’a najlepiej “wieloowocowego”. Jest on tak zapakowany, że nie możesz dostać się do dowolnego cukierka. Żeby wsiąść np. czwarty, musisz najpierw wyciągnąć pierwsze trzy. Tak samo nie wiesz też jaki ten czwarty cukierek będzie. Jedyne co możesz zrobić to “zajrzeć”, jaki będzie następny, który będziesz mógł wyciągnąć.

Zostało jeszcze nam zastanowić się nad wkładaniem cukierków. Taka czynność jest bardzo utrudniona w rzeczywistości (raz wciągnięty cukierek ciężko jest włożyć ponownie). Jednak jeżeli użyjemy trochę wyobraźni, to zauważymy, że nie możemy włożyć cukierka na dowolną pozycję, zawsze musimy włożyć go na koniec (początek) “kolejki”.

Tak samo jest ze stosem w programowaniu. Przede wszystkim zachowuje on kolejność, w jakiej zostały do niego włożone elementy, ale pozwala je pobrać w kolejności odwróconej (pierwszy, który został włożony, zostanie pobrany jako ostatni). Czyli zawsze mamy szybki dostęp do elementu, który został włożony jako ostatni. Dodatkowo możemy podejrzeć, jaki będzie następny element możliwy do pobrania.

Przejdźmy teraz do tego, jak w Java używać stosów. JVM dostarcza nam implementację stosu pod postacią sparametryzowanej (lub generycznej) klasy java.util.Stack. Trzy najważniejsze metody pozwalające nam używać stosu to:

  • push(element) – pozwala nam włożyć element na “wierzchołek” stosu,
  • pop() – ta metoda wykonuje tak naprawdę dwie operacje. Po pierwsze “ściąga” (usuwa) ostatni element ze stosu oraz zwraca jego wartość (czyli tak jak by wyciągnąć cukierek z opakowania Mentosów),
  • peek() – pozwala nam podejrzeć ostatni element, jaki znajduje się w stosie. Wywołanie tej metody zwróci ten sam obiekt co pop(), z tym że nie usunie go ze stosu (czyli jest to takie zajrzenie do środka Mentosa, żeby sprawdzić jaki cukierek będzie następny).

Dodatkowo dostępne mamy jeszcze:

  • search(element) – pozwala znaleść dany element w stosie. Zwróci nam “numer” pozycji, na której znajduje się podany obiekt (element) lub wartość -1, gdy ten obiekt nie znajduje się w secie,
  • empty() – pozwala sprawdzić, czy stos jest pusty.

Przykład wykorzystania stosu:

Wynikiem wykonania tego kodu będzie:

W ten oto sposób używa się klasy java.util.Stack. Gdyby coś było jeszcze nie jasne, zapraszam do zadawania pytań w komentarzach.