Sikre at switch-setninger er fullstendige

Det er god praksis å sikre at hver switch-setning er komplett i den betydning at hver utførelse ved kjøring vil finne en passende gren. Dette er faktisk en betydelig oppgave som tar hensyn til alt dette:

I tillegg tillater JLS flytanalyse for enum switch-setninger, noe som kan føre til uventede kompileringsfeil:

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

Kompilatoren vil svare:

"Denne metoden må returnere et resultat av typen String. Legg merke til at et problem med manglende 'default:' on 'switch' er utelatt, noe som kanskje har forbindelse med dette problemet".

Denne meldingen er utformet for å varsle brukere om forskjellige begreper for fullstendighet: Flytanalysen i henhold til JLS anser hver enum switch-setning uten standard-case som ufullstendig, selv om den viser alle (kjente) enum-konstanter. Dette angår return-setninger så vel som definitiv tilordning av lokale variabler eller tomme sluttkodefelt. Hvis du følger alle anbefalingene nedenfor, vil imidlertid feilmeldingen over aldri bli vist.

Slå opp på kompilatorpreferanser for å finne ut mer om de enkelte konfigurasjonsalternativene og rapportere forskjellige nivåer av ufullstendighet. I fortsettelsen diskuterer vi forskjellige designmål og -policyer, og hvordan de kan sjekkes ved hjelp av Java-kompilatoren til Eclipse.

Om bruk av "default:"

Optimalt skal hver switch-setning har en meningsfull default-gren som håndterer alle tilfeller som ikke er eksplisitt oppført med en "alltid rimelig"-strategi. En slik strategi er åpenbart vanskelig eller til å med umulig å finne i mange tilfeller, men hvis du kan finne en menigsfull default-implementering, er det beste løsning.

Anbefaling: Ved å la kompilatoren advare deg mot hver switch-setning som mangler en standard-case, blir du minnet på å søke etter en god standardimplementering for hver switch-setning.

Hvis kompilatoren advarer deg om manglende standard-case, men rimelig standardhandling er å gjøre ingenting, kan det være verdt å dokumentere.

Anbefaling: Hvis "gjør ingenting" er en rimelig standardstrategi, bør du legge til en default:-etikett hvis handling bare er en kommentar som forklarer at (og hvorfor) det å gjøre ingenting er OK i den switchen. Dermed forteller du også kompilatoren at du ikke bare glemte av standard-casen.

Hvis det definitivt ikke kan finnes en rimelig standardimplementering, kan du som siste utvei vurdere å hindre at en uventet verdi blir rotårsak til andre feil nedstrøms, dvs. du kan utløse en tidlig feilved kjøring.

Anbefaling: Hvis ingen rimelig standardimplementering finnes og "gjør ingenting" virker som en god strategi, kan du legge til en default:-case som gir et unntak og/eller logger problemet.

Hver switch-setning bør kunne utformes til en av de tre kategoriene ovenfor. Det betyr at det at du lar kompilatoren advare deg hver gang det mangler standard-case, er en universelt gyldig strategi.

Behandle alle enum-konstanter

Når du utfører en switch over en enum-verdi, kan det være ønskelig å eksplisitt dekke hver enum-konstant med en tilsvarende case-setning.

Anbefaling: Hvis du vil advares om enum switch-setninger som mangler en case-setning for noen av enum-konstantene, bør du vurdere å aktivere alternativet Signaliser også hvis standard case finnes.

Hvis du ikke liker alternativet med at alle enum-switcher skal nevne alle enum-konstanter, men fortsatt vil ha advarselen om manglende case-etiketter for noen enum switch-setninger, må du velge strategien for hver enkelt enum switch-setning.

Anbefaling: Hvis ovennevnte advarsel er ønskelig for noen switch-setninger, bør du vurdere å aktivere advarselen globalt og identifisere disse switch-setningene der det er OK å utelate case for noen enum-konstanter, for disse behandles tilstrekkelig av standard-case. For disse switch-setningene bruker du koden '//$CASES-OMITTED$' til å kommentere og dokumentere beslutningen:
    String colorString2(Color c) {
        switch(c) {
        case RED: return "red";
        case GREEN: return "green";
            //$CASES-OMITTED$
            default:
        	return "unknown color";
        }
    }

Hint: Hvis kompilatoren rapporterer noe som "Enum-konstanten BLUE må ha en tilsvarende case-etikett i denne enum-switchen på farge", vil det tilbys en hurtigrettelse for innsetting av kodekommentar.

Sammendrag

Betraktningene over har vist at du får mest hjelp fra kompilatoren hvis du aktiverer alle valgfrie varsler når det gjelder ufullstendige switch-setninger, bruker tomme dokumenterte standard-caser pluss //$CASES-OMITTED$-kodekommentarer til å merke switch-setninger der ufullstendighet er OK i utgangspunktet. Hvis du følger disse anbefalingene, vil du få alle relevante advarsler (eller feil, om du vil) når grener utelates ved et uhell, inkludert situasjonen med sen tilføyelse av en eller flere enum-konstanter. Alle unntak fra denne maksimale fullførtheten vil bli dokumentert i koden, og flagges ikke legges med advarsel.

Likevel kan ikke kompilatoren hindre bruk av inkonsistente klasseversjoner ved kjøring, så en klasse kan kompileres mot en eldre versjon av en enum-type, men ved kjøring av applikasjonen kan enum-typen ha flere enum-konstanter. For disse og liknende situasjoner kan relevante "catch-all"-standardimplementeringer øke kjøretidsunntakene og varsle om denne inkonsistensen og hindre feil i å spre seg lenger inn i applikasjonen.

Et annet pluss ved de strenge kompilatorinnstillingene som er anbefalt over, er at den tvilsomme feilmeldingen om manglende return-setning vist over (eller liknende meldinger om ikke-initialiserte variabler) ikke lenger forekommer.