Использование аннотации NotNull в аргументе метода

Я только начал использовать @NotNullаннотацию с Java 8 и получил некоторые неожиданные результаты.

У меня есть такой метод:

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

Я написал тест JUnit, передав нулевое значение для аргумента searchList. Я ожидал, что произойдет какая-то ошибка, но она прошла, как будто аннотации не было. Это ожидаемое поведение? Из того, что я понял, это должно было позволить вам пропустить написание стандартного кода проверки на ноль.

Объяснение того, что именно должен делать @NotNull, будет с благодарностью.

@Nullableи @NotNullничего не делать самостоятельно. Они должны выступать в качестве инструментов документации.

@NullableАннотация напоминает вам о необходимости ввести проверку NPE , когда:

1. Вызов методов, которые могут вернуть ноль.
2. Разыменование переменных (полей, локальных переменных, параметров), которые могут быть нулевыми.

@NotNullАннотаций, собственно, явный контракт объявив следующее:

1. Метод не должен возвращать ноль.
2. Переменная (например, поля, локальные переменные и параметры) не может содержать нулевое значение.

Например, вместо того, чтобы писать:

/**
 * @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 следует использовать?

SO @NotNull - это просто тег ... Если вы хотите проверить его, вы должны использовать что-то вроде hibernate validator 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 validation @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));

}