Zabránění únikům prostředků

Třídy implementující rozhraní java.io.Closeable (od JDK 1.5) a java.lang.AutoCloseable (od JDK 1.7) jsou považovány za třídy reprezentující externí prostředky, které by měly být uzavřeny pomocí metody close(), nejsou-li již potřebné.

Kompilátor jazyka Java platformy Eclipse může analyzovat, zda kód využívající takové typy dodržuje tyto zásady. Například následující úsek kódu představuje zřejmý únik prostředků:

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

Kompilátor jej označí příznakem "Únik prostředků: 'stream' není nikdy uzavřen".

Základní analýza toku pro únik prostředků

Analýza toku zjišťuje následující situace:

Kromě toho se analýza toku pokusí sledovat hodnoty prostředku přiřazením proměnných. Avšak, je-li možné přiřadit různé prostředky stejné proměnné (v různých řídicích tocích nebo v pořadí), přesnost analýzy se může snížit.

Ve výchozím nastavení není povolena celá analýza. Prostudujte si předvolby kompilátoru týkající se jednotlivých voleb konfigurace.

Rady: Kód bude obecně snadněji analyzovatelný (a srozumitelný pro člověka), nejsou-li proměnné typu prostředku opakovaně používané pro různé účely. V ideálním případě by v programech s jazykem Java 7 měly být všechny prostředky spravovány pomocí příkazu try-with-resources.

Vlastnictví/zodpovědnost

Výše uvedená diagnostika v podstatě předpokládá, že metoda, která vytváří instanci typu prostředku, je také odpovědná za uzavření tohoto prostředku. Avšak některé prostředky budou sdíleny několika metodami. V tomto případě analýza počítá s těmito předpoklady:

Moduly wrapper prostředků a uzavíratelné (closeables) bez prostředků

JDK definuje několik tříd, které implementují Closeable, ale přímo nereprezentují prostředek na úrovni operačního systému.

java.io.StringReader je příkladem closeable, který nevyžaduje volání metody close(), protože nejsou využívány žádné prostředky operačního systému, které by vyžadovaly vyčištění. Analýza využívá explicitní seznam povolených adres pro zjišťování tříd z java.io, které patří do této kategorie. Nejsou zobrazována žádná varování o úniku prostředků, která by se týkala těchto tříd.

Instance tříd, jako např. java.io.BufferedInputStream, jsou moduly wrapper okolo jiného prostředku (kde mohou být moduly wrapper použity na více úrovních). Ani tyto objekty přímo nereprezentují prostředek operačního systému. Je-li zabalený prostředek uzavřen, wrapper nevyžaduje uzavření. A naopak, pokud je wrapper uzavřen, zahrnuje to také uzavření zabaleného prostředku. Analýza má druhý seznam povolených adres pro zjišťování prostředků wrapperu a rozpozná, zda bude základní skutečný prostředek uzavřen přímo nebo nepřímo prostřednictvím wrapperu. Obojí postačí k potlačení varování týkajících se úniku prostředků. Seznam povolených adres obsahuje třídy z java.io, java.util.zip, java.security, java.beans a java.sound.sampled.

Rada: Je obecně lepší/bezpečnější uzavřít nejkrajnější wrapper, nikoli zabalený prostředek.