Kapcsolóutasítások teljességének biztosítása

Célszerű biztosítani, hogy minden egyes switch utasítás teljes legyen abban az értelemben, hogy minden egyes végrehajtás találjon megfelelő ágat a futás során. Ez valójában nem egy triviális feladat, amikor az alábbiak mindegyikét figyelembe veszi:

Továbbá a JLS kötelezővé teszi a folyamelemzést az enum switch utasításokhoz, ami váratlan hibákhoz vezethet a fordítás során:

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

A fordító válasza a következő lesz:

"A metódusnak String típusú eredményt kell visszaadnia. Vegye figyelembe, hogy a 'switch' utasításból hiányzó 'default:' elemmel kapcsolatos probléma el lett nyomva, aminek talán köze van ehhez a problémához".

Ezt az üzenetet ahhoz tervezték, hogy figyelmeztesse a felhasználókat a teljesség különböző fokaira: a JLS által előírt folyamelemzés befejezetlennek tekint minden egyes olyan felsorolás switch utasítást, amelynél nincs alapértelmezett eset, még akkor is, ha az tartalmazza a (jelenleg ismert) összes felsorolási konstanst. Ez a return utasításokra, valamint a helyi változók vagy üres záró mezők kifejezett hozzárendelését érinti. Ha azonban követi az összes fenti ajánlást, akkor a fenti hiba soha nem fog előfordulni.

A különféle befejezetlenségi szintek jelentéséhez kötődő egyedi konfigurációs beállításokkal kapcsolatos részleteket a fordító beállításai tartalmaznak. A másik részben tárgyaljuk a különféle tervezési célokat és irányelveket, valamint hogy hogyan lehet ellenőrizni őket az Eclipse Java fordítóban.

A "default:" használata

Optimális esetben minden egyes switch utasításnak van értelmes alapértelmezett ága, ami kezeli mindazokat az eseteket, amelyek nincsenek kifejezetten felsorolva. Nyilvánvaló, hogy az összes eset kifejezett felsorolása sok esetben nehézkes vagy egyenesen lehetetlen, de ha talál egy értelmes alapértelmezett megvalósítást, az a legjobb megoldás.

Ajánlás: Azzal, hogy a fordító jelez minden egyes olyan switch utasítást, amelynél nincs alapértelmezett eset, felhívja a felhasználó figyelmét arra, hogy minden switch utasításhoz keressen jó alapértelmezett megvalósítást.

Ha a fordító figyelmezteti, hogy hiányzik az alapértelmezett eset, és alapértelmezésben nem kell tenni semmit, ezt is érdemes dokumentálni.

Ajánlás: Ha a "nem kell tenni semmit" az alkalmazandó alapértelmezett stratégia, akkor vegyen fel egy default: címkét, melynek művelete mindössze egy megjegyzés, ami elmagyarázza, hogy a nem kell tenni semmit művelet helyénvaló (és miért) ebben a switch utasításban. Ezzel a fordító tudomására hozza, hogy nem egyszerűen csak elfelejtett megadni alapértelmezett esetet.

Ha biztosan nem található megfelelő alapértelmezett megvalósítás, akkor legvégső esetben érdemes lehet megakadályozni, hogy egy váratlan érték más hibák kiváltó oka legyen később, vagyis célszerű lehetidejében sikertelenséget jelenteni a futás során.

Ajánlás: Ha nem található megfelelő alapértelmezett megvalósítás és a "semmit sem kell tenni" sem jó stratégia, akkor olyan default: esetet vegyen fel, ami kivételt dob és/vagy naplózza a problémát.

Minden egyes switch utasításnak a fenti három kategória egyikébe kell tartoznia. Ez azt jelenti, hogy univerzálisan érvényes stratégia, ha engedélyezi, hogy a fordító figyelmeztesse, ha hiányzik az alapértelmezett eset.

Minden felsorolási konstans kezelése

Amikor switch utasítást hajt végre egy felsorolásértékre, akkor kívánatos lehet kifejezetten lefedni minden egyes felsorolási konstanst egy-egy vonatkozó case utasítással.

Ajánlás: Ha azt akarja, hogy a rendszer figyelmeztesse az olyan felsorolás switch utasításokra, amelyekből hiányzik a case utasítás valamely felsorolási konstanshoz, akkor engedélyezze az Akkor is jelez, ha létezik 'default' eset lehetőséget.

Ha nem tetszik az a beállítás, hogy minden felsorolás switch utasításnak említenie kell minden felsorolási konstanst, de bizonyos felsorolás switch utasításoknál figyelmeztetést szeretne a hiányzó esetcímkékről, akkor minden egyes felsorolás switch utasításnál válassza ki a megfelelő stratégiát.

Ajánlás: Ha a fenti figyelmeztetés kívánatos bizonyos switch utasításoknál, akkor fontolja meg azt a lehetőséget, hogy globálisan engedélyezi a figyelmeztetést, majd azonosítja azokat a switch utasításokat, ahol helyénvaló az esetek kihagyása bizonyos felsorolási konstansoknál, mert azok megfelelően kezelhetők az alapértelmezett esettel. Ezeknél a switch utasításoknál a '//$CASES-OMITTED$' címke megjegyzéssel dokumentálja döntését:
    String colorString2(Color c) {
        switch(c) {
        case RED: return "red";
        case GREEN: return "green";
            //$CASES-OMITTED$
        default:
        	return "unknown color";
        }
    }

Tipp: Ha a fordító valami olyasmit jelent, hogy "A BLUE felsorolási konstanshoz kellene, hogy tartozzon megfelelő esetcímke ebben a Szín felsorolás switch utasításban", akkor a felajánl egy gyorsjavítást a címke megjegyzés beillesztéséhez.

Összegzés

A fenti megfontolásokból kiderült, hogy akkor kaphatja a legtöbb segítséget a fordítótól, ha engedélyezi az összes nem kötelező figyelmeztetést a hiányos switch utasításokkal kapcsolatban, és üres dokumentált alapértelmezett esetekkel, valamint //$CASES-OMITTED$ címke megjegyzésekkel jelzi azokat a switch utasításokat, ahol a hiányosság terv szerint helyénvaló. Ha követi az ajánlásokat, akkor megkapja az összes releváns figyelmeztetést (vagy hibát, ha úgy tetszik), amikor véletlenül kifelejtett ágakat, beleértve azt a helyzetet is, amikor később vett még fel egy vagy több felsorolási konstanst. A maximális teljesség alóli összes kivétel dokumentálva lesz a kódban, így már nem kap rájuk figyelmeztetést.

A fordító továbbra sem tudja megakadályozni a következetlen osztályváltozatok használatát a futás során, így elképzelhető, hogy egy felsorolás típus régi változatával fordít le egy osztályt, de a futó alkalmazásban a felsorolás típus több felsorolási konstanssal rendelkezik. Ebben és az ehhez hasonló helyzetekben a megfelelő "catch-all" alapértelmezett megvalósítások képesek futás közbeni kivételekkel figyelmeztetni erre a következetlenségre, és megakadályozni, hogy a hiba továbbterjedjen az alkalmazásban.

A fent ajánlott szigorú fordítóbeállítások további előnye, hogy a hiányzó return utasítással kapcsolatos kétséges hibaüzenet (lásd fent) (vagy az inicializálatlan változókkal kapcsolatos hasonló üzenetek) többé már nem fordulnak elő.