该注释是用于验证日期的注解之一。它用于验证一个日期是否在当前时间之后,即验证日期是否是未来的时间。
@Future 注解可以用于验证 java.util.Date、java.util.Calendar、java.time.Instant、java.time.LocalDate、java.time.LocalDateTime 和它们的包装类是否表示未来的时间。
注意:null 字段被认为是有效的。源码如下:
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER }) @Retention(RUNTIME) @Documented @Constraint(validatedBy = { }) public @interface Future { String message() default "{javax.validation.constraints.Future.message}"; Class<?>[] groups() default { }; Class<? extends Payload>[] payload() default { }; // 在同一元素上定义多个 @Future 注解。 @Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER }) @Retention(RUNTIME) @Documented @interface List { Future[] value(); } }
注意:message、groups、payload 属性用法参考 @NotNull 注解。
示例:
package com.hxstrive.validation; import lombok.Builder; import lombok.Data; import org.hibernate.validator.HibernateValidator; import javax.validation.ConstraintViolation; import javax.validation.Validation; import javax.validation.Validator; import javax.validation.constraints.Future; import java.util.Date; import java.util.Set; /** * 验证 Date 和 Calendar 对象是否在当前时间之后 * @author hxstrive.com */ @Data @Builder public class FutureDemo { @Future(message = "日期必须在当前之后") private Date date; public static void main(String[] args) { long current = System.currentTimeMillis(); FutureDemo.builder().date(null).build().validator("case1"); // OK FutureDemo.builder().date(new Date(current)).build().validator("case2"); // Fail FutureDemo.builder().date(new Date(current - 1000)).build().validator("case3"); // Fail FutureDemo.builder().date(new Date(current + 1000)).build().validator("case4"); // OK } private void validator(String caseName) { validator(caseName, this); } private <T> void validator(String caseName, T obj) { // 手动调用 API 对定义了注解的字段进行校验 Validator validator = Validation.byProvider(HibernateValidator.class).configure() .failFast(true).buildValidatorFactory().getValidator(); Set<ConstraintViolation<T>> set = validator.validate(obj); if (set.size() > 0) { // 校验失败 System.out.println(caseName + " :: Fail :: " + set.iterator().next().getMessage()); } else { // 校验通过 System.out.println(caseName + " :: Succeed"); } } }
运行示例,输出如下:
case1 :: Succeed case2 :: Fail :: 日期必须在当前之后 case3 :: Fail :: 日期必须在当前之后 case4 :: Succeed