Використання NotNull Annotation в аргументі методу

Я тільки почав використовувати @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. Обмеження.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 - це просто тег ... Якщо ви хочете перевірити його, ви повинні використовувати щось на зразок сплячого валідатора 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));

}