该注释是用于验证日期的注解之一。它用于验证一个日期是否在当前时间之前,即验证日期是否是过去的时间。
@Past 注解可以用于验证 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 Past {
String message() default "{javax.validation.constraints.Past.message}";
Class<?>[] groups() default { };
Class<? extends Payload>[] payload() default { };
// 在同一元素上定义多个 @Past 注解。
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER })
@Retention(RUNTIME)
@Documented
@interface List {
Past[] 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.Past;
import java.util.Date;
import java.util.Set;
/**
* 验证 Date 和 Calendar 对象是否在当前时间之前
* @author hxstrive.com
*/
@Data
@Builder
public class PastDemo {
@Past(message = "日期必须在当前之前")
private Date date;
public static void main(String[] args) {
long current = System.currentTimeMillis();
PastDemo.builder().date(null).build().validator("case1"); // OK
PastDemo.builder().date(new Date(current)).build().validator("case2"); // OK
PastDemo.builder().date(new Date(current - 1000)).build().validator("case3"); // OK
PastDemo.builder().date(new Date(current + 1000)).build().validator("case4"); // Fail
}
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 :: Succeed case3 :: Succeed case4 :: Fail :: 日期必须在当前之前