メソッド引数でのNotNullアノテーションの使用

私はちょうど使い始めました @NotNullJava 8でアノテーションを予期しない結果が得られました。

私はこのような方法を持っています：

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

引数searchListのnull値を渡すJUnitテストを作成しました。なんらかのエラーが発生することを予期していましたが、アノテーションが存在しないかのようにエラーが発生しました。これは予想される動作ですか？私が理解したところ、これはボイラープレートのnullチェックコードの記述をスキップできるようにするためです。

@NotNullが正確に何をすることになっているのかについての説明をいただければ幸いです。

@Nullableそして、@NotNull自分では何もしません。それらはドキュメンテーションツールとして機能することになっています。

@Nullable注釈は、NPEチェックを導入する必要性について、あなたを思い出させます：

1. nullを返すことができるメソッドの呼び出し。
2. nullの可能性がある変数（フィールド、ローカル変数、パラメーター）の逆参照。

@NotNull注釈は、実際には、以下のことを宣言し、明示的な契約です。

1. メソッドはnullを返しません。
2. （フィールド、ローカル変数、およびパラメータのような）変数がないことができ ないはず null値を保持します。

たとえば、書く代わりに：

/**
 * @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アノテーションを使用すればよいですか？

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検証@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));
    }
}

checkとよく似たことができます@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));

}