Zapobieganie wyciekom zasobów

Klasy implementujące interfejs java.io.Closeable (od wersji JDK 1.5) i interfejs java.lang.AutoCloseable (od wersji JDK 1.7) są uważane za reprezentujące zasoby zewnętrzne, które powinny być zamykane metodą close(), gdy nie są już potrzebne.

Kompilator Java środowiska Eclipse może analizować, czy kod korzystający z tych typów jest zgodny z tą strategią. W poniższym fragmencie kodu pokazano oczywisty wyciek zasobu:

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

Kompilator oznaczy ten kod flagą „Wyciek zasobu: 'stream' nigdy nie jest zamykany”.

Podstawowa analiza przepływu wycieków zasobów

Analiza przepływu wykrywa następujące sytuacje:

Oprócz tego analiza przepływu próbuje śledzić wartości zasobów na podstawie przypisań zmiennych. Jednak w przypadku, gdy do zmiennej mogą być przypisywane różne zasoby (w różnych przepływach sterowania lub w różnej kolejności), analiza może być mniej dokładna.

Nie wszystkie opcje analizy są domyślnie włączone. Opis poszczególnych opcji konfiguracyjnych zawiera dokumentacja preferencji kompilatora.

Wskazówki: Kod będzie łatwiejszy do zanalizowania (i łatwiejszy do zrozumienia przez ludzi), jeśli zmienne o typie zasobu nie są ponownie używane w innych celach. Najlepiej jest, gdy w programach Java 7 wszystkie zasoby są zarządzane z użyciem instrukcji try-with-resources.

Prawo własności / odpowiedzialność

W ramach powyższej diagnostyki jest przyjmowane założenie, że metoda tworząca instancję typu zasobu jest również odpowiedzialna za jego zamkniecie. Jednak niektóre zasoby są współużytkowane przez kilka metod. W takim przypadku w ramach analizy są przyjmowane następujące założenia:

Opakowania zasobów i elementy zamykane bez zasobów

Środowisko JDK definiuje kilka klas implementujących interfejs Closeable, które nie reprezentują bezpośrednio zasobu na poziomie systemu operacyjnego.

Na przykład: java.io.StringReader - jest to element zamykany, który nie wymaga użycia instrukcji close(), ponieważ nie przechowuje zasobów systemu operacyjnego, które wymagałyby wyczyszczenia. W ramach analizy jest używana jawna biała lista służąca do wykrywania klas z przestrzeni nazw java.io z tej kategorii. W odniesieniu do tych klas nie są zgłaszane ostrzeżenia o wycieku zasobów.

Instancje klas, takich jak java.io.BufferedInputStream, są opakowaniami innych zasobów (opakowanie może zostać zastosowane na wielu poziomach). Takie zasoby również nie reprezentują bezpośrednio zasobu systemu operacyjnego. Gdy opakowany zasób zostanie zamknięty, opakowanie nie wymaga zamknięcia. Gdy zaś zostanie zamknięte opakowanie, pociągnie to za sobą zamknięcie opakowanego zasobu. W ramach analizy jest używana druga biała lista na potrzeby wykrywania zasobów opakowań. Dzięki temu można rozpoznać, czy rzeczywisty zasób bazowy będzie zamykany bezpośrednio, czy pośrednio przez opakowanie. Jedna z tych operacji wystarczy do usunięcia ostrzeżenia o wycieku zasobu. Biała listy zawiera klasy z przestrzeni nazw java.io, java.util.zip, java.security, java.beans i java.sound.sampled.

Wskazówka: ogólnie rzecz biorąc, lepiej i bezpieczniej jest zamykać najbardziej zewnętrzne opakowanie, a nie opakowany zasób.