Switch-lauseiden täydellisyyden varmistus

Kannattaa varmistaa, että jokainen switch-lause on täydellinen siten, että jokainen ajonaikainen toteutus löytää sopivan haaran. Tämä ei ole itse asiassa vähäpätöinen tehtävä huomioitaessa kaikki seuraavat seikat:

Lisäksi JLS määrää switch-lauseille virta-analyysin, mikä voi johtaa odottamattomiin käännösaikavirheisiin:

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

Kääntäjä vastaa:

Tämän metodin on palautettava tulos, jonka tyyppi on String. Huomaa, ettei switch-lauseen puuttuvaa default:-lausetta koskevaa ongelmaa näytetä. Tämä saattaa liittyä kyseiseen ongelmaan.

Tämän sanoman tarkoituksena on ilmoittaa käyttäjille eri täydellisyyskäsityksistä: JLS:n määräämä virta-analyysi pitää epätäydellisenä jokaista enum-tyypin switch-lausetta, josta puuttuu case-oletuslause, vaikka se luettelisi kaikki (sillä hetkellä tiedossa olevat) enum-vakiot. Tämä koskee return-lauseita sekä paikallismuuttujien tai tyhjien final-määreisten kenttien selvää arvon osoitusta. Jos kuitenkin noudatat kaikkia jäljempänä olevia suosituksia, edellä olevaa virhesanomaa ei tule koskaan esiin.

Lisätietoja yksittäisistä kokoonpanoasetuksista eritasoisten epätäydellisyyksien ilmoittamista varten on kääntäjän oletusasetuksissa. Jäljempänä käsitellään erilaisia määrityksen päämääriä ja käytäntöjä sekä niiden tarkistusta Eclipse Java -kääntäjän avulla.

default:-nimiö

Parhaassa tapauksessa jokainen switch-lause sisältää merkityksellisen default-haaran, joka käsittelee kaikkia case-lauseita, joita ei ole lueteltu eksplisiittisesti always-reasonable-strategian avulla. Tällaista strategiaa on tietenkin monissa tapauksissa vaikea tai jopa mahdoton löytää. Jos kuitenkin löydät mielekkään oletustoteutuksen, se on varmasti paras ratkaisu.

Suositus: Jos kääntäjän sallitaan varoittaa kaikista switch-lauseista, joista puuttuu case-oletuslause, se muistuttaa siitä, että jokaiselle switch-lauseelle kannattaa etsiä oletustoteutus.

Jos kääntäjä varoittaa puuttuvasta case-oletuslauseesta, mutta oletusarvon mukaan on järkevää olla tekemättä mitään, se kannattaa dokumentoida.

Suositus: Jos oletusstrategiana on järkevää olla tekemättä mitään, kannattaa lisätä default:-nimiö, joka toimii vain selittävänä kommenttina, että olla tekemättä mitään on hyväksyttävää kyseisessä switch-lauseessa. Näin kääntäjälle kerrotaan myös, ettei case-oletuslausetta ole vain unohdettu.

Jos järkevää oletustoteutusta ei löydy, viimeisenä vaihtoehtona haluat ehkä estää odottamattoman arvon olevan perussyynä muille alapuolisen kanavan virheille eli haluat epäonnistua varhaisessa vaiheessa ajon aikana.

Suositus: Jos järkevää oletustoteutusta ei löydy eikä hyvänä strategiana ole olla tekemättä mitään, lisää default:-nimiön sisältävä case-lause, joka palauttaa poikkeuksen tai kirjaa ongelman lokiin.

Jokainen switch-lause tulee voida määrittää johonkin edellä olevasta kolmesta luokasta. Tämä tarkoittaa, että on yleisesti kelvollinen strategia sallia kääntäjän varoittaa jokaisesta puuttuvasta case-oletuslauseesta.

Kaikkien enum-vakioiden käsittely

Toteutettaessa enum-arvon switch-lausetta jokainen enum-vakio voi olla hyvä kattaa eksplisiittisesti vastaavalla case-lauseella.

Suositus: Jos haluat, että sellaisista enum-tyypin switch-lauseista varoitetaan, joista puuttuu minkä tahansa enum-vakion case-lause, harkitse asetuksen Ilmoitus, vaikka default-lajinvaihto on määritetty käyttöönottoa.

Jos et pidä ajatuksesta, että kaikkien enum-tyypin switch-lauseiden on mainittava kaikki enum-vakiot, mutta haluat saada varoituksen joidenkin enum-tyypin switch-lauseiden puuttuvista case-nimiöistä, sinun on valittava strategia jokaiselle yksittäiselle enum-tyypin switch-lauseelle.

Suositus: Jos edellä mainittu varoitus halutaan saada joidenkin switch-lauseiden kohdalla, ota varoitus käyttöön yleisesti. Määritä myös switch-lauseet, joissa joidenkin enum-vakioiden case-lauseet voidaan jättää pois, koska case-oletuslauseet käsittelevät ne sopivalla tavalla. Dokumentoi päätöksesi käyttämällä näissä switch-lauseissa //$CASES-OMITTED$-tunnistetta:
    String colorString2(Color c) {
        switch(c) {
        case RED: return "red";
        case GREEN: return "green";
            //$CASES-OMITTED$
            default:
        	return "unknown color";
        }
    }

Vihje: Jos kääntäjä ilmoittaa, että enum-vakiolla blue tulee olla vastaava case-nimiö tässä enum-arvon Color switch-lauseessa, käytettävissä on pikakorjaus tunnisteen kommentin lisäystä varten.

Tiivistelmä

Edellä mainitut seikat osoittavat, että kääntäjästä saadaan paras hyöty irti ottamalla käyttöön epätäydellisiä switch-lauseita koskevat kaikki valinnaiset varoitukset, käyttämällä tyhjiä dokumentoituja case-oletuslauseita ja merkitsemällä kaikki ne switch-lauseet, joissa määritys sallii epätäydellisyyden, //$CASES-OMITTED$-tunnisteen kommenteilla. Jos näitä suosituksia noudatetaan, kääntäjä toteuttaa kaikki tärkeät varoitukset (tai haluttaessa virheet), kun haaroja jätetään vahingossa pois (mukaan lukien tilanteet, joissa enum-vakioita lisätään myöhemmin). Kaikki poikkeukset tästä maksimaalisesta täydellisyydestä dokumentoidaan koodiin ja niitä ei enää liputeta varoituksen avulla.

Kääntäjä ei voi silti estää epäyhdenmukaisten luokkaversioiden käyttöä ajon aikana. Luokka saatetaan tällöin kääntää enum-tyypin vanhan version avulla, mutta ajossa olevassa sovelluksessa enum-tyypillä voi olla useita enum-vakioita. Tällaisissa ja muissa samantapaisissa tilanteissa asianmukaiset catch-all-oletustoteutukset voivat tuottaa ajonaikaisia poikkeuksia, joiden avulla ilmoitetaan tällaisesta epäyhdenmukaisuudesta ja estetään virheitä välittymästä pidemmälle sovellukseen.

Lisäksi edellä suositeltujen tarkkojen kääntäjän asetusten vuoksi edellä esitettyä puuttuvaa return-lausetta koskevaa kyseenalaista virhesanomaa (tai samantapaisia alustamattomia muuttujia koskevia sanomia) ei enää tule esiin.