Vollständigkeit der switch-Anweisungen sicherstellen

Es wird empfohlen sicherzustellen, dass alle switch-Anweisungen vollständig sind, d. h. dass jede Ausführung zur Laufzeit eine passende Verzweigung finden kann. Dies ist eine nicht triviale Task, wenn die folgenden Faktoren berücksichtigt werden:

Zusätzlich hierzu schreibt JLS eine Ablaufanalyse für enum-switch-Anweisungen vor, die zu nicht erwarteten Fehlern während des Kompilierens führen kann:

    enum Colors { RED, GREEN, BLUE }
    String colorString(Color c) {
        switch(c) {
            case RED: return "red";
            case GREEN: return "green";
            case BLUE: return "blue";
        }
    }

Der Compiler gibt Folgendes zurück:

"Diese Methode muss ein Ergebnis des Typs String zurückgeben. Beachten Sie, dass ein Problem in Bezug auf ein fehlendes Element 'default:' für 'switch' unterdrückt wurde, was möglicherweise in Zusammenhang mit diesem Problem steht.

Diese Nachricht dient zur Benachrichtigung der Benutzer über die unterschiedlichen Auffassungen über die Vollständigkeit. Die Ablaufanalyse, die von JLS gesteuert wird, interpretiert jede enum-switch-Anweisung ohne eine case-Standardanweisung als unvollständig. Dies gilt auch dann, wenn sie alle (momentan bekannten) Aufzählungskonstanten auflistet. Dies betrifft Rückkehranweisungen ebenso wie definitive Zuordnungen lokaler Variablen oder leerer finaler Felder. Wenn Sie jedoch alle im Folgenden aufgeführten Empfehlungen berücksichtigen, dann wird die obige Fehlernachricht niemals ausgegeben.

Prüfen Sie die Benutzervorgaben für den Compiler in Bezug auf einzelne Konfigurationsoptionen für die Berichterstellung zu den verschiedenen Ebenen der Unvollständigkeit. Im Folgenden werden die unterschiedlichen Designziele und -richtlinien erläutert und es wird erklärt, wie diese Ziele und Richtlinien mithilfe des Eclipse-Java-Compilers überprüft werden können.

Hinweise zur Verwendung von "default:"

Idealerweise sollte jede switch-Anweisung über eine aussagekräftige Standardverzweigung verfügen, die alle Fälle behandelt, die mit der Strategie "always-reasonable" nicht explizit aufgelistet werden. In vielen Fällen scheint eine solche Strategie jedoch schwierig oder gar unmöglich zu finden zu sein, wenn Sie jedoch eine sinnvolle Standardimplementierung finden können, dann stellt dies die beste Lösung dar.

Empfehlung: Wenn Sie vom Compiler über jede switch-Anweisung gewarnt werden, die keine case-Standardanweisung aufweist, dann werden Sie daran erinnert, dass nach einer guten Standardimplementierung für jede switch-Anweisung gesucht werden muss.

Wenn der Compiler Sie über eine fehlende case-Standardanweisung warnt, es jedoch in der momentanen Situation am sinnvollsten ist, nichts zu tun, dann sollten Sie auch diese Vorgehensweise dokumentieren.

Empfehlung: Wenn das Unterlassen einer Aktion eine sinnvolle Standardstrategie darstellt, sollten Sie eine Bezeichnung default: hinzufügen, deren Aktion lediglich ein Kommentar ist, in dem erläutert wird, dass das Unterlassen einer Maßnahme in diesem Switch OK ist (und warum). Auf diese Weise teilen Sie dem Compiler mit, dass Sie nicht einfach vergessen haben, eine case-Standardanweisung anzugeben.

Wenn keine sinnvolle Standardimplementierung gefunden werden kann, können Sie als letzte Möglichkeit versuchen, zu vermeiden, dass ein nicht erwarteter Wert die Ursache für weitere Fehler wird, wenn die Verarbeitung weiter fortgeschritten ist. Dies bedeutet, dass ein frühzeitiges Fehlschlagen der Verarbeitung während der Laufzeit vorzuziehen ist.

Empfehlung: Wenn weder eine sinnvolle Standardimplementierung gefunden noch das Unterlassen einer Maßnahme eine gute Strategie zu sein scheint, dann fügen Sie eine case-Standardanweisung (default:) hinzu, die zur Auslösung einer Ausnahmebedingung führt und/oder den Fehler protokolliert.

