วิธีการใช้คำอธิบายประกอบ @Nullable และ @Nonnull มีประสิทธิภาพมากขึ้นได้อย่างไร

ฉันเห็นว่าคำอธิบายประกอบ@Nullableและอาจมีประโยชน์ในการป้องกันs แต่พวกเขาไม่เผยแพร่ไกลมาก@NonnullNullPointerException

• ประสิทธิผลของการเพิ่มความคิดเห็นเหล่านี้จะลดลงอย่างสมบูรณ์หลังจากผ่านไปหนึ่งระดับทางอ้อมดังนั้นหากคุณเพิ่มเพียงไม่กี่อย่างพวกเขาก็จะไม่เผยแพร่ไกลมากนัก
• เนื่องจากคำอธิบายประกอบเหล่านี้ไม่ได้บังคับใช้อย่างดีมีความเสี่ยงที่จะถือว่าค่าที่ทำเครื่องหมายด้วย@Nonnullนั้นไม่เป็นโมฆะดังนั้นจึงไม่สามารถทำการตรวจสอบโมฆะได้

โค้ดข้างล่างนี้เป็นสาเหตุของพารามิเตอร์ที่มีเครื่องหมาย@Nonnullที่จะเป็นnullโดยไม่ต้องเพิ่มข้อร้องเรียนใด ๆ มันจะพ่นNullPointerExceptionเมื่อมันถูกเรียกใช้

public class Clazz {
    public static void main(String[] args){
        Clazz clazz = new Clazz();

        // this line raises a complaint with the IDE (IntelliJ 11)
        clazz.directPathToA(null);

        // this line does not
        clazz.indirectPathToA(null); 
    }

    public void indirectPathToA(Integer y){
        directPathToA(y);
    }

    public void directPathToA(@Nonnull Integer x){
        x.toString(); // do stuff to x        
    }
}

มีวิธีที่จะทำให้คำอธิบายประกอบเหล่านี้มีการบังคับใช้อย่างเข้มงวดมากขึ้นและ / หรือเผยแพร่เพิ่มเติมหรือไม่

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

ตามที่กล่าวไว้ในหนังสือ "Clean Code" คุณควรตรวจสอบพารามิเตอร์ของวิธีสาธารณะและหลีกเลี่ยงการตรวจสอบค่าคงที่

เคล็ดลับที่ดีอีกข้อหนึ่งคือไม่ส่งคืนค่าNullแต่ใช้Null Object Patternแทน

นอกเหนือจาก IDE ของคุณให้คำแนะนำเมื่อคุณผ่านnullไปยังวิธีการที่คาดว่าอาร์กิวเมนต์จะไม่เป็นโมฆะมีข้อดีเพิ่มเติม:

• เครื่องมือวิเคราะห์รหัสแบบคงที่สามารถทดสอบเช่นเดียวกับ IDE ของคุณ (เช่น FindBugs)
• คุณสามารถใช้ AOP เพื่อตรวจสอบการยืนยันเหล่านี้

วิธีนี้จะช่วยให้รหัสของคุณสามารถบำรุงรักษาได้มากขึ้น (เนื่องจากคุณไม่จำเป็นต้องnullตรวจสอบ) และมีข้อผิดพลาดน้อยลง

ฉันคิดว่าคำถามเดิมนี้ชี้ไปที่คำแนะนำทั่วไปโดยอ้อมว่ายังจำเป็นต้องใช้การตรวจสอบตัวชี้โมฆะในขณะใช้งานแม้ว่าจะใช้ @NonNull ก็ตาม อ้างอิงถึงลิงค์ต่อไปนี้:

คำอธิบายประกอบแบบใหม่ของ Java 8

ในบล็อกด้านบนขอแนะนำว่า:

คำอธิบายประกอบแบบตัวเลือกไม่ได้ใช้แทนการตรวจสอบความถูกต้องแบบรันไทม์ ก่อนที่จะทำการเพิ่มความคิดเห็นแบบชนิดตำแหน่งหลักสำหรับการอธิบายสิ่งต่าง ๆ เช่นความสามารถในการ null หรือช่วงอยู่ใน javadoc ด้วยคำอธิบายประกอบประเภทการสื่อสารนี้เข้ามาใน bytecode ในวิธีการตรวจสอบเวลารวบรวม รหัสของคุณยังควรตรวจสอบความถูกต้องรันไทม์

