Introduction à l'API de date / heure de Java 8

1. Vue d'ensemble

Java 8 a introduit de nouvelles API pour la date et l' heure afin de remédier aux lacunes des anciens java.util.Date et java.util.Calendar .

Dans le cadre de cet article, commençons par les problèmes des API de date et de calendrier existantes et discutons de la façon dont les nouvelles API de date et d' heure Java 8 les résolvent.

Nous examinerons aussi quelques - unes des classes de base du nouveau projet Java 8 qui font partie du java.time paquet comme LocalDate , LocalTime, LocalDateTime, ZonedDateTime, période, durée et leurs API prises en charge.

2. Problèmes avec les API de date / heure existantes

  • Sécurité des threads - Les classes Date et Calendar ne sont pas sûres pour les threads, ce qui laisse aux développeurs le soin de gérer les problèmes de concurrence difficiles à déboguer et d'écrire du code supplémentaire pour gérer la sécurité des threads. Au contraire, les nouvelles API de date et d' heure introduites dans Java 8 sont immuables et sécurisées pour les threads, éliminant ainsi ce casse-tête de concurrence des développeurs.
  • Conception des API et facilité de compréhension - Les API de date et de calendrier sont mal conçues avec des méthodes inadéquates pour effectuer les opérations quotidiennes. Les nouvelles API de date / heure sont centrées sur ISO et suivent des modèles de domaine cohérents pour la date, l'heure, la durée et les périodes. Il existe une grande variété de méthodes utilitaires qui prennent en charge les opérations les plus courantes.
  • ZonedDate et heure - Les développeurs ont dû écrire une logique supplémentaire pour gérer la logique de fuseau horaire avec les anciennes API, alors qu'avec les nouvelles API, la gestion du fuseau horaire peut être effectuée avec les API Local et ZonedDate / Time .

3. Utilisation de LocalDate , LocalTime et LocalDateTime

Les classes les plus couramment utilisées sont LocalDate , LocalTime et LocalDateTime . Comme leur nom l'indique, ils représentent la date / heure locale du contexte de l'observateur.

Ces classes sont principalement utilisées lorsque le fuseau horaire ne doit pas être spécifié explicitement dans le contexte. Dans le cadre de cette section, nous couvrirons les API les plus couramment utilisées.

3.1. Travailler avec LocalDate

Le LocalDate représente une date au format ISO (aaaa-MM-jj) sans heure .

Il peut être utilisé pour stocker des dates comme les anniversaires et les jours de paie.

Une instance de la date actuelle peut être créée à partir de l'horloge système comme ci-dessous:

LocalDate localDate = LocalDate.now();

La LocalDate représentant un jour, un mois et une année spécifiques peut être obtenue en utilisant la méthode « of » ou en utilisant la méthode « parse ». Par exemple, les extraits de code ci-dessous représentent la LocalDate du 20 février 2015:

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

Le LocalDate propose différentes méthodes utilitaires pour obtenir une variété d'informations. Jetons un coup d'œil rapide à certaines de ces méthodes d'API.

L'extrait de code suivant obtient la date locale actuelle et ajoute un jour:

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

Cet exemple obtient la date actuelle et soustrait un mois. Notez comment il accepte une énumération comme unité de temps:

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

Dans les deux exemples de code suivants, nous analysons la date «2016-06-12» et obtenons respectivement le jour de la semaine et le jour du mois. Notez les valeurs de retour, le premier est un objet représentant le DayOfWeek tandis que le second dans un int représentant la valeur ordinale du mois:

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

Nous pouvons tester si une date survient dans une année bissextile. Dans cet exemple, nous testons si la date actuelle se produit est une année bissextile:

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

Il est possible de déterminer que la relation d'une date à une autre se produit avant ou après une autre date:

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"));

Les limites de date peuvent être obtenues à partir d'une date donnée. Dans les deux exemples suivants, nous obtenons le LocalDateTime qui représente le début de la journée (2016-06-12T00: 00) de la date donnée et le LocalDate qui représente le début du mois (2016-06-01) respectivement:

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

Voyons maintenant comment nous travaillons avec l'heure locale.

3.2. Travailler avec LocalTime

Le LocalTime représente l' heure sans date .

Similaire à LocalDate, une instance de LocalTime peut être créée à partir de l'horloge système ou en utilisant les méthodes «parse» et «of». Aperçu rapide de certaines des API couramment utilisées ci-dessous.

Une instance de LocalTime actuel peut être créée à partir de l'horloge système comme ci-dessous:

LocalTime now = LocalTime.now();

Dans l'exemple de code ci-dessous , nous créons un LocalTime représentant 06h30 en analysant une représentation sous forme de chaîne:

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

La méthode Factory «of» peut être utilisée pour créer un LocalTime . Par exemple, le code ci-dessous crée LocalTime représentant 06h30 en utilisant la méthode d'usine:

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

L'exemple ci-dessous crée un LocalTime en analysant une chaîne et y ajoute une heure à l'aide de l'API «plus». Le résultat serait LocalTime représentant 07h30:

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

Diverses méthodes getter sont disponibles et peuvent être utilisées pour obtenir des unités de temps spécifiques telles que l'heure, les minutes et les secondes comme ci-dessous:

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.