Статьи

Пользовательские ограничения проверки компонентов JSR 303 для API новой даты / времени JSR 310

Февраль 20, 2019

С JSR 310 Java 8 наконец-то принесла нам достойный API даты и времени. Для тех из вас, кто все еще использует Java 7, как, например, в моем текущем проекте, имеется отличный бэкпорт, более подробную информацию можно найти на сайте www.threeten.org . Однако я не буду вдаваться в подробности использования нового API, так как на эту тему уже есть тонна постов в блоге. В этой статье я покажу вам, как вы можете использовать API даты / времени в сочетании с API проверки компонентов JSR 303, написав свои собственные пользовательские аннотации.

Если вы используете как проверку бина, так и новый API даты / времени, вы, вероятно, захотите использовать их вместе. API и такая реализация, как Hibernate Validator, предоставляют лишь несколько ограничений, например NotEmpty или @Pattern . Однако на данный момент нет никаких готовых ограничений для JSR 310. К счастью, очень легко создать свои собственные ограничения. В качестве примера я продемонстрирую, как вы можете написать собственную аннотацию @Past для проверки полей java.time.LocalDate .

В целях тестирования мы начнем с очень простого класса, который содержит дату и дату и время. Эти поля должны представлять даты в прошлом. Поэтому они @Past аннотацией @Past:

ClassWithPastDates

01
02
03
04
05
06
07
08
09
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
package it.jdev.example.jsr310.validator;
 
import java.time.LocalDate;
import java.time.LocalDateTime;
 
public class ClassWithPastDates {
 
    @Past
    private LocalDate date;
 
    @Past
    private LocalDateTime dateTime;
     
    public LocalDate getDate() {
        return date;
    }
     
    public void setDate(LocalDate date) {
        this.date = date;
    }
    public LocalDateTime getDateTime() {
        return dateTime;
    }
     
    public void setDateTime(LocalDateTime dateTime) {
        this.dateTime = dateTime;
    }
 
}

Далее мы напишем очень простой модульный тест для ограничения @Past который демонстрирует наши намерения: очевидно, что помимо дат, которые ушли в прошлое, мы также хотим, чтобы нулевая ссылка была действительной, но даты в будущем были недействительными, и даже сегодня должен считаться недействительным.

PastTest

01
02
03
04
05
06
07
08
09
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
package it.jdev.example.jsr310.validator;
 
import static org.junit.Assert.assertEquals;
 
import java.time.LocalDate;
import java.time.LocalDateTime;
import java.util.Set;
 
import javax.validation.ConstraintViolation;
import javax.validation.Validation;
import javax.validation.Validator;
import javax.validation.ValidatorFactory;
 
import org.junit.Before;
import org.junit.Test;
 
public class PastTest {
     
    private ClassWithPastDates classUnderTest;
 
    @Before
    public void setup() {
        classUnderTest = new ClassWithPastDates();
    }
 
    @Test
    public void thatNullIsValid() {
        Set<ConstraintViolation<ClassWithPastDates>> violations = validateClass(classUnderTest);
        assertEquals(violations.size(), 0);
    }
 
    @Test
    public void thatYesterdayIsValid() throws Exception {
        classUnderTest.setDate(LocalDate.now().minusDays(1));
        classUnderTest.setDateTime(LocalDateTime.now().minusDays(1));
        Set<ConstraintViolation<ClassWithPastDates>> violations = validateClass(classUnderTest);
        assertEquals(violations.size(), 0);
    }
 
    @Test
    public void thatTodayIsInvalid() throws Exception {
        classUnderTest.setDate(LocalDate.now());
        classUnderTest.setDateTime(LocalDateTime.now());
        Set<ConstraintViolation<ClassWithPastDates>> violations = validateClass(classUnderTest);
        assertEquals(violations.size(), 2);
    }
 
    @Test
    public void thatTomorrowIsInvalid() throws Exception {
        classUnderTest.setDate(LocalDate.now().plusDays(1));
        classUnderTest.setDateTime(LocalDateTime.now().plusDays(1));
        Set<ConstraintViolation<ClassWithPastDates>> violations = validateClass(classUnderTest);
        assertEquals(violations.size(), 2);
    }
 
    private Set<ConstraintViolation<ClassWithPastDates>> validateClass(ClassWithPastDates myClass) {
        ValidatorFactory factory = Validation.buildDefaultValidatorFactory();
        Validator validator = factory.getValidator();
        Set<ConstraintViolation<ClassWithPastDates>> violations = validator.validate(myClass);
        return violations;
    }
 
}

Теперь, когда мы настроили базовый тест, мы можем реализовать само ограничение. Это состоит из двух шагов. Сначала нам нужно написать аннотацию, а затем мы должны реализовать ConstraintValidator . Для начала с аннотацией:

@interface Past

01
02
03
04
05
06
07
08
09
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
package it.jdev.example.jsr310.validator;
 
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
 
import javax.validation.Constraint;
import javax.validation.Payload;
 
@Target({ ElementType.FIELD })
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = PastValidator.class)
@Documented
public @interface Past {
 
    String message() default "it.jdev.example.jsr310.validator.Past.message";
 
    Class<?>[] groups() default {};
 
    Class<? extends Payload>[] payload() default {};
 
}

Как видите, аннотация @Past не очень впечатляет. Главное, на что нужно обратить внимание, это аннотации @Constraint где мы указываем, какой класс будет использоваться для выполнения фактической проверки.

PastValidator

01
02
03
04
05
06
07
08
09
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
package it.jdev.example.jsr310.validator;
 
import java.time.LocalDate;
import java.time.temporal.Temporal;
 
import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
 
public class PastValidator implements ConstraintValidator<Past, Temporal> {
 
    @Override
    public void initialize(Past constraintAnnotation) {
    }
 
    @Override
    public boolean isValid(Temporal value, ConstraintValidatorContext context) {
        if (value == null) {
            return true;
        }
        LocalDate ld = LocalDate.from(value);
        if (ld.isBefore(LocalDate.now())) {
            return true;
        }
        return false;
    }
 
}

PastValidator — это место, где происходит вся магия. ConstraintValidator интерфейс ConstraintValidator мы обязаны предоставить два метода, но для нашего примера используется только метод isValid (), именно здесь мы будем выполнять фактическую проверку.

Обратите внимание, что мы использовали java.time.temporal.Temporal в качестве типа, потому что это интерфейс, который объединяет классы LocalDate и LocalDateTime. Это позволяет нам использовать один и тот же @Past для полей LocalDate и LocalDateTime.

И это действительно все, что нужно сделать. На этом очень простом примере я показал, как легко создать собственное ограничение проверки bean-компонента JSR 303.

Ссылка: Пользовательские ограничения JSR 303 Bean Validation для JSR 310 New Date / Time API от нашего партнера JCG Вима ван Хаарена из блога JDev .
66
Share: