Вступ до API дати / часу Java 8

Програмування

1. Огляд

Java 8 представила нові API для дати та часу, щоб усунути недоліки старих java.util.Date та java.util.Calendar .

В рамках цієї статті, давайте почнемо з питаннями в існуючій Даті і Календар API , і давайте обговоримо , як новий Java 8 Дата і час API для їх усунення.

Ми також розглянемо деякі з основних класів нового проекту Java 8 , які є частиною java.time пакета як LocalDate , МестноеВремя, LocalDateTime, ZonedDateTime, період, тривалість і їх підтримуваного API.

2. Проблеми з існуючими API дати та часу

  • Тема безпеки - The Дата і Календар класи не є поточно, в результаті чого розробників впоратися з головним болем важко питання паралелізму налагодження і писати додатковий код для безпеки ручки різьблення. Навпаки, нові API дати та часу, представлені в Java 8, є незмінними та безпечними для потоків, тим самим позбавляючи головного болю від паралельності від розробників.
  • Дизайн API та легкість розуміння - API дати та календаря погано розроблені з використанням неадекватних методів для виконання щоденних операцій. Нові API дати / часу є орієнтованими на ISO і відповідають послідовним моделям доменів для дати, часу, тривалості та періодів. Існує широкий спектр корисних методів, що підтримують найпоширеніші операції.
  • ZonedDate і Time - Розробникам довелося написати додаткову логіку для обробки логіки часового поясу зі старими API, тоді як за допомогою нових API обробка часового поясу може здійснюватися за допомогою Local and ZonedDate / Time API.

3. Використання LocalDate , LocalTime та LocalDateTime

Найчастіше використовуються класи LocalDate , LocalTime та LocalDateTime . Як вказують їх імена, вони представляють місцеву Дату / Час з контексту спостерігача.

Ці класи в основному використовуються, коли часовий пояс не потрібно чітко вказувати в контексті. Як частина цього розділу, ми розглянемо найбільш часто використовувані API.

3.1. Робота з LocalDate

LocalDate представляє собою дату в форматі ISO (YYYY-MM-дд) без часу .

За допомогою нього можна зберігати такі дати, як дні народження та зарплати.

Екземпляр поточної дати можна створити з системного годинника, як показано нижче:

LocalDate localDate = LocalDate.now();

LocalDate , що представляє певний день, місяць і рік може бути отриманий з допомогою « з » методу або за допомогою « розбору методу». Наприклад, наведені нижче фрагменти коду представляють LocalDate за 20 лютого 2015 року:

LocalDate.of(2015, 02, 20); LocalDate.parse("2015-02-20");

LocalDate надає різні службові методи , щоб отримати різноманітну інформацію. Давайте швидко поглянемо на деякі з цих методів API.

Наступний фрагмент коду отримує поточну локальну дату та додає один день:

LocalDate tomorrow = LocalDate.now().plusDays(1);

Цей приклад отримує поточну дату і віднімає один місяць. Зверніть увагу, як він приймає перелік як одиницю часу:

LocalDate previousMonthSameDay = LocalDate.now().minus(1, ChronoUnit.MONTHS);

У наступних двох прикладах коду ми аналізуємо дату “2016-06-12” і отримуємо день тижня та день місяця відповідно. Зверніть увагу на повернені значення, перше - це об’єкт, що представляє DayOfWeek, а друге - у int, що представляє порядкове значення місяця:

DayOfWeek sunday = LocalDate.parse("2016-06-12").getDayOfWeek(); int twelve = LocalDate.parse("2016-06-12").getDayOfMonth();

Ми можемо перевірити, чи настає дата у високосному році. У цьому прикладі ми перевіряємо, чи є поточна дата високосним:

boolean leapYear = LocalDate.now().isLeapYear();

Можна встановити, що відношення дати до іншої має місце до або після іншої дати:

boolean notBefore = LocalDate.parse("2016-06-12") .isBefore(LocalDate.parse("2016-06-11")); boolean isAfter = LocalDate.parse("2016-06-12") .isAfter(LocalDate.parse("2016-06-11"));

Межі дат можна отримати з даної дати. У наступних двох прикладах ми отримуємо LocalDateTime, який представляє початок дня (2016-06-12T00: 00) даної дати та LocalDate, який представляє початок місяця (01.06.2016) відповідно:

