Prévention des fuites de ressources

Les classes qui implémentent l'interface java.io.Closeable (depuis JDK 1.5) et java.lang.AutoCloseable (depuis JDK 1.7) sont supposées représenter des ressources externes, qui doivent être fermées à l'aide de la méthode close() dès qu'elles ne sont plus utiles.

Le compilateur Java Eclipse est capable d'analyser si le code utilisant ces types respecte cette règle. Par exemple, le fragment suivant représente une fuite de ressource :

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

Le compilateur utilise le marqueur "Fuite de ressource : 'stream' n'est jamais fermé".

Analyse de flux de base pour les fuites de ressources

L'analyse de flux détecte les situations suivantes :

Par ailleurs, l'analyse de flux tente de suivre les valeurs de ressource par le biais des affectations de variables. Néanmoins, si différentes ressources sont affectées à la même variable (sur différents flux de contrôle ou à la suite), l'analyse peut être moins précise.

Toute l'analyse n'est pas activée par défaut. Veuillez consulter les préférences du compilateur concernant les options de configuration individuelles.

Conseils : Le code sera généralement plus facile à analyser (et plus simple à comprendre par un lecteur humain) si les variables resource-type ne sont pas réutilisées à d'autres fins. Dans l'idéal, dans les programmes Java 7, toutes les ressources doivent être gérées au moyen d'une instruction try-with-resources.

Propriété/responsabilité

Le diagnostic ci-dessus part du principe qu'une méthode qui crée une instance d'un type de ressource est également responsable de la fermeture de la ressource. Toutefois, certaines ressources sont partagées par plusieurs méthodes. Dans ce contexte, l'analyse s'appuie sur les suppositions suivantes :

Encapsuleurs de ressource et interfaces Closeable sans ressources

Le JDK définit quelques classes qui implémentent l'interface Closeable, mais qui ne représentent pas directement une ressource au niveau du système d'exploitation.

java.io.StringReader est un exemple de classe fermable qui n'a pas besoin d'appeler la méthode close(), car aucune ressource de système d'exploitation ne nécessite de nettoyage. L'analyse utilise une liste blanche explicite pour détecter les classes du package java.io qui rentrent dans cette catégorie. Le système ne génère aucun avertissement de fuite de ressource à l'égard de ces classes.

Les instances de classes comme java.io.BufferedInputStream sont des encapsuleurs pour une autre ressource (où les encapsuleurs peuvent être appliqués à plusieurs niveaux). Ces objets non plus ne représentent pas directement une ressource de système d'exploitation. Si la ressource encapsulée est fermée, l'encapsuleur n'a pas besoin d'être fermé. Réciproquement, la ressource encapsulée est fermée si l'encapsuleur est fermé. L'analyse possède une seconde liste blanche pour la détection des ressources d'encapsuleur et reconnaît si la ressource courante sous-jacente est fermée directement ou indirectement via l'encapsuleur. Quelle que soit la situation, le système ne génère aucun avertissement pour ces fuites de ressources. La liste blanche contient les classes des packages java.io, java.util.zip, java.security, java.beans et java.sound.sampled.

Conseil : Il est généralement préférable/plus sûr de fermer l'encapsuleur situé le plus vers l'extérieur, qui n'est pas une ressource encapsulée.