Menggunakan NotNull Annotation dalam argumen metode

Saya baru saja mulai menggunakan @NotNullanotasi dengan Java 8 dan mendapatkan beberapa hasil yang tidak terduga.

Saya punya metode seperti ini:

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

Saya menulis tes JUnit yang meneruskan nilai nol untuk argumen searchingList. Saya mengharapkan beberapa jenis kesalahan terjadi tetapi itu berlalu seolah-olah penjelasan itu tidak ada. Apakah ini perilaku yang diharapkan? Dari apa yang saya mengerti, ini adalah untuk memungkinkan Anda melewati penulisan kode cek nol boilerplate.

Penjelasan tentang apa yang seharusnya dilakukan oleh @NotNull akan sangat dihargai.

@Nullabledan @NotNulltidak melakukan apa-apa sendiri. Mereka seharusnya bertindak sebagai alat Dokumentasi.

The @NullableAnotasi mengingatkan Anda tentang perlunya untuk memperkenalkan pemeriksaan NPE saat:

1. Metode panggilan yang dapat mengembalikan nol.
2. Variabel penereferensi (bidang, variabel lokal, parameter) yang dapat menjadi nol.

The @NotNullAnotasi adalah, sebenarnya, kontrak eksplisit menyatakan berikut ini:

1. Metode tidak boleh mengembalikan null.
2. Variabel (seperti bidang, variabel lokal, dan parameter) tidak boleh tidak memiliki nilai nol.

Misalnya, alih-alih menulis:

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

Kamu bisa memakai:

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

Selain itu, @NotNullsering diperiksa oleh ConstraintValidators (mis. Pada musim semi dan hibernasi).

The @NotNullpenjelasan tidak melakukan validasi setiap sendiri karena definisi penjelasan tidak menyediakan ConstraintValidatorreferensi jenis.

Untuk info lebih lanjut, lihat:

1. Validasi kacang
2. NotNull.java
3. Constraint.java
4. ConstraintValidator.java

Seperti disebutkan di atas @NotNulltidak melakukan apa-apa sendiri. Cara yang baik untuk menggunakannya @NotNulladalah menggunakannyaObjects.requireNonNull

public class Foo {
    private final Bar bar;

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

Untuk @NotNullmengaktifkan Anda membutuhkan Lombok:

https://projectlombok.org/features/NonNull

import lombok.NonNull;

Ikuti: Anotasi @NotNull Java manakah yang harus saya gunakan?

SO @NotNull hanyalah sebuah tag ... Jika Anda ingin memvalidasinya, maka Anda harus menggunakan sesuatu seperti hibernate validator jsr 303

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

Jika Anda menggunakan Spring, Anda bisa memaksakan validasi dengan memberi anotasi pada kelas dengan @Validated:

import org.springframework.validation.annotation.Validated;

Info lebih lanjut tersedia di sini: Validasi Javax @NotNull penggunaan anotasi

Saya melakukan ini untuk membuat anotasi dan validator validasi saya sendiri:

ValidCardType.java(penjelasan untuk memakai metode / bidang)

@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 {};
}

Dan, validator memicu cek 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));
    }
}

Anda dapat melakukan sesuatu yang sangat mirip untuk diperiksa @NotNull.

Untuk menguji validasi metode Anda dalam pengujian, Anda harus membungkusnya dengan proxy dalam metode @Before.

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

Dengan MethodValidationProxyFactory sebagai:

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());
}

}

Dan kemudian, tambahkan tes Anda:

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

}