Zajištění úplnosti příkazů switch

Je dobrým zvykem zajistit, aby byly všechny příkazy switch úplné tak, aby každé provedení za běhu našlo vhodnou větev. To je skutečně netriviální úloha, když si uvědomíme, co všechno je třeba zohlednit:

JLS navíc nařizuje u příkazů switch pro výčty analýzu toku, která může vést k neočekávaným chybám při kompilaci:

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

Kompilátor odpoví:

"Tato metoda musí vracet výsledek typu String. Všimněte si, že byl potlačen problém týkající se chybějícího prvku 'default:' v příkazu 'switch', což může souviset s tímto problémem."

Tato zpráva má upozornit uživatele na různá pojetí úplnosti: Analýza toku vyžadovaná JLS považuje za neúplný každý příkaz switch pro výčet bez výchozího případu, i když vypisuje všechny (aktuálně známé) výčtové konstanty. To se týká příkazů return i výslovného přiřazení lokálních proměnných nebo prázdných finálních polí. Pokud však splníte všechna níže uvedená doporučení, výše uvedená chybová zpráva se nikdy neobjeví.

Prostudujte si předvolby kompilátoru týkající se jednotlivých voleb konfigurace pro hlášení různých úrovní neúplnosti. V rámci pokračování pak probíráme různé cíle a zásady návrhu a způsob, jakým je možné je kontrolovat pomocí kompilátoru jazyka Java na platformě Eclipse.

O použití prvku "default:"

Optimálně by měl mít každý příkaz switch smysluplnou výchozí větev, která ošetří všechny případy, které nejsou explicitně uvedeny s použitím strategie "always-reasonable", tedy strategie vhodné pro všechny podmínky. Takovou strategie je evidentně v mnoha případech obtížné nebo dokonce nemožné najít, ale pokud dokážete najít smysluplnou výchozí implementaci, je to určitě to nejlepší řešení.

Doporučení: Když umožníte kompilátoru, aby vás varoval ohledně všech příkazů switch, kde chybí výchozí případ, bude vám připomínat, že máte hledat dobrou výchozí implementaci pro všechny příkazy switch.

Pokud vás kompilátor varuje, že chybí výchozí případ, ale standardně je vhodné prostě nedělat nic, může to stát za zdokumentování.

Doporučení: Pokud je přiměřenou výchozí strategií "nedělat nic", měli byste doplnit návěští default:, jehož akcí je pouze komentář vysvětlující že v tomto příkazu switch je nicnedělání OK (a proč tomu tak je). Tím zároveň sdělíte kompilátoru, že jste na výchozí případ nezapomněli.

Pokud rozumnou výchozí implementaci prostě nelze najít, můžete jako poslední možnost zabránit tomu, aby se stala neočekávaná hodnota kořenovou příčinou dalších chyb v pozdějším zpracování, tj. můžete raději za běhu vyvolat selhání na počátku.

Doporučení: Pokud není možné najít rozumnou výchozí implementaci a vhodnou strategií není ani "nicnedělání", přidejte případ default:, který generuje výjimku anebo protokoluje daný problém.

Každý příkaz switch by mělo být možné přiřadit do jedné ze tří výše uvedených kategorií. To znamená, že umožnit kompilátor varovat uživatele na každý chybějící výchozí případ je univerzálně platná strategie.

Ošetření všech výčtových konstant

Při provádění přepnutí nad hodnotou výčtového typu může být vhodné explicitně pokrýt každou výčtovou konstantu odpovídajícím příkazem case.

Doporučení: Chcete-li být upozorněni na příkazy switch pro výčty, kterým pro některou z výčtových konstant chybí příkaz case, zvažte možnost povolit volbu Signalizovat, i když existuje případ 'default'.

Pokud se vám nelíbí možnost, že by měly všechny příkazy switch pro výčty uvádět všechny výčtové konstanty, ale přesto chcete být upozorněni na chybějící štítky příkazu case u některých příkazů switch pro výčty, budete muset vybrat pro každý příkaz switch pro výčet individuální strategii.

Doporučení: Pokud je výše uvedené varování vhodné pro některé příkazy switch, zvažte možnost varování globálně povolit a identifikovat ty příkazy switch, kde je v pořádku pro některé výčtové konstanty štítky case vynechat, protože jsou dostatečně ošetřeny výchozím případem. Pro tyto příkazy switch zdokumentujte své rozhodnutí pomocí značky '//$CASES-OMITTED$' komentáře:
    String colorString2(Color c) {
        switch(c) {
        case RED: return "red";
        case GREEN: return "green";
            //$CASES-OMITTED$
        default:
        	return "unknown color";
        }
    }

Pokyn: Pokud kompilátor hlásí zhruba toto: "The enum constant BLUE should have a corresponding case label in this enum switch on Color" (Výčtová konstanta BLUE by měla mít v tomto příkazu switch výčtu odpovídající štítek příkazu case pro Color), bude vám nabídnuta rychlá oprava, která vloží danou značku komentáře.

Souhrn

Výše uvedené aspekty ukazují, že vám kompilátor bude nejvíc pomáhat, když povolíte všechna volitelná varování ohledně neúplných příkazů switch a ty příkazy switch, kde je neúplnost v pořádku a byla zamýšlena, označíte pomocí prázdných zdokumentovaných výchozích případů a značek komentáře //$CASES-OMITTED$. Pokud splníte tato doporučení, obdržíte všechna relevantní varování (nebo chcete-li chyby), když jsou omylem vynechány větve, včetně situací, kdy je později přidána jedna či více výčtových konstant. Všechny výjimky z této maximální úplnosti budou v kódu zdokumentovány a již nebudou označeny varováním.

Kompilátor však nedokáže zabránit použití nekonzistentních verzí tříd za běhu, takže je možné třídu zkompilovat s použitím staré verze výčtového typu, ale ve spuštěné aplikaci může mít tento výčtový typ více výčtových konstant. U těchto a podobných situací může odpovídající výchozí "všezahrnující" implementace vyvolat výjimky za běhu, aby vás na tuto nekonzistentnost upozornila a zabránila šíření chyby dál do aplikace.

Jako přidaná hodnota se v případě výše uvedeného striktního nastavení kompilátoru již nebude vyskytovat pochybná chybová zpráva o chybějícím příkazu return uvedená výše (ani podobné zprávy o neinicializovaných proměnných).