在方法参数中使用NotNull注释

我刚刚开始在@NotNullJava 8中使用注释，并获得了一些意外的结果。

我有这样的方法：

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

我编写了一个JUnit测试，为参数searchList传递了空值。我原以为会发生某种类型的错误，但好像没有注释就通过了。这是预期的行为吗？据我了解，这是允许您跳过编写样板为空的检查代码。

对于@NotNull应该做什么的解释将不胜感激。

@Nullable和@NotNull自己做什么。它们应该充当文档工具。

该@Nullable注释提醒您在以下情况下必须进行NPE检查：

1. 可以返回null的调用方法。
2. 解引用可以为空的变量（字段，局部变量，参数）。

该@NotNull注释是，实际上，在声明下面的一个明确的合同：

1. 方法不应返回null。
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. Bean验证
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注释？

所以@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));

}