Ressourcenlecks vermeiden

Klassen, die die Schnittstellen java.io.Closeable (seit JDK 1.5) und java.lang.AutoCloseable (seit JDK 1.7) implementieren, werden als Darstellungen externer Ressourcen betrachtet, die mit der Methode close() geschlossen werden sollten, wenn sie nicht mehr benötigt werden.

Der Eclipse-Java-Compiler kann analysieren, ob Code, der solche Typen verwendet, sich an dieser Richtlinie orientiert. Das folgende Snippet stellt ein offensichtliches Ressourcenleck dar:

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

Der Compiler markiert dieses Element mit "Ressourcenleck: 'stream' wird niemals geschlossen."

Basisablaufanalyse für Ressourcenlecks

Bei der Ablaufanalyse werden die folgenden Situationen festgestellt:

Zusätzlich versucht die Ablaufanalyse, Ressourcenwerte über Variablenzuordnungen zu verfolgen. Wenn jedoch unterschiedliche Ressourcen derselben Variablen zugeordnet sind (in unterschiedlichen Steuerungsabläufen oder in einer Sequenz), dann verliert die Analyse möglicherweise an Genauigkeit.

Nicht alle Analysen sind standardmäßig aktiviert. Prüfen Sie die Benutzervorgaben für den Compiler in Bezug auf einzelne Konfigurationsoptionen.

Hinweise: Code kann im Allgemeinen einfacher analysiert werden (und ist vom Benutzer einfacher zu verstehen), wenn resource-type-Variablen nicht für unterschiedliche Zwecke wiederverwendet werden. Im Idealfall sollten in Java 7-Programmen alle Ressourcen mit einer try-with-resources-Anweisung verwaltet werden.

Eigentumsrecht/Zuständigkeit

In den obigen Diagnoseinformationen wird davon ausgegangen, dass eine Methode, die eine Instanz eines Ressourcentyps erstellt, auch für das Schließen dieser Ressource verantwortlich ist. Allerdings werden manche Ressourcen von mehreren Methoden gemeinsam verwendet. Hier wird bei der Analyse von folgenden Annahmen ausgegangen:

Ressourcenwrapper und ressourcenfreie schließbare Elemente

Der JDK definiert einige Klassen, die Closeable implementieren, jedoch eine Ressource auf Betriebssystemebene nicht direkt darstellen.

java.io.StringReader ist ein Beispiel eines schließbaren Elements, für das close() nicht aufgerufen werden muss, weil keine Betriebssystemressourcen belegt sind, die eine Bereinigung erfordern. Die Analyse verwendet eine explizite White List, um Klassen aus java.io zu identifizieren, die in diese Kategorie gehören. In Bezug auf diese Klassen werden keine Ressourcenleckwarnungen ausgegeben.

Instanzen von Klassen wie z. B. java.io.BufferedInputStream werden als Wrapper bezeichnet, die eine andere Ressource umgeben. (Wrapper können auf mehreren Ebenen angewendet werden.) Diese Objekte stellen eine Betriebssystemressource nicht direkt dar. Wenn die mit einem Wrapper versehene Ressource geschlossen wird, dann muss der Wrapper nicht auch geschlossen werden. Wenn jedoch ein Wrapper geschlossen wird, dann wird auch die mit dem Wrapper versehene Ressource geschlossen. Die Analyse verfügt über eine zweite White List für die Feststellung von Wrapperressourcen und erkennt, ob die zugrundeliegende eigentliche Ressource direkt oder indirekt über den Wrapper geschlossen wird. Eines dieser Elemente ist ausreichend, um Warnungen hinsichtlich Ressourcenlecks zu unterdrücken. Die White List enthält Klassen von java.io, java.util.zip, java.security, java.beans und java.sound.sampled.

Hinweis: Es ist allgemein vorzuziehen bzw. am sichersten, wenn der äußerste Wrapper und nicht eine mit einem Wrapper versehene Ressource geschlossen wird.