javax.validation自定义日期范围校验注解操作
实际项目中经常需要对传入的日期时间进行判断，如是否为一年内，几个月之内，几天前，几天之内等等的需求。
如要求前端传入的日期是要为当前日期一年内的某个日期，基于jdk8的LocalDateTimeorLocalDate等常用的做法如下：
//前端传字符串如‘2020-07-1309:09:09'springmvc接收并转换为LocalDateTime类型 @JsonFormat(shape=JsonFormat.Shape.STRING,pattern="yyyy-MM-ddHH:mm:ss",timezone="GMT+8") privateLocalDateTimeendTime; LocalDateTimenow=LocalDateTime.now(); //jdk8校验传入日期是否为一年内 booleanflag=endTime.isBefore(now.plusYears(1))
基于上述的做法通常是比较通用的模式，如果每个日期时间都重复如此判断，略微繁琐，于是可以通过javax.validation的自定义校验注解来作用于实体属性上，借住hibernate-validate与springmvc结合来解决此类日期时间的范围校验。
DateTimeRange.java用于LocalDateTimeorString类型日期时间范围校验
/**
*日期时间范围校验注解，可作用于LocalDateTimeor字符串型年月日时分秒（格式可通过pattern属性指定）
*
*@authormeilin.huang
*@date2020-07-091:51下午
*/
@Target({ElementType.METHOD,ElementType.FIELD,ElementType.ANNOTATION_TYPE,ElementType.CONSTRUCTOR,ElementType.PARAMETER,ElementType.TYPE_USE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Constraint(validatedBy=DateTimeRange.DateTimeRangeValidator.class)
public@interfaceDateTimeRange{
/**
*最小时间范围（为负数即为前nunit）
*/
intmin()default0;
intmax()defaultInteger.MAX_VALUE;
/**
*时间单位(年月日)
*/
RangeUnitunit()defaultRangeUnit.DAYS;
/**
*作用于字符串时，指定的格式，包含年月日时分秒
*/
Stringpattern()default"yyyy-MM-ddHH:mm:ss";
/**
*是否忽略更小的单位，即比当前指定的unit更小的单位（如unit为Days，则忽略hours，minutes,second）
*/
booleanignoreLowerUnit()defaultfalse;
/**
*错误提示
*/
Stringmessage()default"日期时间错误";
/**
*用于分组校验
*/
Class[]groups()default{};
Class[]payload()default{};
classDateTimeRangeValidatorimplementsConstraintValidator{
privateDateTimeRangedateTimeRange;
@Override
publicvoidinitialize(DateTimeRangedateRange){
this.dateTimeRange=dateRange;
}
@Override
publicbooleanisValid(Objectvalue,ConstraintValidatorContextcontext){
if(value==null){
returntrue;
}
LocalDateTimeta=getByValue(value);
if(ta==null){
returnfalse;
}
RangeUnitunit=dateTimeRange.unit();
intmin=dateTimeRange.min();
intmax=dateTimeRange.max();
//忽略更小单位时，计算两个时间的单位差值比较即可
if(dateTimeRange.ignoreLowerUnit()){
longbetween=RangeUnit.getBetween(dateTimeRange.unit(),LocalDateTime.now(),ta);
returnbetween>=min&&between<=max;
}
LocalDateTimenow=LocalDateTime.now();
returnta.isAfter((ChronoLocalDateTime)RangeUnit.plus(now,unit,min))
&&ta.isBefore((ChronoLocalDateTime)RangeUnit.plus(now,unit,max));
}
privateLocalDateTimegetByValue(Objectvalue){
if(valueinstanceofLocalDateTime){
return(LocalDateTime)value;
}
if(valueinstanceofString){
try{
returnLocalDateTime.parse((String)value,DateTimeFormatter.ofPattern(dateTimeRange.pattern()));
}catch(Exceptione){
returnnull;
}
}
returnnull;
}
}
}
DateRange.java用于LocalDateorString类型日期范围校验
/**
*日期范围校验，作用于{@linkLocalDate}or字符串（年月日，格式可通过pattern属性指定，默认格式为:yyyy-MM-dd）
*
*@authormeilin.huang
*@date2020-07-085:15下午
*/
@Target({ElementType.METHOD,ElementType.FIELD,ElementType.ANNOTATION_TYPE,ElementType.CONSTRUCTOR,ElementType.PARAMETER,ElementType.TYPE_USE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Constraint(validatedBy=DateRange.DateRangeValidator.class)
public@interfaceDateRange{
/**
*最小时间范围（为负数即为前nunit）
*/
intmin()default0;
intmax()defaultInteger.MAX_VALUE;
/**
*时间单位(年月日)
*/
RangeUnitunit()defaultRangeUnit.DAYS;
/**
*作用于字符串时，指定的格式，只能包含年月日不包含时间
*/
Stringpattern()default"yyyy-MM-dd";
/**
*是否忽略更小的单位，即比当前指定的unit更小的单位（如unit为Month，则忽略Days）
*/
booleanignoreLowerUnit()defaultfalse;
/**
*错误提示
*/
Stringmessage()default"日期错误";
/**
*用于分组校验
*/
Class[]groups()default{};
Class[]payload()default{};
classDateRangeValidatorimplementsConstraintValidator{
privateDateRangedateRange;
@Override
publicvoidinitialize(DateRangedateRange){
this.dateRange=dateRange;
}
@Override
publicbooleanisValid(Objectvalue,ConstraintValidatorContextcontext){
if(value==null){
returntrue;
}
LocalDateta=getByValue(value);
if(ta==null){
returnfalse;
}
//忽略更小单位时，计算两个时间的单位差值比较即可
if(dateRange.ignoreLowerUnit()){
longbetween=RangeUnit.getBetween(dateRange.unit(),LocalDate.now(),ta);
returnbetween>=dateRange.min()&&between<=dateRange.max();
}
LocalDatenow=LocalDate.now();
RangeUnitunit=dateRange.unit();
ChronoLocalDatemin=(ChronoLocalDate)RangeUnit.plus(now,unit,dateRange.min());
ChronoLocalDatemax=(ChronoLocalDate)RangeUnit.plus(now,unit,dateRange.max());
return(ta.isAfter(min)||ta.isEqual(min))
&&(ta.isBefore(max)||ta.isEqual(max));
}
privateLocalDategetByValue(Objectvalue){
if(valueinstanceofLocalDate){
return(LocalDate)value;
}
if(valueinstanceofString){
try{
returnLocalDate.parse((String)value,DateTimeFormatter.ofPattern(dateRange.pattern()));
}catch(Exceptione){
returnnull;
}
}
if(valueinstanceofLocalDateTime){
return((LocalDateTime)value).toLocalDate();
}
returnnull;
}
}
}
RangeUnit.java范围单位枚举，用于以上两注解的unit属性
/**
*@authormeilin.huang
*@date2020-07-092:06下午
*/
publicenumRangeUnit{
/**
*年
*/
YEAR,
MONTH,
DAYS,
WEEKS,
HOURS,
MINUTES,
SECOND;
publicstaticTemporalplus(Temporaldate,RangeUnitunit,longvalue){
switch(unit){
caseDAYS:
returndate.plus(value,ChronoUnit.DAYS);
caseMONTH:
returndate.plus(value,ChronoUnit.MONTHS);
caseYEAR:
returndate.plus(value,ChronoUnit.YEARS);
caseWEEKS:
returndate.plus(value,ChronoUnit.WEEKS);
caseHOURS:
returndate.plus(value,ChronoUnit.HOURS);
caseMINUTES:
returndate.plus(value,ChronoUnit.MINUTES);
caseSECOND:
returndate.plus(value,ChronoUnit.SECONDS);
default:
returndate;
}
}
publicstaticlonggetBetween(RangeUnitunit,Temporaldate,Temporaldate2){
switch(unit){
caseDAYS:
returnChronoUnit.DAYS.between(date,date2);
caseMONTH:
returnChronoUnit.MONTHS.between(date,date2);
caseYEAR:
returnChronoUnit.YEARS.between(date,date2);
caseWEEKS:
returnChronoUnit.WEEKS.between(date,date2);
caseHOURS:
returnChronoUnit.HOURS.between(date,date2);
caseMINUTES:
returnChronoUnit.MINUTES.between(date,date2);
caseSECOND:
returnChronoUnit.SECONDS.between(date,date2);
default:
return0;
}
}
}
测试类
publicclassValidatorUtilsTestextendsTestCase{
publicstaticclassUser{
/**
*createTime必须在当前日期的前一个月以及后一个月访问内，忽略day的比较
*即计算当前时间与传入createTime的月份差是否在最小与最大值范围内
*/
@DateRange(min=-1,max=1,unit=RangeUnit.MONTH,ignoreLowerUnit=true,message="createTime范围错误")
StringcreateTime="2020-06-09";
/**
*date必须为当前日期时间的后一个月至后两月内
*/
@DateTimeRange(min=1,max=2,unit=RangeUnit.MONTH,message="date范围错误")
Stringdate="2020-08-1509:18:00";
@DateTimeRange(min=10,max=30,message="endTime日期范围错误")
LocalDateTimeendTime=LocalDateTime.now().plusDays(30);
}
@Test
publicvoidtestValidate(){
ValidationResultvalidate=ValidatorUtils.validate(newUser());
System.out.println(validate);
}
}
通过注解的方式对参数的日期时间属性进行范围校验，可以简化代码，去除冗余重复繁琐的代码，舒服不是一点点。当然以上是基于jdk8的localdatetime和localdate实现，如需要对Date类型范围校验，稍作修改即可。
更多方便有趣的代码可以前往个人业余总结以及练手项目中获取哈https://gitee.com/objs/mayfly
以上这篇javax.validation自定义日期范围校验注解操作就是小编分享给大家的全部内容了，希望能给大家一个参考，也希望大家多多支持毛票票。