Zapewnianie kompletności instrukcji switch

Dobrą praktyką jest zapewnienie kompletności każdej instrukcji switch w sensie zapewnienia odpowiedniej gałęzi dla każdego przypadku wykonania. Jest to zadanie nietrywialne, jeśli uwzględnić wszystkie z następujących wymagań:

W przypadku instrukcji switch na zmiennych typu enum specyfikacja języka Java dodatkowo wymusza analizę przepływu, która może prowadzić do nieoczekiwanych błędów podczas kompilacji:

    enum Colors { RED, GREEN, BLUE }
    String colorString(Color c) {
        switch(c) {
            case RED: return "czerwony";
            case GREEN: return "zielony";
            case BLUE: return "niebieski";
        }
    }

Kompilator zareaguje następującym komunikatem:

"Ta metoda musi zwrócić wynik typu String. Należy zwrócić uwagę, że problem dotyczący brakującego przypadku default: w instrukcji switch został zablokowany, co przypuszczalnie ma związek z tym problemem".

Celem tego komunikatu jest zwrócenie uwagi użytkownika na różne rozumienia pojęcia kompletności. Zgodnie z analizą przepływu wymaganą przez specyfikację języka Java każda instrukcja switch na zmiennej typu enum pozbawiona przypadku domyślnego (bloku default) jest niekompletna, nawet jeśli wymieniono wszystkie obecnie znane stałe wyliczenia. Dotyczy to instrukcji return oraz ostatecznego przypisywania wartości zmiennym lokalnym lub pustym polom zadeklarowanym jako final. Powyższego komunikatu o błędzie można uniknąć, przestrzegając wszystkich poniższych zaleceń.

Opis opcji konfiguracyjnych zgłaszania poszczególnych poziomów niekompletności zawiera dokumentacja preferencji kompilatora. W następnym artykule zostaną omówione różne cele i strategie projektowe oraz możliwości ich sprawdzania za pomocą kompilatora Java w środowisku Eclipse.

Używanie bloku "default:"

W idealnym przypadku każda instrukcja switch powinna mieć znaczącą gałąź domyślną, obsługującą w sensowny sposób wszystkie przypadki, które nie zostały jawnie wymienione. Oczywiście w wielu przypadkach znalezienie takiej strategii działania może być trudne, a nawet niemożliwe, ale jeśli da się znaleźć sensowną implementację domyślną, będzie to zawsze najlepsze rozwiązanie.

Zalecenie: warto pozwalać kompilatorowi na ostrzeganie o braku przypadku domyślnego w instrukcji switch, gdyż stanowi to przypomnienie o znalezieniu użytecznej implementacji domyślnej dla każdej takiej instrukcji.

Jeśli kompilator ostrzega o braku przypadku domyślnego, a sensownym działaniem domyślnym jest w danym przypadku nic nie robić, być może warto to udokumentować.

Zalecenie: jeśli „nie rób nic” jest sensowną strategią domyślną, należy dodać blok default: zawierający jedynie komentarz wyjaśniający, dlaczego w tej instrukcji jest to poprawne działanie domyślne. W ten sposób informujesz też kompilator o świadomym uwzględnieniu przypadku domyślnego.

Jeśli na pewno nie istnieje żadna sensowna implementacja domyślna, w ostateczności można zapobiec problemom w dalszej części programu poprzez wprowadzenie wczesnego niepowodzenia podczas wykonania.

Zalecenie: jeśli nie da się znaleźć sensownej implementacji domyślnej, a „nie rób nic” nie jest dopuszczalną strategią domyślną, dodaj przypadek default:, który zgłasza wyjątek i/lub rejestruje problem.

Każda instrukcja switch powinno dać się przypisać do jednej z trzech powyższych kategorii. Oznacza to, że pozwolenie kompilatorowi na ostrzeganie o wszystkich brakujących przypadkach domyślnych jest zawsze poprawną strategią.

Obsługiwanie wszystkich stałych enum

Wykonując instrukcję switch na zmiennej typu enum, może być wskazane jawne obsłużenie każdej stałej wyliczenia osobną instrukcją case.

Zalecenie: jeśli chcesz otrzymywać ostrzeżenia o braku instrukcji case dla jakiejkolwiek stałej wyliczenia w instrukcjach switch na zmiennych enum, włącz opcję Sygnalizuj nawet gdy przypadek „default” istnieje.

Jeśli nie chcesz wymuszać obsługiwania wszystkich stałych enum we wszystkich instrukcjach switch na zmiennych typu enum, ale jednak chcesz korzystać z ostrzeżeń o brakujących blokach case dla niektórych takich instrukcji switch, konieczne będzie wybranie odpowiedniej strategii dla każdej takiej instrukcji z osobna.

Zalecenie: jeśli powyższe ostrzeżenie jest pożądane dla niektórych instrukcji switch, rozważ możliwość globalnego włączenia tego ostrzeżenia, a następnie ręcznego wskazywania instrukcji switch, w których można bezpiecznie pominąć bloki case dla niektórych stałych, ponieważ są one prawidłowo obsługiwane przez przypadek domyślny. W takich instrukcjach switch należy udokumentować swoją decyzję komentarzem ze znacznikiem '//$CASES-OMITTED$':
    String colorString2(Color c) {
        switch(c) {
        case RED: return "czerwony";
        case GREEN: return "zielony";
            //$CASES-OMITTED$
        default:
        	return "nieznany kolor";
        }
    }

Wskazówka: jeśli kompilator zgłosi błąd w rodzaju „Stała wyliczeniowa BLUE powinna mieć własną etykietę case w tej instrukcji switch na zmiennej Color typu enum”, będzie dostępna szybka poprawka umożliwiająca wstawienie komentarza ze znacznikiem.

Podsumowanie

Jak widać z powyższych informacji, maksymalną pomoc ze strony kompilatora można uzyskać poprzez włączenie wszystkich ostrzeżeń opcjonalnych dotyczących niekompletnych instrukcji switch, a następnie używanie pustych przypadków domyślnych z odpowiednim komentarzem i ewentualnie komentarzy ze znacznikiem //$CASES-OMITTED$ w celu ręcznego wskazania instrukcji switch, które w używanym projekcie mogą bezpiecznie być niekompletne. Postępowanie zgodnie z podanymi zaleceniami pozwoli widzieć wszystkie ostrzeżenia (lub błędy, zależnie od ustawień) o omyłkowo pominiętych gałęziach, między innymi w przypadku późniejszego dodawania stałych enum. Wszystkie wyjątki od pełnej kompletności będą udokumentowane w kodzie i nie będą powodowały zgłaszania ostrzeżenia.

Mimo to kompilator nie może zapobiegać używaniu niespójnych wersji klas na etapie uruchomienia, więc możliwa jest sytuacja, w której klasa została kompilowana ze starą wersją typu enum, a w uruchomionej aplikacji ten sam typ ma więcej stałych enum. W takich przypadkach można użyć maksymalnie uogólnionej implementacji domyślnej, która zgłosi wyjątek czasu wykonania informujący o niespójności i zapobiegający przenoszeniu błędu do dalszej części aplikacji.

Dodatkową korzyścią z używania zalecanych ścisłych ostrzeżeń kompilatora jest wyeliminowanie mało czytelnego komunikatu o braku instrukcji return (pokazanego powyżej) i podobnych komunikatów o niezainicjowanych zmiennych.