javax.validation自定義日期范圍校驗注解操作
更新時間：2020年09月23日 14:50:36 作者：不良人_
這篇文章主要介紹了javax.validation自定義日期范圍校驗注解操作，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧
實際項目中經(jīng)常需要對傳入的日期時間進行判斷，如是否為一年內(nèi)，幾個月之內(nèi)，幾天前，幾天之內(nèi)等等的需求。
如要求前端傳入的日期是要為當(dāng)前日期一年內(nèi)的某個日期，基于jdk8的LocalDateTime or LocalDate等常用的做法如下：
// 前端傳字符串如‘2020-07-13 09:09:09' springmvc接收并轉(zhuǎn)換為LocalDateTime類型 @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8") private LocalDateTime endTime; LocalDateTime now = LocalDateTime.now(); // jdk8校驗傳入日期是否為一年內(nèi) boolean flag = endTime.isBefore(now.plusYears(1))
基于上述的做法通常是比較通用的模式，如果每個日期時間都重復(fù)如此判斷，略微繁瑣，于是可以通過javax.validation的自定義校驗注解來作用于實體屬性上，借住hibernate-validate與springmvc結(jié)合來解決此類日期時間的范圍校驗。
DateTimeRange.java 用于LocalDateTime or String類型日期時間范圍校驗
/**
* 日期時間范圍校驗注解，可作用于LocalDateTime or 字符串型年月日時分秒（格式可通過pattern屬性指定）
*
* @author meilin.huang
* @date 2020-07-09 1: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 @interface DateTimeRange {
/**
* 最小時間范圍（為負(fù)數(shù)即為前n unit）
*/
int min() default 0;
int max() default Integer.MAX_VALUE;
/**
* 時間單位 (年月日)
*/
RangeUnit unit() default RangeUnit.DAYS;
/**
* 作用于字符串時，指定的格式，包含年月日時分秒
*/
String pattern() default "yyyy-MM-dd HH:mm:ss";
/**
* 是否忽略更小的單位，即比當(dāng)前指定的unit更小的單位（如unit為Days，則忽略hours，minutes, second）
*/
boolean ignoreLowerUnit() default false;
/**
* 錯誤提示
*/
String message() default "日期時間錯誤";
/**
* 用于分組校驗
*/
Class<?>[] groups() default {};
Class<? extends Payload>[] payload() default {};
class DateTimeRangeValidator implements ConstraintValidator<DateTimeRange, Object> {
private DateTimeRange dateTimeRange;
@Override
public void initialize(DateTimeRange dateRange) {
this.dateTimeRange = dateRange;
}
@Override
public boolean isValid(Object value, ConstraintValidatorContext context) {
if (value == null) {
return true;
}
LocalDateTime ta = getByValue(value);
if (ta == null) {
return false;
}
RangeUnit unit = dateTimeRange.unit();
int min = dateTimeRange.min();
int max = dateTimeRange.max();
// 忽略更小單位時，計算兩個時間的單位差值比較即可
if (dateTimeRange.ignoreLowerUnit()) {
long between = RangeUnit.getBetween(dateTimeRange.unit(), LocalDateTime.now(), ta);
return between >= min && between <= max;
}
LocalDateTime now = LocalDateTime.now();
return ta.isAfter((ChronoLocalDateTime<?>) RangeUnit.plus(now, unit, min))
&& ta.isBefore((ChronoLocalDateTime<?>) RangeUnit.plus(now, unit, max));
}
private LocalDateTime getByValue(Object value) {
if (value instanceof LocalDateTime) {
return (LocalDateTime) value;
}
if (value instanceof String) {
try {
return LocalDateTime.parse((String) value, DateTimeFormatter.ofPattern(dateTimeRange.pattern()));
} catch (Exception e) {
return null;
}
}
return null;
}
}
}
DateRange.java 用于LocalDate or String類型日期范圍校驗
/**
* 日期范圍校驗，作用于 {@link LocalDate} or 字符串（年月日，格式可通過pattern屬性指定，默認(rèn)格式為: yyyy-MM-dd）
*
* @author meilin.huang
* @date 2020-07-08 5: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 @interface DateRange {
/**
* 最小時間范圍（為負(fù)數(shù)即為前n unit）
*/
int min() default 0;
int max() default Integer.MAX_VALUE;
/**
* 時間單位 (年月日)
*/
RangeUnit unit() default RangeUnit.DAYS;
/**
* 作用于字符串時，指定的格式，只能包含年月日不包含時間
*/
String pattern() default "yyyy-MM-dd";
/**
* 是否忽略更小的單位，即比當(dāng)前指定的unit更小的單位（如unit為Month，則忽略Days）
*/
boolean ignoreLowerUnit() default false;
/**
* 錯誤提示
*/
String message() default "日期錯誤";
/**
* 用于分組校驗
*/
Class<?>[] groups() default {};
Class<? extends Payload>[] payload() default {};
class DateRangeValidator implements ConstraintValidator<DateRange, Object> {
private DateRange dateRange;
@Override
public void initialize(DateRange dateRange) {
this.dateRange = dateRange;
}
@Override
public boolean isValid(Object value, ConstraintValidatorContext context) {
if (value == null) {
return true;
}
LocalDate ta = getByValue(value);
if (ta == null) {
return false;
}
// 忽略更小單位時，計算兩個時間的單位差值比較即可
if (dateRange.ignoreLowerUnit()) {
long between = RangeUnit.getBetween(dateRange.unit(), LocalDate.now(), ta);
return between >= dateRange.min() && between <= dateRange.max();
}
LocalDate now = LocalDate.now();
RangeUnit unit = dateRange.unit();
ChronoLocalDate min = (ChronoLocalDate) RangeUnit.plus(now, unit, dateRange.min());
ChronoLocalDate max = (ChronoLocalDate) RangeUnit.plus(now, unit, dateRange.max());
return (ta.isAfter(min) || ta.isEqual(min))
&& (ta.isBefore(max) || ta.isEqual(max));
}
private LocalDate getByValue(Object value) {
if (value instanceof LocalDate) {
return (LocalDate) value;
}
if (value instanceof String) {
try {
return LocalDate.parse((String) value, DateTimeFormatter.ofPattern(dateRange.pattern()));
} catch (Exception e) {
return null;
}
}
if (value instanceof LocalDateTime) {
return ((LocalDateTime) value).toLocalDate();
}
return null;
}
}
}
RangeUnit.java 范圍單位枚舉，用于以上兩注解的unit屬性
/**
* @author meilin.huang
* @date 2020-07-09 2:06 下午
*/
public enum RangeUnit {
/**
* 年
*/
YEAR,
MONTH,
DAYS,
WEEKS,
HOURS,
MINUTES,
SECOND;
public static Temporal plus(Temporal date, RangeUnit unit, long value) {
switch (unit) {
case DAYS:
return date.plus(value, ChronoUnit.DAYS);
case MONTH:
return date.plus(value, ChronoUnit.MONTHS);
case YEAR:
return date.plus(value, ChronoUnit.YEARS);
case WEEKS:
return date.plus(value, ChronoUnit.WEEKS);
case HOURS:
return date.plus(value, ChronoUnit.HOURS);
case MINUTES:
return date.plus(value, ChronoUnit.MINUTES);
case SECOND:
return date.plus(value, ChronoUnit.SECONDS);
default:
return date;
}
}
public static long getBetween(RangeUnit unit, Temporal date, Temporal date2) {
switch (unit) {
case DAYS:
return ChronoUnit.DAYS.between(date, date2);
case MONTH:
return ChronoUnit.MONTHS.between(date, date2);
case YEAR:
return ChronoUnit.YEARS.between(date, date2);
case WEEKS:
return ChronoUnit.WEEKS.between(date, date2);
case HOURS:
return ChronoUnit.HOURS.between(date, date2);
case MINUTES:
return ChronoUnit.MINUTES.between(date, date2);
case SECOND:
return ChronoUnit.SECONDS.between(date, date2);
default:
return 0;
}
}
}
測試類
public class ValidatorUtilsTest extends TestCase {
public static class User {
/**
* createTime必須在當(dāng)前日期的前一個月以及后一個月訪問內(nèi)，忽略day的比較
* 即計算當(dāng)前時間與傳入createTime的月份差是否在最小與最大值范圍內(nèi)
*/
@DateRange(min = -1, max = 1, unit = RangeUnit.MONTH, ignoreLowerUnit = true, message = "createTime范圍錯誤")
String createTime = "2020-06-09";
/**
* date必須為當(dāng)前日期時間的后一個月至后兩月內(nèi)
*/
@DateTimeRange(min = 1, max = 2, unit = RangeUnit.MONTH, message = "date范圍錯誤")
String date = "2020-08-15 09:18:00";
@DateTimeRange(min = 10, max = 30, message = "endTime日期范圍錯誤")
LocalDateTime endTime = LocalDateTime.now().plusDays(30);
}
@Test
public void testValidate() {
ValidationResult validate = ValidatorUtils.validate(new User());
System.out.println(validate);
}
}
通過注解的方式對參數(shù)的日期時間屬性進行范圍校驗，可以簡化代碼，去除冗余重復(fù)繁瑣的代碼，舒服不是一點點。當(dāng)然以上是基于jdk8的localdatetime和localdate實現(xiàn)，如需要對Date類型范圍校驗，稍作修改即可。
更多方便有趣的代碼可以前往個人業(yè)余總結(jié)以及練手項目中獲取哈https://gitee.com/objs/mayfly
以上這篇javax.validation自定義日期范圍校驗注解操作就是小編分享給大家的全部內(nèi)容了，希望能給大家一個參考，也希望大家多多支持腳本之家。
相關(guān)文章
這篇文章主要為大家詳細(xì)介紹了java實現(xiàn)dijkstra最短路徑尋路算法，具有一定的參考價值，感興趣的小伙伴們可以參考一下2019-01-01
MyBatis 添加元數(shù)據(jù)自定義元素標(biāo)簽的實現(xiàn)代碼
這篇文章主要介紹了MyBatis 添加元數(shù)據(jù)自定義元素標(biāo)簽的實現(xiàn)代碼，本文通過實例代碼給大家介紹的非常詳細(xì)，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值,需要的朋友可以參考下2020-07-07
mybatis-plus 如何判斷參數(shù)是否為空并作為查詢條件
這篇文章主要介紹了mybatis-plus 如何判斷參數(shù)是否為空并作為查詢條件，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2022-03-03
本文主要介紹了SpringBoot中5種高大上的yml文件讀取方式，總結(jié)一下除了@Value和@ConfigurationProperties外，還能夠通過哪些方式，來讀取yml配置文件的內(nèi)容，感興趣的可以了解一下2022-03-03
SpringBoot項目中建議關(guān)閉Open-EntityManager-in-view原因
這篇文章主要為大家解析了在Spring Boot項目中建議關(guān)閉Open-EntityManager-in-view的原因示例分析，有需要的朋友可以借鑒參考下，希望能夠有所幫助2022-02-02
Mybatis-plus常見的坑@TableField不生效問題
這篇文章主要介紹了Mybatis-plus常見的坑@TableField不生效問題，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2022-01-01
這篇文章詳細(xì)給大家介紹了Java數(shù)組的排序算法與二分查找法，文中有詳細(xì)的代碼示例，對大家的學(xué)習(xí)或工作有一定的幫助,需要的朋友可以參考下2023-05-05
SpringBoot基礎(chǔ)教程之集成郵件服務(wù)
這篇文章主要給大家介紹了關(guān)于SpringBoot基礎(chǔ)教程之集成郵件服務(wù)的相關(guān)資料，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者使用SpringBoot具有一定的參考學(xué)習(xí)價值，需要的朋友們下面來一起學(xué)習(xí)學(xué)習(xí)吧2020-07-07
這篇文章主要介紹了IDEA GIT 忽略文件的最佳方式推薦，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2021-01-01
Java快速實現(xiàn)PDF轉(zhuǎn)圖片功能實例代碼
PDFBox是一個開源Java類庫,用于讀取和創(chuàng)建PDF文檔,它支持文本提取、表單處理、文檔加密解密、合并分割、內(nèi)容覆蓋追加、文檔打印和轉(zhuǎn)換等功能,文中通過代碼介紹的非常詳細(xì),需要的朋友可以參考下2024-09-09