Baza wiedzyCentrum egzaminacyjne
PLPolski
Wybierz język13

CKTIS / Java

Throwable.getMessage(): odczytywanie komunikatu wyjątku

Odczytaj komunikat konkretnego wyjątku, obsłuż brak tekstu i odróżnij wyjątek główny od jego przyczyn oraz wyjątków stłumionych.

Wersja: Java SE 21

Składnia

public String getMessage()

Throwable.getMessage() to metoda instancji bez parametrów. Wywołanie e.getMessage() zwraca szczegółowy komunikat obiektu e jako String albo null. null nie oznacza pustego napisu "". Sprawdź wynik przed użyciem go jako napisu. Wywołanie na referencji e, która ma wartość null, samo zgłosi NullPointerException.

new NullPointerException("name").getMessage() zwraca "name". Bez jawnego komunikatu innego niż null wynik może zależeć od implementacji albo wynosić null; Java SE 21 nie gwarantuje konkretnego brzmienia ani tego, że pojawi się nazwa zmiennej. Przechwycony IllegalArgumentException dziedziczy getMessage() i może w ten sposób zwrócić tekst przekazany konstruktorowi.

getCause() zwraca obiekt przyczyny lub null, gdy przyczyny nie ma albo jest nieznana. W zwykłym łańcuchu bez cykli przechodź do kolejnych przyczyn aż do null, wywołując getMessage() na każdej z nich. Konstruktor IllegalArgumentException(String, Throwable) nie dopisuje komunikatu przyczyny do podanego tekstu. Wariant IllegalArgumentException(Throwable) ustala komunikat na podstawie cause.toString(), a dla przyczyny null ustala go na null.

Gdy zarówno blok try w instrukcji try-with-resources, jak i close() zgłoszą różne wyjątki, wyjątek z bloku pozostaje główny. Przy włączonym tłumieniu wyjątek zamykania trafia do tablicy zwracanej przez getSuppressed(), a nie do łańcucha przyczyn. Odczytaj komunikat każdego elementu osobno; jeśli nic nie stłumiono lub tłumienie jest wyłączone, tablica jest pusta.

getMessage() nie zwraca śladu stosu ani nie dołącza automatycznie nazwy klasy. Domyślne getLocalizedMessage() zwraca to samo co getMessage(), ale podklasa może je nadpisać. Tekst traktuj jako informację diagnostyczną, nie jako kod błędu: nie opieraj na nim logiki programu i nie pokazuj użytkownikom nieprzejrzanych komunikatów wewnętrznych.

Przykłady

public class Main {
    static final class Resource implements AutoCloseable {
        @Override
        public void close() {
            throw new IllegalStateException("close fail");
        }
    }

    public static void main(String[] args) {
        try (Resource resource = new Resource()) {
            throw new IllegalArgumentException("primary", new NullPointerException("name"));
        } catch (IllegalArgumentException e) {
            System.out.println("Caught: " + e.getMessage());
            for (Throwable cause = e.getCause(); cause != null; cause = cause.getCause()) {
                System.out.println("Cause: " + cause.getMessage());
            }
            for (Throwable suppressed : e.getSuppressed()) {
                System.out.println("Suppressed: " + suppressed.getMessage());
            }
        }

        String message = new IllegalArgumentException().getMessage();
        System.out.println("No message: " + (message == null ? "(absent)" : message));
    }
}

Wynik

Caught: primary
Cause: name
Suppressed: close fail
No message: (absent)

Wynik rozdziela komunikat przechwyconego `IllegalArgumentException` (`primary`), komunikat przyczyny (`name`) i komunikat stłumionego wyjątku z `close()` (`close fail`). W ostatnim wierszu program zastępuje `null` tekstem `(absent)`.

Powiązane lekcje

  • Java · Lekcja 28 · Średniozaawansowany · Wersja: 2
  • Java · Lekcja 29 · Średniozaawansowany · Wersja: 2
  • Java · Lekcja 30 · Średniozaawansowany · Wersja: 2
  • Java · Lekcja 31 · Średniozaawansowany · Wersja: 2

Źródła