Używanie NotNull Annotation w argumencie metody

Właśnie zacząłem używać @NotNulladnotacji w Javie 8 i otrzymałem nieoczekiwane wyniki.

Mam taką metodę:

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

Napisałem test JUnit przekazujący wartość null dla argumentu searchList. Spodziewałem się jakiegoś błędu, ale wyglądało to tak, jakby nie było adnotacji. Czy to oczekiwane zachowanie? Z tego, co zrozumiałem, miało to umożliwić pominięcie pisania standardowego kodu kontrolnego zerowego.

Bardzo mile widziane byłoby wyjaśnienie, co dokładnie ma robić @NotNull.

@Nullablei @NotNullnic nie robią samodzielnie. Mają pełnić rolę narzędzi dokumentacji.

@NullableAdnotacja przypomina o konieczności wprowadzenia sprawdzenie NPE gdy:

1. Wywołanie metod, które mogą zwracać null.
2. Wyłuskiwanie zmiennych (pola, zmienne lokalne, parametry), które mogą być zerowe.

@NotNullAdnotacja jest, faktycznie, wyraźna umowa oświadczając, co następuje:

1. Metoda nie powinna zwracać wartości null.
2. Zmienna (taka jak pola, zmienne lokalne i parametry) nie może mieć wartości null.

Na przykład zamiast pisać:

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

Możesz użyć:

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

Dodatkowo @NotNulljest często sprawdzany przez ConstraintValidators (np. Wiosną i hibernacją).

@NotNullAdnotacja nie robi żadnej walidacji na własną rękę, ponieważ definicja adnotacja nie dostarcza żadnych ConstraintValidatoroznaczenie typu.

Więcej informacji:

1. Walidacja fasoli
2. NotNull.java
3. Constraint.java
4. ConstraintValidator.java

Jak wspomniano powyżej, @NotNullsam nie robi nic. Dobrym sposobem na użycie @NotNullbyłoby użycie go zObjects.requireNonNull

public class Foo {
    private final Bar bar;

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

Aby być @NotNullaktywnym, potrzebujesz Lombok:

https://projectlombok.org/features/NonNull

import lombok.NonNull;

Śledź: Której adnotacji Java @NotNull mam użyć?

SO @NotNull jest tylko tagiem ... Jeśli chcesz go zweryfikować, musisz użyć czegoś takiego jak hibernacja walidatora jsr 303

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

Jeśli używasz Springa, możesz wymusić walidację, dodając do klasy adnotacje @Validated:

import org.springframework.validation.annotation.Validated;

Więcej informacji można znaleźć tutaj: Walidacja Javax Używanie adnotacji @NotNull

Robię to, aby utworzyć własną adnotację walidacyjną i walidator:

ValidCardType.java(adnotacja do umieszczenia na metodach / polach)

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

A walidator uruchamiający czek 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));
    }
}

Możesz zrobić coś bardzo podobnego, aby sprawdzić @NotNull.

Aby przetestować walidację metody w teście, musisz opakować ją jako proxy w metodę @Before.

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

Z MethodValidationProxyFactory jako:

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

}

A następnie dodaj swój test:

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

}