Sử dụng chú thích NotNull trong đối số phương thức

Tôi mới bắt đầu sử dụng @NotNullchú thích với Java 8 và nhận được một số kết quả không mong muốn.

Tôi có một phương pháp như thế này:

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

Tôi đã viết một bài kiểm tra JUnit chuyển qua giá trị null cho đối số searchList. Tôi đã mong đợi một số loại lỗi xảy ra nhưng nó đã đi qua như thể chú thích không có ở đó. Đây có phải là hành vi dự kiến? Từ những gì tôi hiểu, điều này là để cho phép bạn bỏ qua việc viết mã kiểm tra null.

Một lời giải thích về chính xác những gì @NotNull được cho là sẽ được đánh giá cao.

@Nullablevà @NotNullkhông làm gì cả Chúng được cho là hoạt động như các công cụ Tài liệu.

Các @NullableChú nhắc nhở bạn về sự cần thiết để giới thiệu một kiểm tra NPE khi:

1. Phương thức gọi có thể trả về null.
2. Biến Dereferences (trường, biến cục bộ, tham số) có thể là null.

Các @NotNullchú giải là, trên thực tế, một hợp đồng rõ ràng tuyên bố sau đây:

1. Một phương thức không nên trả về null.
2. Một biến (như các trường, biến cục bộ và tham số) không thể giữ giá trị null.

Ví dụ: thay vì viết:

/**
 * @param aX should not be null
 */
public void setX(final Object aX ) {
    // some code
}

Bạn có thể dùng:

public void setX(@NotNull final Object aX ) {
    // some code
}

Ngoài ra, @NotNullthường được kiểm tra bởi ConstraintValidators (ví dụ: vào mùa xuân và ngủ đông).

Các @NotNullchú thích không làm bất cứ xác nhận ngày của riêng mình bởi vì định nghĩa chú thích không cung cấp bất kỳ ConstraintValidatortài liệu tham khảo loại.

Để biết thêm thông tin xem:

1. Xác nhận đậu
2. NotNull.java
3. Constraint.java
4. ConstraintValidator.java

Như đã đề cập ở trên @NotNullkhông có gì trên chính nó. Một cách tốt để sử dụng @NotNullsẽ là sử dụng nó vớiObjects.requireNonNull

public class Foo {
    private final Bar bar;

    public Foo(@NotNull Bar bar) {
        this.bar = Objects.requireNonNull(bar, "bar must not be null");
    }
}

Để @NotNullkích hoạt, bạn cần Lombok:

https://projectlombok.org/features/NonNull

import lombok.NonNull;

Thực hiện theo: Tôi nên sử dụng chú thích Java @NotNull nào?

SO @NotNull chỉ là một thẻ ... Nếu bạn muốn xác thực nó, thì bạn phải sử dụng một cái gì đó như trình xác nhận hibernate jsr 303

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

Nếu bạn đang sử dụng Spring, bạn có thể buộc xác thực bằng cách chú thích lớp với @Validated:

import org.springframework.validation.annotation.Validated;

Thông tin thêm có sẵn ở đây: Xác thực Javax @NotNull sử dụng chú thích

Tôi làm điều này để tạo chú thích và trình xác nhận hợp lệ của riêng tôi:

ValidCardType.java(chú thích để đặt trên các phương thức / trường)

@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 {};
}

Và, trình xác nhận để kích hoạt kiểm tra 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));
    }
}

Bạn có thể làm một cái gì đó rất giống để kiểm tra @NotNull.

Để kiểm tra xác thực phương thức của bạn trong một thử nghiệm, bạn phải bọc nó trong một phương thức @B Before.

@Before
public void setUp() {
    this.classAutowiredWithFindStuffMethod = MethodValidationProxyFactory.createProxy(this.classAutowiredWithFindStuffMethod);
}

Với Phương thứcValidationProxyFactory như:

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());
}

}

Và sau đó, thêm bài kiểm tra của bạn:

@Test
public void findingNullStuff() {
 assertThatExceptionOfType(ConstraintViolationException.class).isThrownBy(() -> this.classAutowiredWithFindStuffMethod.findStuff(null));

}