การใช้ NotNull Annotation ในวิธีการโต้แย้ง

ฉันเพิ่งเริ่มใช้@NotNullคำอธิบายประกอบกับ Java 8 และรับผลลัพธ์ที่ไม่คาดคิด

ฉันมีวิธีการเช่นนี้:

public List<Found> findStuff(@NotNull List<Searching> searchingList) {
    ... code here ...
}

ฉันเขียนการทดสอบ JUnit ในค่า Null สำหรับอาร์กิวเมนต์ LookupList ฉันคาดหวังว่าจะเกิดข้อผิดพลาดบางประเภท แต่เกิดขึ้นราวกับว่าคำอธิบายประกอบไม่ได้อยู่ที่นั่น เป็นพฤติกรรมที่คาดหวังหรือไม่ จากสิ่งที่ฉันเข้าใจนี่คือเพื่อให้คุณข้ามการเขียนรหัสตรวจสอบ boilerplate null

คำอธิบายเกี่ยวกับสิ่งที่ @NotNull ที่ควรทำจะได้รับการชื่นชมอย่างมาก

@Nullableและ@NotNullไม่ทำอะไรเลยด้วยตนเอง พวกเขาควรจะทำหน้าที่เป็นเครื่องมือเอกสาร

@Nullableหมายเหตุแจ้งเตือนคุณเกี่ยวกับความจำเป็นที่จะแนะนำการตรวจสอบ NPE เมื่อ:

1. วิธีการโทรที่สามารถส่งคืน null
2. การยกเลิกการพิจารณาตัวแปร (ฟิลด์, ตัวแปรโลคัล, พารามิเตอร์) ที่สามารถเป็นค่าว่างได้

@NotNullหมายเหตุเป็นจริงสัญญาอย่างชัดเจนประกาศต่อไปนี้:

1. วิธีการไม่ควรกลับเป็นโมฆะ
2. ตัวแปร (เช่นเขตข้อมูลตัวแปรท้องถิ่นและพารามิเตอร์) ไม่สามารถ ไม่ควร ถือค่า null

ตัวอย่างเช่นแทนที่จะเขียน:

/**
 * @param aX should not be null
 */
public void setX(final Object aX ) {
    // some code
}

คุณสามารถใช้ได้:

public void setX(@NotNull final Object aX ) {
    // some code
}

นอกจาก@NotNullนี้มักมีการตรวจสอบโดยConstraintValidators (เช่นในฤดูใบไม้ผลิและไฮเบอร์เนต)

@NotNullคำอธิบายประกอบไม่ได้ทำการตรวจสอบใด ๆ ในตัวของมันเองเพราะนิยามคำอธิบายประกอบไม่ได้ให้การใด ๆConstraintValidatorอ้างอิงประเภท

สำหรับข้อมูลเพิ่มเติมดู:

1. การตรวจสอบถั่ว
2. NotNull.java
3. Constraint.java
4. ConstraintValidator.java

ดังที่ได้กล่าวมา@NotNullแล้วไม่มีอะไรในตัวมันเอง วิธีที่ดีในการใช้@NotNullคือใช้กับObjects.requireNonNull

public class Foo {
    private final Bar bar;

    public Foo(@NotNull Bar bar) {
        this.bar = Objects.requireNonNull(bar, "bar must not be null");
    }
}

ในการทำให้@NotNullคล่องแคล่วคุณต้องการลอมบอก:

https://projectlombok.org/features/NonNull

import lombok.NonNull;

ตาม: ฉันควรใช้คำอธิบายประกอบ @NotNull Java ใด

ดังนั้น @NotNull เพียงแค่เป็นแท็ก ... หากคุณต้องการตรวจสอบแล้วคุณต้องใช้สิ่งที่ต้องการตรวจสอบ hibernate jsr 303

ValidatorFactory validatorFactory = Validation.buildDefaultValidatorFactory();
Validator validator = validatorFactory.getValidator();
 Set<ConstraintViolation<List<Searching>> violations = validator.validate(searchingList);

หากคุณกำลังใช้ Spring คุณสามารถบังคับให้มีการตรวจสอบความถูกต้องโดยใส่คำอธิบายประกอบชั้นด้วย@Validated:

import org.springframework.validation.annotation.Validated;

มีข้อมูลเพิ่มเติมที่นี่: การตรวจสอบความถูกต้องของ Javax @NotNull การใช้คำอธิบายประกอบ

ฉันทำสิ่งนี้เพื่อสร้างคำอธิบายประกอบและการตรวจสอบความถูกต้องของตัวเอง:

ValidCardType.java(คำอธิบายประกอบเพื่อใส่วิธี / ฟิลด์)

@Constraint(validatedBy = {CardTypeValidator.class})
@Documented
@Target( { ElementType.ANNOTATION_TYPE, ElementType.METHOD, ElementType.FIELD })
@Retention(RetentionPolicy.RUNTIME)
public @interface ValidCardType {
    String message() default "Incorrect card type, should be among: \"MasterCard\" | \"Visa\"";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

และเครื่องมือตรวจสอบเพื่อทริกเกอร์การตรวจสอบ CardTypeValidator.java::

public class CardTypeValidator implements ConstraintValidator<ValidCardType, String> {
    private static final String[] ALL_CARD_TYPES = {"MasterCard", "Visa"};

    @Override
    public void initialize(ValidCardType status) {
    }
    public boolean isValid(String value, ConstraintValidatorContext context) {
        return (Arrays.asList(ALL_CARD_TYPES).contains(value));
    }
}

@NotNullคุณสามารถทำบางสิ่งบางอย่างที่คล้ายกันมากในการตรวจสอบ

ในการทดสอบการตรวจสอบความถูกต้องของวิธีการในการทดสอบคุณจะต้องห่อหุ้มพร็อกซีในวิธีการ @Before

@Before
public void setUp() {
    this.classAutowiredWithFindStuffMethod = MethodValidationProxyFactory.createProxy(this.classAutowiredWithFindStuffMethod);
}

ด้วย MethodValidationProxyFactory เป็น:

import org.springframework.context.support.StaticApplicationContext;
import org.springframework.validation.beanvalidation.MethodValidationPostProcessor;

public class MethodValidationProxyFactory {

private static final StaticApplicationContext ctx = new StaticApplicationContext();

static {
    MethodValidationPostProcessor processor = new MethodValidationPostProcessor();
    processor.afterPropertiesSet(); // init advisor
    ctx.getBeanFactory()
            .addBeanPostProcessor(processor);
}

@SuppressWarnings("unchecked")
public static <T> T createProxy(T instance) {

    return (T) ctx.getAutowireCapableBeanFactory()
            .applyBeanPostProcessorsAfterInitialization(instance, instance.getClass()
                    .getName());
}

}

จากนั้นเพิ่มการทดสอบของคุณ:

@Test
public void findingNullStuff() {
 assertThatExceptionOfType(ConstraintViolationException.class).isThrownBy(() -> this.classAutowiredWithFindStuffMethod.findStuff(null));

}