รวบรวมตัวอย่างต้นฉบับใน Eclipse ที่การปฏิบัติตาม 1.8 และเปิดใช้งานการวิเคราะห์โมฆะตามบันทึกย่อเราได้รับคำเตือนนี้:

    directPathToA(y);
                  ^
Null type safety (type annotations): The expression of type 'Integer' needs unchecked conversion to conform to '@NonNull Integer'

คำเตือนนี้เป็นคำเปรียบเทียบกับคำเตือนที่คุณได้รับเมื่อผสมรหัสที่สร้างกับรหัสดั้งเดิมโดยใช้ประเภทดิบ ("การแปลงที่ไม่ถูกตรวจสอบ") เรามีสถานการณ์เดียวกันที่นี่: เมธอดindirectPathToA()มีลายเซ็น "ดั้งเดิม" ซึ่งไม่ได้ระบุสัญญาที่เป็นโมฆะใด ๆ เครื่องมือสามารถรายงานสิ่งนี้ได้อย่างง่ายดายดังนั้นพวกเขาจะไล่ล่าคุณตามตรอกซอกซอยทั้งหมดที่จำเป็นต้องเผยแพร่คำอธิบายประกอบแบบ null แต่ยังไม่มี

และเมื่อใช้ฉลาด@NonNullByDefaultเราไม่จำเป็นต้องพูดแบบนี้ทุกครั้ง

กล่าวอีกนัยหนึ่ง: คำอธิบายประกอบที่เป็นโมฆะหรือไม่ "เผยแพร่ไปไกลมาก" อาจขึ้นอยู่กับเครื่องมือที่คุณใช้และขึ้นอยู่กับว่าคุณเข้าร่วมอย่างจริงจังกับคำเตือนทั้งหมดที่ออกโดยเครื่องมือนี้หรือไม่ ด้วยTYPE_USE คำอธิบายประกอบ nullคุณก็มีทางเลือกที่จะให้เครื่องมือเตือนคุณเกี่ยวกับทุก NPE เป็นไปได้ในโปรแกรมของคุณเพราะ nullness ได้กลายเป็นสถานที่ให้เนื้อเสียงของระบบการพิมพ์

ฉันยอมรับว่าคำอธิบายประกอบ "อย่าเผยแพร่ไปไกลมาก" อย่างไรก็ตามฉันเห็นความผิดพลาดในด้านของโปรแกรมเมอร์

ฉันเข้าใจNonnullคำอธิบายประกอบเป็นเอกสาร เป็นการแสดงออกถึงวิธีการดังต่อไปนี้คือต้อง (เป็นสิ่งที่จำเป็น) xอาร์กิวเมนต์

    public void directPathToA(@Nonnull Integer x){
        x.toString(); // do stuff to x        
    }

ตัวอย่างโค้ดต่อไปนี้มีข้อบกพร่อง การเรียกdirectPathToA()ใช้เมธอดโดยไม่บังคับใช้ที่yไม่ใช่ค่าว่าง (นั่นคือไม่รับประกันว่าเงื่อนไขของวิธีการที่เรียกใช้) ความเป็นไปได้อย่างหนึ่งคือการเพิ่มNonnullคำอธิบายประกอบลงในindirectPathToA()(เผยแพร่สิ่งที่จำเป็น) ความเป็นไปได้ที่สองคือการตรวจสอบค่าว่างyในindirectPathToA()และหลีกเลี่ยงการเรียกdirectPathToA()เมื่อyเป็นค่าว่าง

    public void indirectPathToA(Integer y){
        directPathToA(y);
    }

สิ่งที่ฉันทำในโครงการของฉันคือการเปิดใช้งานตัวเลือกต่อไปนี้ในการตรวจสอบรหัส "ค่าคงที่และข้อยกเว้น":
แนะนำ @ คำอธิบายประกอบแบบไม่สามารถแก้ไขได้สำหรับวิธีการที่อาจส่งคืนค่า null และรายงานค่า nullable

