Αποφυγή διαρροών πόρων

Οι κλάσεις που υλοποιούν τις διεπαφές java.io.Closeable (από το JDK 1.5 και μετά) και java.lang.AutoCloseable (από το JDK 1.7 και μετά) θεωρείται ότι εκπροσωπούν εξωτερικούς πόρους οι οποίοι, όταν δεν χρειάζονται πλέον, πρέπει να κλείνουν με τη μέθοδο close() .

Ο μεταγλωττιστής Eclipse Java έχει τη δυνατότητα να αναλύει αν ο κώδικας που χρησιμοποιεί τέτοια είδη συνάδει με αυτή την πολιτική. Παραδείγματος χάριν, το ακόλουθο τμήμα κώδικα εμφανίζει μια προφανή διαρροή πόρου:

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

Ο μεταγλωττιστής θα επισημάνει αυτή τη διαρροή ως "Διαρροή πόρου: 'η ροή' δεν κλείνει ποτέ".

Βασική ανάλυση ροής για διαρροές πόρου

Η ανάλυση ροής εντοπίζει τις ακόλουθες καταστάσεις:

Επιπλέον, η ανάλυση ροής προσπαθεί να ακολουθεί τις τιμές του πόρου μέσω αντιστοιχίσεων μεταβλητών. Ωστόσο, σε περίπτωση αντιστοίχισης διαφορετικών πόρων στην ίδια μεταβλητή (σε διαφορετικές ροές ελέγχου ή σε ακολουθία), η ανάλυση μπορεί να καταστεί λιγότερο ακριβής.

Δεν έχουν ενεργοποιηθεί όλες οι λειτουργίες ανάλυσης από προεπιλογή. Συμβουλευτείτε τις προτιμήσεις μεταγλωττιστή για πληροφορίες σχετικά με μεμονωμένες επιλογές ρύθμισης.

Υποδείξεις: Θα είναι ευκολότερη η ανάλυση του κώδικα (καθώς και η κατανόηση από τους αναγνώστες) αν οι μεταβλητές είδους πόρου δεν επαναχρησιμοποιούνται για διαφορετικούς σκοπούς. Το ιδανικό θα ήταν στα προγράμματα Java 7 η διαχείριση όλων των πόρων να γίνεται με πρόταση try-with-resources.

Κατοχή/Ευθύνη

Οι παραπάνω διαγνωστικοί έλεγχοι προϋποθέτουν ότι η μέθοδος που δημιουργεί μια χρήση ενός είδους πόρου είναι επίσης υπεύθυνη για το κλείσιμο αυτού του πόρου. Ωστόσο, ορισμένοι πόροι θα είναι κοινόχρηστοι μεταξύ διαφόρων μεθόδων. Σε αυτή την περίπτωση, στην ανάλυση γίνονται οι ακόλουθες υποθέσεις:

Wrapper πόρου και closeable χωρίς πόρο

Το JDK ορίζει μερικές κλάσεις οι οποίες εφαρμόζουν το στοιχείο Closeable αλλά δεν αντιπροσωπεύουν άμεσα κάποιον πόρο στο επίπεδο του λειτουργικού συστήματος.

Το java.io.StringReader είναι ένα παράδειγμα στοιχείου closeable που δεν απαιτεί την κλήση της μεθόδου close() διότι δεν υπάρχουν πόροι του λειτουργικού συστήματος που να απαιτούν εκκαθάριση. Στην ανάλυση χρησιμοποιείται μια ρητή λίστα επιτρεπόμενων στοιχείων για τον εντοπισμό κλάσεων από το java.io που εμπίπτουν σε αυτή την κατηγορία. Δεν εκδίδονται προειδοποιήσεις για διαρροή πόρου όσον αφορά αυτές τις κλάσεις.

Χρήσεις κλάσεων όπως η java.io.BufferedInputStream είναι wrappers που περικλείουν άλλο πόρο (όπου οι wrappers μπορούν να εφαρμοστούν σε πολλαπλά επίπεδα). Επίσης, αυτά τα αντικείμενα δεν αντιπροσωπεύουν άμεσα κάποιον πόρο του λειτουργικού συστήματος. Αν ο αναδιπλωμένος πόρος είναι κλειστός, ο wrapper δεν χρειάζεται κλείσιμο. Αντίθετα, αν ο wrapper είναι κλειστός αυτό συνεπάγεται και το κλείσιμο του αναδιπλωμένου πόρου. Η ανάλυση περιλαμβάνει και μια δεύτερη λίστα επιτρεπόμενων στοιχείων για τον εντοπισμό αναδιπλωμένων πόρων και αναγνωρίζεται αν ο υποκείμενος τρέχων πόρος θα κλείσει άμεσα ή έμμεσα μέσω του wrapper. Οποιαδήποτε από τις δύο αρκεί για την απόκρυψη των προειδοποιήσεων για διαρροές πόρου. Η λίστα επιτρεπόμενων στοιχείων περιέχει κλάσεις από τα java.io, java.util.zip, java.security, java.beans και java.sound.sampled.

Υπόδειξη: Γενικώς είναι προτιμότερο/ασφαλέστερο το κλείσιμο του εξωτερικού wrapper και όχι ενός αναδιπλωμένου πόρου.