การหลีกเลี่ยงรีซอร์สพร่อง

คลาสประยุกต์ใช้อินเตอร์เฟส java.io.Closeable (ตั้งแต่ JDK 1.5) และ java.lang.AutoCloseable (ตั้งแต่ JDK 1.7) ถูกมองว่าแสดงรีซอร์ส ภายนอก ซึ่งควรถูกปิดโดยใช้เมธอด close() เมื่อไม่ต้องใช้ อีกต่อไป

คอมไพลเลอร์ Eclipse Java สามารถวิเคราะห์ว่าโค้ดที่ใช้ชนิดต่างๆ ปฏิบัติตาม นโยบายนี้หรือไม่ เช่น snippet ต่อไปนี้แสดงการพร่องของรีซอร์สอย่างเห็นได้ชัด:

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

คอมไพลเลอร์จะแฟล็กด้วย "Resource leak: 'stream' is never closed"

การวิเคราะห์โฟลว์พื้นฐานสำหรับการพร่องของรีซอร์ส

การวิเคราะห์โฟลว์ตรวจพบสถานการณ์ต่อไปนี้:

นอกจากนั้น การวิเคราะห์โฟลว์พยายามลองติดตามค่ารีซอร์สผ่านการกำหนดค่าตัวแปร อย่างไรก็ตาม ถ้ารีซอร์สต่างกันอาจถูกกำหนดค่าเป็นตัวแปรเดียวกัน (บนโฟลว์ควบคุมต่างกัน หรือในลำดับ) การวิเคราะห์อาจมีความถูกต้องน้อยลง

การวิเคราะห์ทั้งหมดไม่ได้ถูกเปิดใช้งานโดยดีฟอลต์ โปรดดูที่ การกำหนดค่าตามความชอบสำหรับคอมไพลเลอร์ สำหรับแต่ละอ็อพชันคอนฟิกูเรชัน

คำแนะนำ: โดยทั่วไปโค้ดจะวิเคราะห์ได้ง่ายขึ้น (และเข้าใจได้ง่ายขึ้นโดยผู้อ่าน) ถ้าตัวแปร resource-type ไม่ถูกใช้ซ้ำด้วยวัตถุประสงค์อื่น โดยหลักการแล้ว ในโปรแกรม Java 7 รีซอร์สทั้งหมดควรได้รับการจัดการด้วยข้อความสั่ง try-with-resources

ความเป็นเจ้าของ / หน้าที่รับผิดชอบ

โดยพื้นฐานแล้วการวินิจฉัยด้านบนถือว่าเมธอดที่สร้างอินสแตนซ์ของชนิดรีซอร์ส มีหน้าที่รับผิดชอบในการปิดรีซอร์สนี้ด้วย อย่างไรก็ตาม บางรีซอร์สจะถูกใช้ร่วมกันระหว่างหลายๆ เมธอด ในที่นี้ การวิเคราะห์มีสมมุติฐานดังต่อไปนี้:

ตัวตัดรีซอร์สและ resource-free closeables

JDK กำหนดสองสามคลาสซึ่งประยุกต์ใช้ Closeable แต่ไม่ได้แสดงรีซอร์ส ที่ระดับของระบบปฏิบัติการโดยตรง

java.io.StringReader คือตัวอย่าง closeable ที่ไม่จำเป็นต้องเรียกใช้ close() เนื่องจาก ไม่มีรีซอร์สระบบปฏิบัติการ ถูกเก็บไว้ที่จำเป็นต้องล้างค่า การวิเคราะห์ใช้ explicit white list เพื่อตรวจหาคลาสจาก java.io ที่อยู่ในหมวดหมู่นี้ ไม่มีคำเตือนการพร่องของรีซอร์สเกิดขึ้นเกี่ยวกับคลาสเหล่านี้

อินสแตนซ์ของคลาสเช่น java.io.BufferedInputStream คือ wrappers รอบรีซอร์สอื่น (โดย wrappers สามารถใช้ที่หลายๆ ระดับ) รวมทั้งอ็อบเจ็กต์เหล่านี้ไม่แสดงรีซอร์สระบบปฏิบัติการโดยตรง ถ้ารีซอร์สที่ wrapped ถูกปิด wrapper ไม่จำเป็นต้องทำการปิด ในทางกลับกัน ถ้า wrapper ถูกปิดการปิดนี้จะรวมการปิดของรีซอร์สที่ wrapped การวิเคราะห์มี white list ที่สองสำหรับการตรวจหารีซอร์ส wrapper และจะทราบว่า รีซอร์สจริงที่จำเป็นจะถูกปิดโดยตรง หรือโดยอ้อมผ่าน wrapper ข้อใดข้อหนึ่งก็เพียงพอปิดคำเตือนเกี่ยวกับการพร่องของรีซอร์ส ใน white list มีคลาสจาก java.io, java.util.zip, java.security, java.beans และ java.sound.sampled

คำแนะนำ: โดยทั่วไปเป็นการดี/ปลอดภัยที่สุดที่จะปิด wrapper นอกสุดไม่ใช่รีซอร์สที่ wrapped