Jede switch-Anweisung sollte einer der drei obigen Kategorien zugeordnet werden können. Dies bedeutet, dass es eine universell gültige Strategie darstellt, wenn Sie den Compiler anweisen, Sie über jede fehlende case-Standardanweisung zu warnen.

Alle Aufzählungskonstanten verarbeiten

Wenn Sie eine switch-Anweisung für einen Aufzählungswert ausführen, dann kann es wünschenswert sein, jede Aufzählungskonstante explizit mit einer entsprechenden case-Anweisung abzudecken.

Empfehlung: Wenn Sie eine Warnung zu enum-switch-Anweisungen erhalten möchten, die nicht über eine case-Anweisung für eine der Aufzählungskonstanten verfügen, dann sollten Sie prüfen, ob eventuell das Aktivieren der Option Signal auch wenn case-Standardanweisung vorhanden ist sinnvoll ist.

Wenn Sie die Option, die bewirkt, dass alle enum-switch-Anweisungen alle Aufzählungskonstanten aufführen sollen, nicht wünschenswert finden, jedoch trotzdem eine Warnung zu fehlenden case-Bezeichnungen für einige enum-switch-Anweisungen erhalten wollen, dann müssen Sie die Strategie für jede einzelne enum-switch-Anweisung auswählen.

Empfehlung: Wenn die obige Warnung für einige switch-Anweisungen erwünscht ist, dann sollten Sie prüfen, ob die globale Aktivierung der Warnung sinnvoll ist, und die switch-Anweisungen identifizieren, bei denen es OK ist, case-Komponenten für bestimmte Aufzählungskonstanten zu übergehen, weil diese von der case-Standardanweisung in zufriedenstellender Weise verarbeitet werden. Für diese switch-Anweisungen verwenden Sie den Tagkommentar '//$CASES-OMITTED$', um Ihre Entscheidung zu dokumentieren:
    String colorString2(Color c) {
        switch(c) {
        case RED: return "red";
        case GREEN: return "green";
            //$CASES-OMITTED$
        default:
        	return "unknown color";
        }
    }

Hinweis: Wenn der Compiler eine Meldung wie z. B. "Die Aufzählungskonstante BLUE sollte eine entsprechende case-Bezeichnung in dieser enum-switch-Anweisung auf Color haben" ausgegeben wird, wird eine Schnellkorrektur zum Einfügen eines Tagkommentars angeboten.

Zusammenfassung

Die obigen Hinweise haben gezeigt, dass der Compiler am nützlichsten ist, wenn Sie alle optionalen Warnungen aktivieren, die sich auf unvollständige switch-Anweisungen beziehen, und leere dokumentierte case-Standardanweisungen plus Tagkommentare vom Typ //$CASES-OMITTED$ verwenden, um die switch-Anweisungen zu markieren, bei denen die Unvollständigkeit OK ist. Wenn Sie diese Empfehlungen befolgen, dann erhalten Sie alle relevanten Warnungen (oder auch Fehler), wenn Verzweigungen unabsichtlich übergangen werden. Dies schließt auch die Situation ein, bei der eine oder mehrere Aufzählungskonstanten zu einem späten Zeitpunkt hinzugefügt werden. Alle Ausnahmen zu dieser maximalen Vollständigkeit werden im Code dokumentiert und nicht mehr mit einer Warnung markiert.

Dennoch kann der Compiler die Verwendung inkonsistenter Klassenversionen während der Laufzeit nicht verhindern, sodass eine Klasse möglicherweise auf der Basis einer alten Version eines Aufzählungstyps kompiliert wird. In der aktiven Anwendung kann der Aufzählungstyp jedoch mehr Aufzählungskonstanten haben. In dieser und in ähnlichen Situationen kann es durch geeignete "catch-all"-Standardimplementierungen zu Laufzeitausnahmebedingungen kommen, die Sie über diese Inkonsistenz informieren und verhindern, dass der Fehler innerhalb der Anweisung weiter verbreitet wird.

Ein weiterer Vorteil der oben empfohlenen strikten Compilereinstellungen besteht darin, dass die Fehlernachricht zu der fehlenden Rückkehranweisung, die oben angezeigt wurde (oder ähnliche Nachrichten zu nicht initialisierten Variablen), nicht mehr angezeigt wird.