เมื่อเปิดใช้งานพารามิเตอร์ที่ไม่ได้ใส่คำอธิบายประกอบทั้งหมดจะถือเป็นไม่เป็นโมฆะดังนั้นคุณจะเห็นคำเตือนเกี่ยวกับการโทรทางอ้อมของคุณ:

clazz.indirectPathToA(null); 

สำหรับการตรวจสอบที่แข็งแกร่งตัวตรวจสอบกรอบอาจจะเป็นทางเลือกที่ดี (ดูนี้ดีกวดวิชา .
หมายเหตุ : ฉันไม่ได้ใช้ที่ยังและอาจจะมีปัญหากับคอมไพเลอร์แจ็ค: ดูรายงานข้อบกพร่องนี้

ใน Java ฉันต้องการใช้เลือกประเภทของฝรั่ง เป็นประเภทจริงคุณจะได้รับคอมไพเลอร์รับประกันเกี่ยวกับการใช้งาน มันง่ายที่จะข้ามมันและได้รับNullPointerExceptionแต่อย่างน้อยลายเซ็นของวิธีการสื่อสารอย่างชัดเจนสิ่งที่คาดว่าจะเป็นข้อโต้แย้งหรือสิ่งที่มันอาจกลับมา

หากคุณใช้ Kotlin จะสนับสนุนหมายเหตุประกอบความสามารถในการ null เหล่านี้ในคอมไพเลอร์และจะป้องกันไม่ให้คุณส่งผ่าน null ไปยังวิธีการ java ที่ต้องการอาร์กิวเมนต์ที่ไม่ใช่ค่า null เหตุการณ์แม้ว่าคำถามนี้มีการกำหนดเป้าหมายที่ Java แต่ฉันพูดถึงคุณลักษณะ Kotlin นี้เนื่องจากมีการกำหนดเป้าหมายเฉพาะที่คำอธิบายประกอบ Java เหล่านี้และคำถามคือ"มีวิธีที่จะทำให้คำอธิบายประกอบเหล่านี้มีการบังคับใช้อย่างเข้มงวดมากขึ้น และคุณลักษณะนี้จะให้คำอธิบายประกอบเหล่านี้มีผลบังคับใช้อย่างเคร่งครัดมากขึ้น

คลาส Java โดยใช้@NotNullหมายเหตุประกอบ

public class MyJavaClazz {
    public void foo(@NotNull String myString) {
        // will result in an NPE if myString is null
        myString.hashCode();
    }
}

คลาส Kotlin เรียกคลาส Java และส่งผ่านค่า null สำหรับอาร์กิวเมนต์ที่เพิ่มความคิดเห็นด้วย @NotNull

class MyKotlinClazz {
    fun foo() {
        MyJavaClazz().foo(null)
    }
}  

ข้อผิดพลาดของคอมไพเลอร์ Kotlin บังคับใช้@NotNullคำอธิบายประกอบ

Error:(5, 27) Kotlin: Null can not be a value of a non-null type String

ดู: http://kotlinlang.org/docs/reference/java-interop.html#nullability-annotations

ตั้งแต่ Java 8 คุณลักษณะใหม่ที่เป็นตัวเลือกที่คุณไม่ควรใช้ @Nullable หรือ @Notnull ในรหัสของคุณเองอีกต่อไป นำตัวอย่างด้านล่าง:

public void printValue(@Nullable myValue) {
    if (myValue != null) {
        System.out.print(myValue);
    } else {
        System.out.print("I dont have a value");
}

สามารถเขียนใหม่ด้วย:

public void printValue(Optional<String> myValue) {
    if (myValue.ifPresent) {
        System.out.print(myValue.get());
    } else {
        System.out.print("I dont have a value");
}

โดยใช้ตัวเลือกบังคับให้คุณตรวจสอบค่า Null ในรหัสด้านบนคุณสามารถเข้าถึงค่าได้โดยการเรียกใช้getเมธอด

ประโยชน์อีกประการหนึ่งคือการที่รับโค้ดอ่านได้มากขึ้น ด้วยการเพิ่ม Java 9 ifPresentOrElseฟังก์ชันอาจถูกเขียนเป็น:

public void printValue(Optional<String> myValue) {
    myValue.ifPresentOrElse(
        v -> System.out.print(v),
        () -> System.out.print("I dont have a value"),
    )
}