LocalDateTime beginningOfDay = LocalDate.parse("2016-06-12").atStartOfDay(); LocalDate firstDayOfMonth = LocalDate.parse("2016-06-12") .with(TemporalAdjusters.firstDayOfMonth());

А тепер давайте подивимось, як ми працюємо з місцевим часом.

3.2. Робота з LocalTime

LocalTime представляє час без дати .

Подібно до LocalDate , екземпляр LocalTime може бути створений із системного годинника або за допомогою методів “синтаксичного аналізу” та “з”. Швидко ознайомтеся з деякими часто використовуваними API нижче.

An instance of current LocalTime can be created from the system clock as below:

LocalTime now = LocalTime.now();

In the below code sample, we create a LocalTime representing 06:30 AM by parsing a string representation:

LocalTime sixThirty = LocalTime.parse("06:30");

The Factory method “of” can be used to create a LocalTime. For example the below code creates LocalTime representing 06:30 AM using the factory method:

LocalTime sixThirty = LocalTime.of(6, 30);

The below example creates a LocalTime by parsing a string and adds an hour to it by using the “plus” API. The result would be LocalTime representing 07:30 AM:

LocalTime sevenThirty = LocalTime.parse("06:30").plus(1, ChronoUnit.HOURS);

Various getter methods are available which can be used to get specific units of time like hour, min and secs like below:

int six = LocalTime.parse("06:30").getHour();

We can also check if a specific time is before or after another specific time. The below code sample compares two LocalTime for which the result would be true:

boolean isbefore = LocalTime.parse("06:30").isBefore(LocalTime.parse("07:30"));

The max, min and noon time of a day can be obtained by constants in LocalTime class. This is very useful when performing database queries to find records within a given span of time. For example, the below code represents 23:59:59.99:

LocalTime maxTime = LocalTime.MAX

Now let's dive into LocalDateTime.

3.3. Working With LocalDateTime

The LocalDateTime is used to represent a combination of date and time.

This is the most commonly used class when we need a combination of date and time. The class offers a variety of APIs and we will look at some of the most commonly used ones.

An instance of LocalDateTime can be obtained from the system clock similar to LocalDate and LocalTime:

LocalDateTime.now();

The below code samples explain how to create an instance using the factory “of” and “parse” methods. The result would be a LocalDateTime instance representing 20 February 2015, 06:30 AM:

LocalDateTime.of(2015, Month.FEBRUARY, 20, 06, 30);
LocalDateTime.parse("2015-02-20T06:30:00");

There are utility APIs to support addition and subtraction of specific units of time like days, months, year and minutes are available. The below code samples demonstrates the usage of “plus” and “minus” methods. These APIs behave exactly like their counterparts in LocalDate and LocalTime:

localDateTime.plusDays(1);
localDateTime.minusHours(2);

Getter methods are available to extract specific units similar to the date and time classes. Given the above instance of LocalDateTime, the below code sample will return the month February:

localDateTime.getMonth();

4. Using ZonedDateTime API

Java 8 provides ZonedDateTime when we need to deal with time zone specific date and time. The ZoneId is an identifier used to represent different zones. There are about 40 different time zones and the ZoneId are used to represent them as follows.

In this code snippet we create a Zone for Paris:

ZoneId zoneId = ZoneId.of("Europe/Paris");

A set of all zone ids can be obtained as below:

Set allZoneIds = ZoneId.getAvailableZoneIds();

The LocalDateTime can be converted to a specific zone:

ZonedDateTime zonedDateTime = ZonedDateTime.of(localDateTime, zoneId);

The ZonedDateTime provides parse method to get time zone specific date time:

ZonedDateTime.parse("2015-05-03T10:15:30+01:00[Europe/Paris]");

Another way to work with time zone is by using OffsetDateTime. The OffsetDateTime is an immutable representation of a date-time with an offset. This class stores all date and time fields, to a precision of nanoseconds, as well as the offset from UTC/Greenwich.

The OffSetDateTime instance can be created as below using ZoneOffset. Here we create a LocalDateTime representing 6:30 am on 20th February 2015:

LocalDateTime localDateTime = LocalDateTime.of(2015, Month.FEBRUARY, 20, 06, 30);

Then we add two hours to the time by creating a ZoneOffset and setting for the localDateTime instance:

ZoneOffset offset = ZoneOffset.of("+02:00"); OffsetDateTime offSetByTwo = OffsetDateTime .of(localDateTime, offset);

We now have a localDateTime of 2015-02-20 06:30 +02:00. Now let's move on to how to modify date and time values using the Period and Duration classes.

