Undvika resursläckor

Klasser som implementerar gränssnittet java.io.Closeable (sedan JDK 1.5) och java.lang.AutoCloseable (sedan JDK 1.7) anses representera externa resurser, vilka ska stängas med metoden close() när de inte längre behövs.

Eclipse Java-kompilator kan analysera om kod som använder sådana typer följer denna policy. Exempel: följande kodstycke är en uppenbar resursläcka:

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

Kompilatorn kommer att flagga detta som "Resursläcka: 'stream' stängs aldrig".

Basflödesanalys för resursläckor

Flödesanalysen detekterar följande situationer:

Dessutom försöker flödesanalysen följa resursvärden genom variabeltilldelningar. Om olika resurser dock kan tilldelas samma variabel (vid olika kontrollflöden eller i sekvens) kan analysen bli mindre exakt.

Alla analyser är inte aktiverade som standard. Se kompileringsinställningarna för de enskilda konfigureringsalternativen.

Tips: Koden är vanligen enklare att analysera (och enklare att förstå för människor) om variabler av resurstyp inte återanvänds i andra syften. Helst ska alla resurser i Java 7-program hanteras med en try-with-resources-sats.

Ägarskap/ansvar

Ovanstående diagnostik gör i grunden antagandet att en metod som skapar en instans av en resurstyp också ansvarar för att stänga denna resurs. Vissa resurser delas dock av flera metoder. Här gör analysen följande antaganden:

Resurspaketeringsmoduler och resursfria closeables

JDK definierar några klasser som implementerar Closeable men representerar inte direkt någon resurs på operativsystemsnivå.

java.io.StringReader är ett exempel på en closeable som inte kräver anropet close() eftersom inga operativsystemsresurser hålls som kräver upprensning. Analysen använder en explicit vitlista för att detektera klasser från java.io som faller inom denna kategori. Inga varningar om resursläckor utfärdas avseende dessa klasser.

Instanser med klasser som java.io.BufferedInputStream fungerar som paketeringsmoduler runt en annan resurs (där paketeringsmoduler kan tillämpas på flera nivåer). Dessa objekt representerar inte heller direkt någon operativsystemsresurs. Om den paketerade resursen stängs behöver paketeringsmodulen inte stängas. Omvänt gäller att om en paketeringsmodul stängs kommer även den paketerade resursen att stängas. Analysen har en andra vitlista för detektering av paketeringsresurser och kommer att veta om den underliggande faktiska resursen ska stängas direkt eller indirekt via paketeringsmodulen. Båda varianterna räcker för att tysta ned varningar om resursläckor. Vitlistan innehåller klasser från java.io, java.util.zip, java.security, java.beans och java.sound.sampled.

Tips: Det är normalt bäst/säkrast att stänga den yttersta paketeringsmodulen, inte den paketerade resursen.