Yöntem bağımsız değişkeninde NotNull Ek Açıklama'yı kullanma

@NotNullJava 8 ile ek açıklamayı kullanmaya ve beklenmedik sonuçlar elde etmeye başladım .

Ben böyle bir yöntem var:

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

SearchList argümanı için null değerinde geçen bir JUnit testi yazdım. Bir tür hatanın olmasını bekliyordum ama ek açıklama orada değilmiş gibi geçti. Bu beklenen davranış mı? Anladığım kadarıyla, bu, boş levha null kontrol kodunu yazmayı atlamanıza izin vermekti.

@NotNull'un tam olarak ne yapması gerektiğine dair bir açıklama çok takdir edilecektir.

@Nullableve @NotNullkendi başlarına hiçbir şey yapma. Dokümantasyon araçları gibi davranmaları gerekiyor.

@NullableEk Açıklama sırasında bir NPE çeki tanıtmak gerekliliği hakkında size hatırlatır:

1. Boş dönebilen çağrı yöntemleri.
2. Boş olabilen kayıttan çıkarma değişkenleri (alanlar, yerel değişkenler, parametreler).

@NotNullEk açıklama, aslında, aşağıdakileri bildirerek açık sözleşmedir:

1. Bir yöntem null döndürmemelidir.
2. (Alanların, yerel değişkenler ve parametreler gibi) Bir değişken olamaz olmamalı boş değer tutun.

Örneğin, yazmak yerine:

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

Kullanabilirsiniz:

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

Ayrıca, @NotNullgenellikle ConstraintValidators tarafından kontrol edilir (örneğin, ilkbahar ve hazırda bekletme modunda).

@NotNullÇünkü açıklama kendi başına herhangi doğrulama yapmaz açıklama tanım herhangi sağlamaz ConstraintValidatortip referansı.

Daha fazla bilgi için:

1. Fasulye validasyonu
2. NotNull.java
3. Constraint.java
4. ConstraintValidator.java

Yukarıda belirtildiği gibi @NotNulltek başına hiçbir şey yapmaz. Kullanmanın iyi bir yolu @NotNullile kullanmaya olurduObjects.requireNonNull

public class Foo {
    private final Bar bar;

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

@NotNullAktif hale getirmek için Lombok'a ihtiyacınız var:

https://projectlombok.org/features/NonNull

import lombok.NonNull;

İzleyin: Hangi @ NotNull Java ek açıklamasını kullanmalıyım?

SO @NotNull sadece bir etiket ... Eğer doğrulamak istiyorsanız, o zaman hazırda bekleme doğrulayıcısı jsr 303 gibi bir şey kullanmalısınız

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

Spring kullanıyorsanız, sınıfa aşağıdakilere açıklama ekleyerek doğrulamayı zorlayabilirsiniz @Validated:

import org.springframework.validation.annotation.Validated;

Daha fazla bilgiyi burada bulabilirsiniz: Javax validation @NotNull ek açıklama kullanımı

Kendi doğrulama notumu ve doğrulayıcıyı oluşturmak için bunu yapıyorum:

ValidCardType.java(yöntem / alan eklemek için ek açıklama)

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

Ve, kontrolü tetikleyen doğrulayıcı 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));
    }
}

Kontrol etmek için çok benzer bir şey yapabilirsiniz @NotNull.

Bir testte yöntem doğrulamanızı test etmek için, @Before yönteminde bir proxy'yi sarmanız gerekir.

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

MethodValidationProxyFactory ile şu şekilde:

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

}

Ardından, testinizi ekleyin:

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

}