在方法参数中使用 NotNull 注解

Question

我刚开始在 Java 8 中使用 @NotNull 注释并得到了一些意想不到的结果。

我有这样的方法：

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

我编写了一个 JUnit 测试，为参数 searchList 传递了空值。我期待会发生某种类型的错误，但它就像注释不存在一样。这是预期的行为吗？据我了解，这是为了让您跳过编写样板空检查代码。

非常感谢您解释 @NotNull 究竟应该做什么。

Answer 1

要激活@NonNull，您需要 Lombok：

https://projectlombok.org/features/NonNull

import lombok.NonNull;

关注：Which @NotNull Java annotation should I use?

Answer 2

如果您使用的是 Spring，您可以通过使用 @Validated 注释类来强制验证：

import org.springframework.validation.annotation.Validated;

更多信息在这里： Javax @NotNull annotation usage

你也可以使用projectlombok中的@NonNull (lombok.NonNull)

Answer 3

I resolved it with

@JsonSetter(nulls = Nulls.AS_EMPTY)
@NotBlank
public String myString;

Request Json:
{
  myString=null
}
 Response:
 error must not be blank

Answer 4

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

@Nullable 注解提醒您在以下情况下引入 NPE 检查的必要性：

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

@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 检查（例如在 spring 和 hibernate 中）。

@NotNull 注释本身不进行任何验证，因为 annotation definition 不提供任何 ConstraintValidator 类型引用。

更多信息见：

1. Bean validation
2. NotNull.java
3. Constraint.java
4. ConstraintValidator.java

Answer 5

我这样做是为了创建自己的验证注解和验证器：

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。

Answer 6

要在测试中测试您的方法验证，您必须在 @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));

}

Answer 7

如上所述，@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");
    }
}

Answer 8

所以 @NotNull 只是一个标签...如果你想验证它，那么你必须使用类似 hibernate validator jsr 303 的东西

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