避免資源洩漏

實作介面 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();
    }

編譯器會將這段標示為「資源洩漏:'stream' 從未關閉」。

資源洩漏的基本流程分析

流程分析會偵測下列狀況:

此外,流程分析會嘗試經由變數指派來追蹤資源值。 不過,如果不同資源可能指派給相同變數(在不同控制流程或依序),分析可能變得較不準確。

依預設,不會啟用所有的分析。關於個別的配置選項,請參閱編譯器喜好設定。

提示:如果 resource-type 變數不重複作為其他用途,通常可以輕鬆分析程式碼(讀者也較易於理解)。 理論上,在 Java 7 程式中,所有資源都應該以 try-with-resources 陳述式來管理。

所有權/責任

上述診斷程式基本上假設,如果方法建立資源類型的實例,則也負責關閉這個資源。 不過,某些資源可供數個方法共用。分析在這裡有下列假設:

資源封套和 resource-free closeable

JDK 定義的一些類別實作 Closeable,但不直接代表作業系統層次上的資源。

java.io.StringReader 是 closeable 的例子,不需要呼叫 close(),因為未保留可能需要清除的作業系統資源。 分析使用明確白名單來偵測 java.io 中屬於這個種類的類別。 關於這些類別,不會發出資源洩漏警告。

像是 java.io.BufferedInputStream 類別的實例是其他資源的封套(可以在多個層次上套用封套)。 這些物件也不直接代表作業系統資源。 如果封裝的資源已關閉,則封套不需要關閉。 相反地,如果封套已關閉,則這將包括關閉封裝的資源。 分析有第二份白名單來偵測封套資源,且會辨識是否直接關閉基礎實際資源,或透過封套來間接關閉。 任何一種都足以暫停關於資源洩漏的警告。 白名單包含 java.io、java.util.zip、java.security、java.beans 及 java.sound.sampled 中的類別。

提示:通常關閉最外層封套是最好/最安全的方法,而不是關閉封裝的資源。