快捷導(dǎo)航

javax.validation自定義日期范圍校驗(yàn)注解操作

更新時(shí)間：2020年09月23日 14:50:36 作者：不良人_

這篇文章主要介紹了javax.validation自定義日期范圍校驗(yàn)注解操作，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧

實(shí)際項(xiàng)目中經(jīng)常需要對(duì)傳入的日期時(shí)間進(jìn)行判斷，如是否為一年內(nèi)，幾個(gè)月之內(nèi)，幾天前，幾天之內(nèi)等等的需求。

如要求前端傳入的日期是要為當(dāng)前日期一年內(nèi)的某個(gè)日期，基于jdk8的LocalDateTime or LocalDate等常用的做法如下：

 // 前端傳字符串如‘2020-07-13 09:09:09' springmvc接收并轉(zhuǎn)換為L(zhǎng)ocalDateTime類型
  @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
  private LocalDateTime endTime; 

 LocalDateTime now = LocalDateTime.now(); 
 // jdk8校驗(yàn)傳入日期是否為一年內(nèi)
 boolean flag = endTime.isBefore(now.plusYears(1))

基于上述的做法通常是比較通用的模式，如果每個(gè)日期時(shí)間都重復(fù)如此判斷，略微繁瑣，于是可以通過(guò)javax.validation的自定義校驗(yàn)注解來(lái)作用于實(shí)體屬性上，借住hibernate-validate與springmvc結(jié)合來(lái)解決此類日期時(shí)間的范圍校驗(yàn)。

DateTimeRange.java 用于LocalDateTime or String類型日期時(shí)間范圍校驗(yàn)

/**
 * 日期時(shí)間范圍校驗(yàn)注解，可作用于LocalDateTime or 字符串型年月日時(shí)分秒（格式可通過(guò)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 {

  /**
   * 最小時(shí)間范圍（為負(fù)數(shù)即為前n unit）
   */
  int min() default 0;

  int max() default Integer.MAX_VALUE;

  /**
   * 時(shí)間單位 (年月日)
   */
  RangeUnit unit() default RangeUnit.DAYS;

  /**
   * 作用于字符串時(shí)，指定的格式，包含年月日時(shí)分秒
   */
  String pattern() default "yyyy-MM-dd HH:mm:ss";

  /**
   * 是否忽略更小的單位，即比當(dāng)前指定的unit更小的單位（如unit為Days，則忽略hours，minutes, second）
   */
  boolean ignoreLowerUnit() default false;

  /**
   * 錯(cuò)誤提示
   */
  String message() default "日期時(shí)間錯(cuò)誤";

  /**
   * 用于分組校驗(yàn)
   */
  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();

      // 忽略更小單位時(shí)，計(jì)算兩個(gè)時(shí)間的單位差值比較即可
      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類型日期范圍校驗(yàn)

/**
 * 日期范圍校驗(yàn)，作用于 {@link LocalDate} or 字符串（年月日，格式可通過(guò)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 {

  /**
   * 最小時(shí)間范圍（為負(fù)數(shù)即為前n unit）
   */
  int min() default 0;

  int max() default Integer.MAX_VALUE;

  /**
   * 時(shí)間單位 (年月日)
   */
  RangeUnit unit() default RangeUnit.DAYS;

  /**
   * 作用于字符串時(shí)，指定的格式，只能包含年月日不包含時(shí)間
   */
  String pattern() default "yyyy-MM-dd";

  /**
   * 是否忽略更小的單位，即比當(dāng)前指定的unit更小的單位（如unit為Month，則忽略Days）
   */
  boolean ignoreLowerUnit() default false;

  /**
   * 錯(cuò)誤提示
   */
  String message() default "日期錯(cuò)誤";

  /**
   * 用于分組校驗(yàn)
   */
  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;
      }
      // 忽略更小單位時(shí)，計(jì)算兩個(gè)時(shí)間的單位差值比較即可
      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;
    }
  }
}

測(cè)試類

public class ValidatorUtilsTest extends TestCase {

  public static class User {

    /**
     * createTime必須在當(dāng)前日期的前一個(gè)月以及后一個(gè)月訪問(wèn)內(nèi)，忽略day的比較
     * 即計(jì)算當(dāng)前時(shí)間與傳入createTime的月份差是否在最小與最大值范圍內(nèi)
     */
    @DateRange(min = -1, max = 1, unit = RangeUnit.MONTH, ignoreLowerUnit = true, message = "createTime范圍錯(cuò)誤")
    String createTime = "2020-06-09";

    /**
     * date必須為當(dāng)前日期時(shí)間的后一個(gè)月至后兩月內(nèi)
     */
    @DateTimeRange(min = 1, max = 2, unit = RangeUnit.MONTH, message = "date范圍錯(cuò)誤")
    String date = "2020-08-15 09:18:00";

    @DateTimeRange(min = 10, max = 30, message = "endTime日期范圍錯(cuò)誤")
    LocalDateTime endTime = LocalDateTime.now().plusDays(30);
  }

  @Test
  public void testValidate() {
    ValidationResult validate = ValidatorUtils.validate(new User());
    System.out.println(validate);
  }
}

通過(guò)注解的方式對(duì)參數(shù)的日期時(shí)間屬性進(jìn)行范圍校驗(yàn)，可以簡(jiǎn)化代碼，去除冗余重復(fù)繁瑣的代碼，舒服不是一點(diǎn)點(diǎn)。當(dāng)然以上是基于jdk8的localdatetime和localdate實(shí)現(xiàn)，如需要對(duì)Date類型范圍校驗(yàn)，稍作修改即可。

更多方便有趣的代碼可以前往個(gè)人業(yè)余總結(jié)以及練手項(xiàng)目中獲取哈https://gitee.com/objs/mayfly

以上這篇javax.validation自定義日期范圍校驗(yàn)注解操作就是小編分享給大家的全部?jī)?nèi)容了，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。

您可能感興趣的文章: