Разница между двумя датами в Java

1. Обзор

В этом кратком руководстве мы рассмотрим несколько возможностей вычисления разницы между двумя датами в Java.

2. Ядро Java

2.1. Использование java.util.Date для поиска разницы в днях

Давайте начнем с использования основных API-интерфейсов Java для расчета и определения количества дней между двумя датами:

@Test
public void givenTwoDatesBeforeJava8_whenDifferentiating_thenWeGetSix()
  throws ParseException {
 
    SimpleDateFormat sdf = new SimpleDateFormat("MM/dd/yyyy", Locale.ENGLISH);
    Date firstDate = sdf.parse("06/24/2017");
    Date secondDate = sdf.parse("06/30/2017");

    long diffInMillies = Math.abs(secondDate.getTime() - firstDate.getTime());
    long diff = TimeUnit.DAYS.convert(diffInMillies, TimeUnit.MILLISECONDS);

    assertEquals(6, diff);
}

2.2. Использование java.time.temporal.ChronoUnit для поиска различий

API времени в Java 8 представляет единицу измерения даты и времени, например, секунды или дни, используя интерфейс TemporalUnit .

Каждый модуль предоставляет реализацию метода с именем between для вычисления количества времени между двумя темпоральными объектами в терминах этого конкретного модуля.

Например, чтобы вычислить секунды между двумя LocalDateTime s:

@Test
public void givenTwoDateTimesInJava8_whenDifferentiatingInSeconds_thenWeGetTen() {
    LocalDateTime now = LocalDateTime.now();
    LocalDateTime tenSecondsLater = now.plusSeconds(10);

    long diff = ChronoUnit.SECONDS.between(now, tenSecondsLater);

    assertEquals(10, diff);
}

ChronoUnit предоставляет набор конкретных единиц времени путем реализации интерфейса TemporalUnit . Настоятельно рекомендуется статически импортировать значения перечисления ChronoUnit для лучшей читабельности `` :

import static java.time.temporal.ChronoUnit.SECONDS;

// omitted
long diff = SECONDS.between(now, tenSecondsLater);

Кроме того, мы можем передать в метод between любые два совместимых временных объекта , даже ZonedDateTime .

Что хорошего в ZonedDateTime , так это то, что расчет будет работать, даже если они установлены для разных часовых поясов:

@Test
public void givenTwoZonedDateTimesInJava8_whenDifferentiating_thenWeGetSix() {
    LocalDateTime ldt = LocalDateTime.now();
    ZonedDateTime now = ldt.atZone(ZoneId.of("America/Montreal"));
    ZonedDateTime sixMinutesBehind = now
      .withZoneSameInstant(ZoneId.of("Asia/Singapore"))
      .minusMinutes(6);
    
    long diff = ChronoUnit.MINUTES.between(sixMinutesBehind, now);
    
    assertEquals(6, diff);
}

2.3. Использование временного #until()

Любой объект Temporal , такой как LocalDate или ZonedDateTime , предоставляет метод until для расчета количества времени до следующего объекта Temporal с точки зрения указанной единицы измерения :

@Test
public void givenTwoDateTimesInJava8_whenDifferentiatingInSecondsUsingUntil_thenWeGetTen() {
    LocalDateTime now = LocalDateTime.now();
    LocalDateTime tenSecondsLater = now.plusSeconds(10);

    long diff = now.until(tenSecondsLater, ChronoUnit.SECONDS);

    assertEquals(10, diff);
}

Temporal #until и TemporalUnit#between — это два разных API для одной и той же функциональности.

2.4. Использование java.time.Duration и java.time.Period

В Java 8 Time API представил два новых класса: Duration и Period .

Если мы хотим вычислить разницу между двумя датами и временем в зависимости от времени (часы, минуты или секунды), мы можем использовать класс Duration :

@Test
public void givenTwoDateTimesInJava8_whenDifferentiating_thenWeGetSix() {
    LocalDateTime now = LocalDateTime.now();
    LocalDateTime sixMinutesBehind = now.minusMinutes(6);

    Duration duration = Duration.between(now, sixMinutesBehind);
    long diff = Math.abs(duration.toMinutes());

    assertEquals(6, diff);
}

Однако следует опасаться ловушки, если мы попытаемся использовать класс Period для представления разницы между двумя датами.

Пример быстро объяснит эту ловушку.

Давайте посчитаем, сколько дней между двумя датами, используя класс Period :

@Test
public void givenTwoDatesInJava8_whenUsingPeriodGetDays_thenWorks()  {
    LocalDate aDate = LocalDate.of(2020, 9, 11);
    LocalDate sixDaysBehind = aDate.minusDays(6);

    Period period = Period.between(aDate, sixDaysBehind);
    int diff = Math.abs(period.getDays());

    assertEquals(6, diff);
}

Если мы запустим тест выше, он пройдет. Мы можем подумать, что класс Period удобен для решения нашей проблемы. Все идет нормально.

Если этот способ работает с разницей в шесть дней, мы не сомневаемся, что он будет работать и в течение 60 дней.

Итак, давайте изменим 6 в тесте выше на 60 и посмотрим, что произойдет:

@Test
public void givenTwoDatesInJava8_whenUsingPeriodGetDays_thenDoesNotWork() {
    LocalDate aDate = LocalDate.of(2020, 9, 11);
    LocalDate sixtyDaysBehind = aDate.minusDays(60);

    Period period = Period.between(aDate, sixtyDaysBehind);
    int diff = Math.abs(period.getDays());

    assertEquals(60, diff);
}

Теперь, если мы снова запустим тест, мы увидим:

java.lang.AssertionError: 
Expected :60
Actual   :29

Ой! Почему класс Period сообщил о разнице в 29 дней?

Это связано с тем, что класс Period представляет количество времени, основанное на дате, в формате «x лет, y месяцев и z дней». Когда мы вызываем его метод getDays() , он возвращает только часть «z days».

Следовательно, объект периода в приведенном выше тесте содержит значение «0 лет, 1 месяц и 29 дней»:

@Test
public void givenTwoDatesInJava8_whenUsingPeriod_thenWeGet0Year1Month29Days() {
    LocalDate aDate = LocalDate.of(2020, 9, 11);
    LocalDate sixtyDaysBehind = aDate.minusDays(60);
    Period period = Period.between(aDate, sixtyDaysBehind);
    int years = Math.abs(period.getYears());
    int months = Math.abs(period.getMonths());
    int days = Math.abs(period.getDays());
    assertArrayEquals(new int[] { 0, 1, 29 }, new int[] { years, months, days });
}

Если мы хотим рассчитать разницу в днях с помощью API времени Java 8, метод ChronoUnit.DAYS.between() является наиболее простым способом.

3. Внешние библиотеки

3.1. ДжодаТайм

Мы также можем сделать относительно простую реализацию с JodaTime :

<dependency>
    <groupId>joda-time</groupId>
    <artifactId>joda-time</artifactId>
    <version>2.9.9</version>
</dependency>

Вы можете получить последнюю версию Joda-time от Maven Central.

Дело LocalDate :

@Test
public void givenTwoDatesInJodaTime_whenDifferentiating_thenWeGetSix() {
    org.joda.time.LocalDate now = org.joda.time.LocalDate.now();
    org.joda.time.LocalDate sixDaysBehind = now.minusDays(6);

    long diff = Math.abs(Days.daysBetween(now, sixDaysBehind).getDays());
    assertEquals(6, diff);
}

Точно так же с LocalDateTime :

@Test
public void givenTwoDateTimesInJodaTime_whenDifferentiating_thenWeGetSix() {
    org.joda.time.LocalDateTime now = org.joda.time.LocalDateTime.now();
    org.joda.time.LocalDateTime sixMinutesBehind = now.minusMinutes(6);

    long diff = Math.abs(Minutes.minutesBetween(now, sixMinutesBehind).getMinutes());
    assertEquals(6, diff);
}

3.2. Дата4J

Date4j также обеспечивает прямую и простую реализацию — отмечая, что в этом случае нам нужно явно указать TimeZone .

Начнем с зависимости Maven:

<dependency>
    <groupId>com.darwinsys</groupId>
    <artifactId>hirondelle-date4j</artifactId>
    <version>1.5.1</version>
</dependency>

Вот быстрый тест, работающий со стандартным DateTime :

@Test
public void givenTwoDatesInDate4j_whenDifferentiating_thenWeGetSix() {
    DateTime now = DateTime.now(TimeZone.getDefault());
    DateTime sixDaysBehind = now.minusDays(6);
 
    long diff = Math.abs(now.numDaysFrom(sixDaysBehind));

    assertEquals(6, diff);
}

4. Вывод

В этой статье мы проиллюстрировали несколько способов вычисления разницы между датами (со временем и без него) как в простой Java, так и с использованием внешних библиотек.

Полный исходный код статьи доступен на GitHub .