NullPointerException on yleinen Java-ohjelmien häiriöiden syy.
Yksinkertaisissa tapauksissa kääntäjä voi varoittaa suoraan, kun se havaitsee seuraavanlaisen koodin:
Object o = null;
String s = o.toString();
Kehittyneen virta-analyysin haaroituksen tai silmukoinnin ja poikkeusten tuoton avulla voidaan selvittää, onko muuttujalle, jonka arvoa haetaan, määritetty tyhjäarvo tai muu kuin tyhjäarvo ohjelman jossakin polussa tai kaikissa polussa.
Periytyvän monimutkaisuuden vuoksi virta-analyysi on hyvä suorittaa pienissä osissa. Työkalu toimii hyvin analysoitaessa yhtä metodia kerrallaan, mutta koko järjestelmän analysointiin Eclipse Java -kääntäjä ei sovellu. Analyysi on nopea ja voidaan tehdä vähittäin niin, että kääntäjä voi varoittaa suoraan kirjoittaessasi. Varjopuolena on, ettei analyysi voi havaita, mitkä arvot (tyhjäarvot vai muut kuin tyhjäarvot) virtaavat metodien välillä (parametreina ja paluuarvoina).
Tyhjäarvojen huomautukset tulevat kuvaan tässä.
Määrittämällä metodin parametrin @NonNull-parametrina voit ilmoittaa kääntäjälle,
ettet halua tyhjäarvoa kyseiseen sijaintiin.
String capitalize(@NonNull String in) {
return in.toUpperCase(); // ei tarvita tyhjäarvotarkistusta
}
void caller(String s) {
if (s != null)
System.out.println(capitalize(s)); // tarvitaan edeltävä tyhjäarvotarkistus
}
Sopimuspohjaisen ohjelmoinnin kannalta tässä on kaksi puolta:
capitalize toteuttajan tulee
taata, ettei argumentti in ole tyhjäarvo.
Arvo voidaan siksi hakea tässä ilman tyhjäarvon tarkistusta.
Metodin paluuarvojen osalta tilanne on symmetrinen:
@NonNull String getString(String maybeString) {
if (maybeString != null)
return maybeString; // tarvitaan edeltävä tyhjäarvotarkistus
else
return "<n/a>";
}
void caller(String s) {
System.out.println(getString(s).toUpperCase()); // ei tarvita tyhjäarvotarkistusta
}
Eclipse Java -kääntäjä voidaan määrittää niin, että se käyttää erilaisia huomautustyyppejä sen parannetussa tyhjäarvoanalyysissa (joka on käytössä oletusarvon mukaan):
@NonNull: tyhjäarvoa ei sallita@Nullable: tyhjäarvo sallitaan ja on odotettu arvo@NonNullByDefault: metodin allekirjoitusten tyypit,
joissa tyhjäarvojen huomautuksen puuttuminen katsotaan tyhjäarvoksi.Huomautuksia @NonNull ja @Nullable tuetaan seuraavissa sijainneissa:
@NonNullByDefault-huomautusta tuetaan seuraavissa sijainneissa:
package-info.java kautta) – jotta voidaan vaikuttaa paketin kaikkiin tyyppeihin.
Huomaa, että vaikka näiden huomautusten todelliset tarkennetut nimet ovat
määritettävissä,
edellä annettuja nimiä käytetään oletusarvon mukaan (sisältyvät pakettiin org.eclipse.jdt.annotation).
Tyhjäarvojen oletushuomautukset sisältävä JAR toimitetaan Eclipsen tiedostossa eclipse/plugins/org.eclipse.jdt.annotation_*.jar. Kyseisen JAR-tiedoston on oltava koontipolussa käännösvaiheessa muttei ajon aikana. Sitä ei siis tarvitse toimittaa käännetyn koodin käyttäjille.
Käytettävissä on kaksi ratkaisemattomien @NonNull-, @Nullable- tai @NonNullByDefault-viittausten pikakorjausta, joiden avulla JAR voidaan lisätä koontipolkuun:


Tyhjäarvojen huomautukset lisäävät Java-ohjelmaan tietoja, joiden avulla kääntäjä voi tuottaa parempia varoituksia. Millaisia tietoja haluamme näiden huomautusten sitten antavan? Käytännölliseltä kannalta on vähintään kolme tasoa, joista tyhjäarvojen huomautusten avulla annetaan tietoa:
Jos haluat antaa kohdan 1 mukaisia tietoja, voit aloittaa tyhjäarvojen huomautusten käytön heti lukematta tämän enempää. Tällöin ei kuitenkaan kannata odottaa kuin pikkuvinkkejä aina silloin tällöin. Muut tasot vaativat lisäselvitystä.
Ensi silmäyksellä tyhjäarvojen huomautusten käyttö ohjelmointirajapintamäärityksissä sopimuspohjaisessa ohjelmoinnissa tarkoittaa vain sitä, että kaikkien ohjelmointirajapinnan metodien allekirjoituksiin on lisättävä täydellinen huomautus. Lukuun ottamatta alkeistyyppejä (kuten int) jokaiseen parametriin tai metodin paluulajiin on siis lisättävä joko @NonNull- tai @Nullable-huomautus.
Koska tämä tarkoittaa erittäin monen tyhjäarvojen huomautuksen lisäämistä, on hyvä tietää, että @NonNull esiintyy huomattavasti
useammin hyvin suunnitellussa koodissa (erityisesti ohjelmointirajapinnan metodeissa) kuin @Nullable. Siten huomautusten määrää voi vähentää esittelemällä @NonNull-huomautuksen oletusarvona käyttämällä @NonNullByDefault-huomautusta
pakettitasolla.
Huomaa merkittävä ero @Nullable-huomautuksen ja tyhjäarvojen huomautuksen poisjätön välillä:
@Nullable-huomautus ilmaisee eksplisiittisesti, että tyhjäarvo sallitaan ja on odotettu.
Huomautuksen poisjättö sitä vastoin tarkoittaa, ettei aikomusta tiedetä.
Ennen molemmat puolet (kutsuja ja kutsuttava) saattoivat tarkistaa tyhjäarvon tarpeettomasti ja olettaa joskus virheellisesti, että toinen puoli tekee tarkistuksen.
Tästä on saanut alkunsa NullPointerExceptions.
Ilman huomautusta kääntäjä ei anna erityisohjeita. Jos @Nullable-huomautusta kuitenkin käytetään, jokainen tarkistamaton arvon haku liputetaan.
Näillä perusteilla kaikki parametrien huomautukset voidaan määrittää suoraan esiehdoiksi ja paluuhuomautukset tulkita metodin jälkiehdoiksi.
Olioperustaisessa ohjelmoinnissa sopimuspohjaisen ohjelmoinnin konseptin on käsiteltävä vielä yhtä ulottuvuutta: alityyppejä ja ohitusta (jäljempänä ohitus-termiä käytetään Java 6:n
@Override-huomautuksen merkityksessä: metodit ohittavat tai toteuttavat toisen metodin ylityypistä). Työasemaohjelman, joka kutsuu seuraavanlaista metodia:
@NonNull String checkedString(@Nullable String in)
tulee sallia olettaa, että metodin kaikki toteutukset täyttävät sopimuksen.
Joten kun metodin esittely löytyy rajanpinnasta I1,
on suljettava pois, että jokin rajapinnan I1 toteuttava luokka Cn tuottaa
yhteensopimattoman toteutuksen. Se on luvatonta erityisesti silloin, jos jokin Cn yrittää
ohittaa tämän metodin toteutuksella, joka esittelee parametrin @NonNull-parametrina.
Jos tämä sallittaisiin, rajapinnan I1 avulla ohjelmoitu työasemaohjelman moduuli voi
välittää tyhjäarvon argumenttina, mutta toteutus olettaisi muun kuin tyhjäarvon.
Tarkistamaton arvon haku metodin toteutuksen sisällä sallittaisiin mutta epäonnistuisi ajon aikana.
Näin ollen @Nullable-parametrimääritys velvoittaa, että kaikki ohitukset
hyväksyvät tyhjäarvon odotettuna, sallittuna arvona.
@NonNull-paluumääritys sitä vastoin velvoittaa, että kaikki ohitukset
varmistavat, ettei tyhjäarvoa koskaan palauteta.
Siksi kääntäjän on tarkistettava, ettei mikään ohitus lisää sellaista @NonNull-parametrihuomautusta
(tai @Nullable-paluuhuomautusta), jota ei ollut ylityypissä.
Käänteiset uudelleenmäärittelyt ovat yllättävää kyllä sallittuja: @Nullable-parametrihuomautuksen tai @NonNull-paluuhuomautuksen lisäys (voit pitää näitä metodin parannuksina, sillä ne hyväksyvät useampia arvoja ja tuottavat entistä tarkemman paluuarvon).
Aiemmat seikat aiheuttavat hankaluuksia, kun huomautuksilla varustettua koodia kirjoitetaan periytyvän (eli huomautuksettoman) tyypin (joka voi olla peräisin kolmannen osapuolen kirjastosta) alityyppinä.
Jos luit viimeisen osan erittäin huolellisesti, saatoit huomata, ettei periytyvän metodin
ohitusta @NonNull-parametria sisältävällä metodilla voida hyväksyä.
(Tämä johtuu siitä, että ylityyppiä käyttävät työasemaohjelmat eivät näe @NonNull-velvoitetta.)
Tällaisessa tilanteessa tyhjäarvojen huomautusten poisjättö pakotetaan. (Suunnitteilla on myöhemmin tukea huomautusten lisäystä kirjastoihin, mutta on vaikea luvata, tuleeko niin tapahtumaan ja milloin niin mahdollisesti tapahtuu.)
Tilanne hankaloituu, jos periytyvän tyypin alityyppi sijaitsee paketissa, jossa
@NonNullByDefault on määritetty. Tyypin, jolla on huomautukseton ylityyppi,
olisi tällöin merkittävä kaikki ohittavien metodien parametrit @Nullable-parametreiksi:
jopa parametrihuomautusten poisjättöä ei sallittaisi, koska se tulkitaan @NonNull-parametrina, joka on kielletty kyseissä sijainnissa.
Eclipse Java -kääntäjä tukee siksi tyhjyysoletuksen
peruutusta. Kun metodiin tai tyyppiin lisätään @NonNullByDefault(false)-huomautus,
kyseisen elementin sovellettava oletus perutaan ja huomautuksettomat parametrit tulkitaan taas määrittämättömiksi. Alityypit ovat tällöin taas sallittuja ilman, että ei-toivottua @Nullable-huomautusta lisätään:
class LegacyClass {
String enhance (String in) { // työasemaohjelmia ei pakoteta välittämään tyhjäarvoa.
return in.toUpperCase();
}
}
@NonNullByDefault
class MyClass extends LegacyClass {
// ... metodit, joilla on @NonNull-oletusarvo ...
@Override
@NonNullByDefault(false)
String enhance(String in) { // ei ole kelvollinen, jos tässä käytettiin @NonNullByDefault-huomautusta
return super.enhance(in);
}
}
Kun tyhjäarvojen huomautuksia käytetään sopimuspohjaisen ohjelmoinnin kaltaisesti edellä kuvatulla tavalla, Java-koodin laatu paranee monella eri tavalla: metodien välisessä rajapinnassa määritetään erikseen, mitkä parametrit tai paluut sallivat tyhjäarvon ja mitkä eivät. Tämä tallentaa kehittäjille merkitykselliset suunnittelupäätökset tavalla, jonka myös kääntäjä voi tarkistaa.
Tämän rajapintamäärityksen perusteella toimintosarjan sisäinen virta-analyysi voi lisäksi poimia käytettävissä olevat tiedot ja tuottaa entistä tarkempia virheitä tai varoituksia. Ilman huomautuksia metodiin tai metodista virtaavalla arvolla on tuntematon tyhjyys, jonka vuoksi tyhjäarvoanalyysi ei anna tietoja niiden käytöstä. Useiden arvojen tyhjyys on tosiasiallisesti tiedossa ohjelmointirajapintatason tyhjäarvohuomautusten ansiosta, ja kääntäjältä jää huomaamatta huomattavasti vähemmän NPE-poikkeuksia. On kuitenkin oltava tietoinen siitä, että olemassa on vielä joitakin porsaanreikiä, joiden kautta analyysiin virtaa määrittämättömiä arvoja. Ne estävät sellaisen lauseen toteutuksen, joka määrittää, voiko NPE-poikkeuksia esiintyä ajon aikana.
Tyhjäarvojen huomautusten tuki on suunniteltu sellaiseksi, että se on yhteensopiva tulevan laajennuksen kanssa. Kääntäjä voi sen avulla taata, ettei lisensoitu ohjelma koskaan palauta NullPointerException-poikkeusta ajon aikana (ja tyypillisiä varoituksia tarkistamattomista osista, kuten reflektiosta). Koska lupauksia tällaisesta tulevasta laajennuksesta ei voida tehdä, perusajatus on vain tulkinta siitä, mitä jo on.
Tulkitsemalla tyhjäarvojen huomautuksia tyyppijärjestelmän osana kaksinkertaistamme tietyn ohjelman tyyppien määrän. Minkä tahansa tietyn luokan Cn itse luokkaa
ei pidetä enää sallittuna tyyppinä, vaan ainoastaan @NonNull Cn ja
@Nullable Cn ovat hyödyllisiä tyyppejä. Näin parhaassa tapauksessa tiedetään jokaisen ohjelman arvon osalta, voiko se olla tyhjäarvo (ja se on tarkistettava ennen arvon hakua).
Jos kolmas vaihtoehto jätetään pois (huomautuksettomat tyypit), kääntäjä voi täsmällisesti liputtaa jokaisen virheellisen käytön.
Nykyisessä toteutuksessa on kaksi merkittävää tätä tavoitetta koskevaa rajoitetta:
Huolimatta nykyisistä rajoitteista täydellisesti määritettyjen ja kokonaan tarkistettujen ohjelmien visio on jo jollain tavalla muovannut nykyistä analyysia ja kääntäjän ilmoittamia virheitä tai varoituksia. Lisätietoja annetaan esittelemällä kääntäjän tarkistamat säännöt ja sanomat, jotka se tuottaa sääntöä rikottaessa.
Kääntäjän tarkistamat yksittäiset säännöt jaotellaan vastaavalla oletusasetussivulla seuraavasti:
Määrityksen rikkomuksena pidetään tilanteita, joissa tyhjäarvojen huomautus
esittää pyynnön, jota todellinen toteutus rikkoo. Tavallisesti tämä johtuu siitä, että arvo (paikallinen, argumentti, metodin paluu) määritetään @NonNull-arvona, mutta toteutus tuottaa sitä vastoin tyhjäarvon sallivan arvon. Tässä lauseketta pidetään tyhjäarvot sallivana, jos sen staattisesti tiedetään palauttavan tyhjäarvon tai jos se määritetään @Nullable-huomautuksen avulla.
Tämä ryhmä sisältää myös metodin ohituksen säännöt, joita käsiteltiin edellä.
Tässä ylimetodi tekee pyynnön (esim. tyhjäarvo on sallittu argumentti),
kun taas ohitus yrittää sivuuttaa tämän pyynnön (olettamalla, että tyhjäarvo ei ole sallittu argumentti).
Kuten jo mainittiin, jopa argumentin erikoistamista huomautuksettomasta argumentista @NonNull-argumentiksi pidetään määrityksen rikkomuksena. Se nimittäin esittelee sopimuksen, jonka tulisi sitoa työasemaohjelma (jotta se ei välitä tyhjäarvoa). Ylityyppiä käyttävä työasemaohjelma ei kuitenkaan edes näe kyseistä sopimusta, joten se ei edes tiedä, mitä siltä odotetaan.
Täällä on täydellinen luettelo tilanteista, joita pidetään määrityksen rikkomuksina.
On tärkeää ymmärtää, ettei tämän ryhmän virheitä saa koskaan ohittaa.
Jos ne ohitetaan, koko tyhjäarvoanalyysi toteutetaan muutoin virheellisten olettamusten perusteella.
Erityisesti aina kun kääntäjä havaitsee @NonNull-huomautuksella varustetun arvon,
se pitää itsestään selvänä, ettei ajon aikana esiinny tyhjäarvoa.
Määrityksen rikkomuksia koskevat säännöt varmistavat tämän päättelyn luotettavuuden.
Siksi on erittäin suositeltavaa, että tällainen ongelma määritetään virheeksi.
Myös tämän ryhmän säännöt valvovat tyhjäarvomääritysten noudattamista.
Tässä on kuitenkin kyse arvoista, joita ei ole määritetty @Nullable-arvoina
(eikä itse tyhjäarvoina) vaan arvoina, joiden kohdalla toimintosarjan sisäinen virta-analyysi
päättelee, että tyhjäarvo voi esiintyä jossakin suorituspolussa.
Tällainen tilanne syntyy, kun kääntäjä päättelee virta-analyysin avulla, voiko huomautuksettoman paikallismuuttujan arvona olla tyhjäarvo. Oletetaan, että virta-analyysi on tarkka. Jos se havaitsee ongelman, sitä pidetään yhtä vakavana kuin suoria tyhjäarvomäärityksen rikkomuksia. Siksi on taas erittäin suositeltavaa, että tällaiset ongelmat määritetään virheiksi ja ettei näitä sanomia ohiteta.
Erillisen ryhmän luonnilla näille ongelmille on kaksi tarkoitusta: voidaan dokumentoida, että tietty ongelma on havaittu virta-analyysin avulla, ja tiedetään, että tämä virta-analyysi voi olla virheellinen (toteutuksessa olevan virheen vuoksi). Jos kyseessä on tunnettu toteutukseen liittyvä virhe, tällaisen virhesanoman voi joissain poikkeustapauksissa ohittaa.
Ottaen huomioon staattisten analyysien luonteen virta-analyysi ei välttämättä havaitse, ettei tietty suorituspolkujen ja arvojen yhdistelmä ole mahdollinen. Esimerkkinä kannattaa harkita muuttujien korrelaatiota:
String flatten(String[] inputs1, String[] inputs2) {
StringBuffer sb1 = null, sb2 = null;
int len = Math.min(inputs1.length, inputs2.length);
for (int i=0; i<len; i++) {
if (sb1 == null) {
sb1 = new StringBuffer();
sb2 = new StringBuffer();
}
sb1.append(inputs1[i]);
sb2.append(inputs2[i]); // varoitus tähän
}
if (sb1 != null) return sb1.append(sb2).toString();
return "";
}
Kääntäjä ilmoittaa mahdollisesta paikanvarausosoittimen käytöstä kutsussa sb2.append(..).
Ihminen voi nähdä, ettei oikeaa vaaraa ole, sillä sb1 ja sb2 korreloivat itse asissa niin, että molemmat muuttujat ovat joko tyhjäarvoja tai muita kuin tyhjäarvoja.
Tiedämme, ettei kyseessä olevan rivin sb1 ole tyhjäarvo. Tällöin myöskään sb2
ei ole tyhjäarvo. Menemättä yksityiskohtiin siitä, miksi Eclipse Java -kääntäjä ei pysty tällaiseen korrelaatioanalyysiin, kannattaa muistaa, että tämä analyysi ilmoittaa pessimistisesti joistakin ongelmista, jotka toinen kehittyneempi analyysi saattaa määrittää virheellisiksi hälytyksiksi.
Jos haluat hyödyntää virta-analyysia, kääntäjälle kannattaa antaa hieman ohjeita, jotta se näkee päätöksesi. Tällainen ohje voi tarkoittaa esimerkiksi vain lauseen if (sb1 == null)
jakamista kahdeksi if-lauseeksi (yksi kummallekin paikallismuuttujalle). Tämä on erittäin pieni vaiva siihen nähden, että kääntäjä näkee tällöin tarkalleen, mitä tapahtuu, ja tarkistaa koodin sen mukaisesti.
Lisätietoja tästä aiheesta on jäljempänä.
Tämä ongelmien ryhmä perustuu seuraavaan analogiaan: kutsut Java 5 -versiota edeltäviin kirjastoihin Java 5:n geneerisiä luokkia käyttävässä ohjelmassa saattavat tuoda ilmi muotoilemattomia tyyppejä (kuten geneerisen tyypin sovelluksia), jotka epäonnistuvat konkreettisten tyyppiargumenttien määrityksessä. Jotta tällaiset arvot voidaan sovittaa ohjelmaan geneeristen luokkien avulla, kääntäjä voi lisätä epäsuoran muunnon olettamalla, että tyyppiargumentit määritettiin koodin työasemaohjelman puolen odottamalla tavalla. Kääntäjä tuottaa varoituksen tällaisen muunnon käytöstä ja jatkaa sen tyypin tarkistusta olettaen, että kirjasto "tekee oikein". Kirjaston metodin huomautuksetonta paluutyyppiä voidaan pitää täysin samalla tavalla muotoilemattomana tai periytyvänä tyyppinä. Epäsuora muunto voi taas optimistisesti olettaa odotettua määritystä. Taas annetaan varoitus, ja analyysi jatkaa sen olettamista, että kirjasto "tekee oikein".
Teoreettisesti katsottuna tällaisten epäsuorien muuntojen tarve osoittaa myös määrityksen rikkomuksen. Tässä tapauksessa voi olla, että kolmannen osapuolen koodi rikkoo määritystä, jota oma koodimme odottaa. Voi myös olla, että kolmannen osapuolen koodi täyttää sopimuksen ja epäonnistuu vain sen ilmoittamisessa (koska se ei käytä tyhjäarvojen huomautuksia). Tällaisissa tilanteissa ongelmaa ei voi ehkä ihan korjata organisatorisista syistä.
@SuppressWarnings("null")
@NonNull Foo foo = Library.getFoo(); // epäsuora muunnos
foo.bar();
Edellä oleva koodikatkelma olettaa, että Library.getFoo() palauttaa arvon Foo,
määrittämättä tyhjäarvon huomautusta. Paluuarvo voidaan integroida huomautuksia sisältävään ohjelmaan @NonNull-paikallismuuttujan osoituksella, mikä käynnistää tarkistamatonta muuntoa koskevan varoituksen.
Lisäämällä vastaava SuppressWarnings("null")-varoitus tähän esittelyyn
tunnustetaan periytyvä vaara ja hyväksytään vastuu sen tarkistuksesta, että kirjasto todellakin toimii halutulla tavalla.
Jos virta-analyysi ei voi nähdä, ettei arvo olekaan tyhjäarvo, helpoin tapa on lisätä uusi @NonNull-huomautuksen sisältävä rajattu paikallismuuttuja.
Jos olet varma, että paikallismuuttujalle määritetty arvo ei ole koskaan tyhjäarvo ajon aikana, voit käyttää seuraavanlaisia aputoimintometodeja:
static @NonNull <T> T assertNonNull(@Nullable T value, @Nullable String msg) {
if (value == null) throw new AssertionError(msg);
return value;
}
@NonNull MyType foo() {
if (isInitialized()) {
MyType couldBeNull = getObjectOrNull();
@NonNull MyType theValue = assertNonNull(couldBeNull,
"value should not be null because application " +
"is fully initialized at this point.");
return theValue;
}
return new MyTypeImpl();
}
Huomaa, että käyttämällä edellä olevaa assertNonNull()-metodia hyväksyt vastuun siitä,
että tämä vahvistus on voimassa aina ajon aikana.
Jos et halua tätä, huomautuksella varustettujen paikallismuuttujien avulla voidaan silti rajoittaa sitä, missä ja miksi analyysi pitää mahdollisena sitä, että tyhjäarvo virtaa tiettyyn sijaintiin.
JDT-version 3.8.0 julkaisuhetkellä kerätään edelleen tyhjäarvojen huomautusten käyttöä koskevia ohjeita. Siksi näitä tietoja säilytetään tällä hetkellä Eclipse-wikissä.