Unngå ressurslekkasjer

Klasser som implementerer grensesnittet java.io.Closeable (siden JDK 1.5) og java.lang.AutoCloseable (siden JDK 1.7), anses å representere eksterne ressurser, som lukkes med metoden close() når de ikke lenger trengs.

Eclipses Java-kompilator kan analysere og finne ut om kode som bruker slike typer, overholder denne policyen. For eksempel representerer følgende snutt en åpenbar ressurslekkasje:

    int len(File f) throws IOException {
        InputStream stream = new FileInputStream(f);
        return stream.available();
    }

Kompilatoren vil flagge dette med "Ressurslekkasje: 'stream' lukkes aldri."

Grunnleggende flytanalyse for ressurslekkasjer

Flytanalysen oppdager følgende situasjoner:

Dessuten prøver flytanalysen å følge ressursverdiene gjennom variabeltildelinger. Hvis forskjellige ressurser kan tildeles til samme variabel (på forskjellige kontrollflyter eller i rekkefølge), kan analysen bli mindre nøyaktig.

Ikke all analyse er aktivert som standard. Slå opp på kompilatorpreferanser for å finne ut mer om de enkelte konfigurasjonsalternativene.

Hint: Koden vil generelt være lettere å analysere (og lettere å forstå for den som leser) hvis ressurstypevariabler ikke gjenbrukes for forskjellige formål. Inddelt i Java 7-programmer bør alle ressurser administreres med en try-with-resources-setning.

Eierskap / ansvar

Diagnosen over antar at en metode som oppretter en forekomst av en ressurstype, også er ansvarlig for å lukke denne ressursen. Noen ressurser vil imidlertid være delt mellom flere metoder. Her antar analysen følgende:

Ressursinnpakkere og ressursfrie lukkbare

JDK definerer noen få klasser som implementerer, som Closeable, men de representerer ikke en ressurs direkte på operativsystemnivå.

java.io.StringReader er et eksempel på en closeable (lukkbar) som ikke krever at det kalles opp close(), siden ingen operativsystemressurser holdes som krever opprydding. Analysen bruker en eksplisitt hvitliste for å finne klasser fra java.io som faller inn under denne kategorien. Ingen advarsler om ressurslekkasjer sendes ut for disse klassene.

Forekomster av klasser som java.io.BufferedInputStream er wrappers (innpakkere) rundt en annen ressurs (der disse innpakkerne kan brukes på flere nivåer). Disse objektene representerer dessuten ikke en operativsystemressurs direkte. Hvis den innpakkede ressursen lukkes, er det ikke nødvendig å lukke innpakkeren. Og hvis en innpakker lukkes, vil dette inkludere lukking av den innpakkede ressursen. Analysen har en annen hvitliste for å oppdage innpakkerressurser og vil se om den underliggende faktiske ressursen vil bli lukket direkte eller indirekte via innpakkeren. En av delene er tilstrekkelig til å stoppe advarsler om ressurslekkasjer. Hvitlisten inneholder klasser fra java.io, java.util.zip, java.security, java.beans og java.sound.sampled.

Hint: Det er generelt sikrest/å foretrekke at den ytterste pakkeren lukkes, ikke en innpakket ressurs.