5. Using Period and Duration

The Period class represents a quantity of time in terms of years, months and days and the Duration class represents a quantity of time in terms of seconds and nano seconds.

5.1. Working With Period

The Period class is widely used to modify values of given a date or to obtain the difference between two dates:

LocalDate initialDate = LocalDate.parse("2007-05-10");

The Date can be manipulated using Period as shown in the following code snippet:

LocalDate finalDate = initialDate.plus(Period.ofDays(5));

The Period class has various getter methods such as getYears, getMonths and getDays to get values from a Period object. The below code example returns an int value of 5 as we try to get difference in terms of days:

int five = Period.between(initialDate, finalDate).getDays();

The Period between two dates can be obtained in a specific unit such as days or month or years, using ChronoUnit.between:

long five = ChronoUnit.DAYS.between(initialDate, finalDate);

This code example returns five days. Let's continue by taking a look at the Duration class.

5.2. Working With Duration

Similar to Period, the Duration class is use to deal with Time. In the following code we create a LocalTime of 6:30 am and then add a duration of 30 seconds to make a LocalTime of 06:30:30am:

LocalTime initialTime = LocalTime.of(6, 30, 0); LocalTime finalTime = initialTime.plus(Duration.ofSeconds(30));

The Duration between two instants can be obtained either as a Duration or as a specific unit. In the first code snippet we use the between() method of the Duration class to find the time difference between finalTime and initialTime and return the difference in seconds:

long thirty = Duration.between(initialTime, finalTime).getSeconds();

In the second example we use the between() method of the ChronoUnit class to perform the same operation:

long thirty = ChronoUnit.SECONDS.between(initialTime, finalTime);

Now we will look at how to convert existing Date and Calendar to new Date/Time.

6. Compatibility with Date and Calendar

Java 8 has added the toInstant() method which helps to convert existing Date and Calendar instance to new Date Time API as in the following code snippet:

LocalDateTime.ofInstant(date.toInstant(), ZoneId.systemDefault()); LocalDateTime.ofInstant(calendar.toInstant(), ZoneId.systemDefault());

The LocalDateTime can be constructed from epoch seconds as below. The result of the below code would be a LocalDateTime representing 2016-06-13T11:34:50:

LocalDateTime.ofEpochSecond(1465817690, 0, ZoneOffset.UTC);

Now let's move on to Date and Time formatting.

7. Date and Time Formatting

Java 8 provides APIs for the easy formatting of Date and Time:

LocalDateTime localDateTime = LocalDateTime.of(2015, Month.JANUARY, 25, 6, 30);

The below code passes an ISO date format to format the local date. The result would be 2015-01-25 :

String localDateString = localDateTime.format(DateTimeFormatter.ISO_DATE);

The DateTimeFormatter provides various standard formatting options. Custom patterns can be provided to format method as well, like below, which would return a LocalDate as 2015/01/25:

localDateTime.format(DateTimeFormatter.ofPattern("yyyy/MM/dd"));

We can pass in formatting style either as SHORT, LONG or MEDIUM as part of the formatting option. The below code sample would give an output representing LocalDateTime in 25-Jan-2015, 06:30:00:

localDateTime .format(DateTimeFormatter.ofLocalizedDateTime(FormatStyle.MEDIUM)) .withLocale(Locale.UK);

Let us take a look at alternatives available to Java 8 Core Date/Time APIs.

8. Backport and Alternate Options

8.1. Using Project Threeten

For organization that are on the path of moving to Java 8 from Java 7 or Java 6 and want to use date and time API, project threeten provides the backport capability. Developers can use classes available in this project to achieve the same functionality as that of new Java 8 Date and Time API and once they move to Java 8, the packages can be switched. Artifact for the project threeten can be found in the maven central repository:

 org.threeten threetenbp 1.3.1

8.2. Joda-Time Library

Another alternative for Java 8 Date and Time library is Joda-Time library. In fact Java 8 Date Time APIs has been led jointly by the author of Joda-Time library (Stephen Colebourne) and Oracle. This library provides pretty much all capabilities that is supported in Java 8 Date Time project. The Artifact can be found in the maven central by including the below pom dependency in your project:

 joda-time joda-time 2.9.4

9. Conclusion

Java 8 provides a rich set of APIs with consistent API design for easier development.

The code samples for the above article can be found in the Java 8 Date/Time git repository.