Introduzione a Joda-Time

1. Introduzione

Joda-Time è la libreria di elaborazione di data e ora più utilizzata, prima del rilascio di Java 8. Il suo scopo era offrire un'API intuitiva per l'elaborazione di data e ora e anche risolvere i problemi di progettazione esistenti nell'API di data / ora di Java.

I concetti centrali implementati in questa libreria sono stati introdotti nel core JDK con il rilascio della versione Java 8. La nuova API di data e ora si trova nel pacchetto java.time (JSR-310). Una panoramica di queste funzionalità è disponibile in questo articolo.

Dopo il rilascio di Java 8, gli autori ritengono che il progetto sia per lo più completato e consigliano di utilizzare l'API Java 8 se possibile.

2. Perché utilizzare Joda-Time?

L'API data / ora, prima di Java 8, presentava diversi problemi di progettazione.

Tra i problemi c'è il fatto che le classi Date e SimpleDateFormatter non sono thread-safe. Per risolvere questo problema, Joda-Time utilizza classi immutabili per la gestione di data e ora.

La classe Date non rappresenta una data effettiva, ma specifica invece un istante nel tempo, con precisione al millisecondo. L'anno in una data inizia dal 1900, mentre la maggior parte delle operazioni di data di solito utilizza l'ora Epoch che inizia dal 1 gennaio 1970.

Inoltre, lo scostamento di giorno, mese e anno di una Data è controintuitivo. I giorni iniziano da 0, mentre il mese inizia da 1. Per accedervi, dobbiamo utilizzare la classe Calendar . Joda-Time offre un'API pulita e fluida per la gestione di date e orari.

Joda-Time offre anche supporto per otto sistemi di calendario , mentre Java ne offre solo 2: Gregorian - java.util.GregorianCalendar e Japanese - java.util.JapaneseImperialCalendar .

3. Configurazione

Per includere la funzionalità della libreria Joda-Time, dobbiamo aggiungere la seguente dipendenza da Maven Central:

 joda-time joda-time 2.10 

4. Panoramica della libreria

Joda-Time modella il concetto di data e ora utilizzando le classi nel pacchetto org.joda.time .

Tra queste classi le più comunemente utilizzate sono:

  • LocalDate : rappresenta una data senza ora
  • LocalTime : rappresenta l'ora senza il fuso orario
  • LocalDateTime : rappresenta sia la data che l'ora senza un fuso orario
  • Istantaneo : rappresenta un punto esatto nel tempo in millisecondi dall'epoca di Java del 1970-01-01T00: 00: 00Z
  • Durata : rappresenta la durata in millisecondi tra 2 punti nel tempo
  • Periodo : simile alla Durata , ma che consente l'accesso ai singoli componenti dell'oggetto data e ora, come anni, mese, giorni, ecc.
  • Intervallo : rappresenta l'intervallo di tempo tra 2 istanti

Altre caratteristiche importanti sono i parser ei formattatori di data . Questi possono essere trovati nel pacchetto org.joda.time.format .

Il sistema di calendario e le classi specifiche del fuso orario sono disponibili nei pacchetti org.joda.time.chrono e org.joda.time.tz.

Diamo un'occhiata ad alcuni esempi in cui utilizziamo le funzionalità chiave di Joda-Time per gestire la data e l'ora.

5. Rappresentazione di data e ora

5.1. Data e ora correnti

La data corrente, senza informazioni di tempo, può essere ottenuto usando l' ora () metodo dal l' LocalDate classe :

LocalDate currentDate = LocalDate.now();

Quando abbiamo bisogno solo dell'ora corrente, senza informazioni sulla data, possiamo usare la classe LocalTime :

LocalTime currentTime = LocalTime.now();

Per ottenere una rappresentazione della data e dell'ora correnti senza considerare il fuso orario, possiamo utilizzare LocalDateTime :

LocalDateTime currentDateAndTime = LocalDateTime.now();

Ora, utilizzando currentDateAndTime , possiamo convertirlo in altri tipi di oggetti che modellano data e ora.

Possiamo ottenere un oggetto DateTime (che tiene conto del fuso orario) utilizzando il metodo toDateTime () . Quando il tempo non è necessario possiamo convertirlo in un LocalDate con il metodo toLocalDate () , e quando abbiamo solo bisogno del tempo possiamo usare toLocalTime () per ottenere un oggetto LocalTime :

DateTime dateTime = currentDateAndTime.toDateTime(); LocalDate localDate = currentDateAndTime.toLocalDate(); LocalTime localTime = currentDateAndTime.toLocalTime();

Tutti i metodi precedenti hanno un metodo sovraccarico che accetta un oggetto DateTimeZone per aiutarci a rappresentare la data o l'ora nel fuso orario specificato:

LocalDate currentDate = LocalDate.now(DateTimeZone.forID("America/Chicago"));

Inoltre, Joda-Time offre un'eccellente integrazione con l'API Java Date and Time. I costruttori accettano un oggetto java.util.Date e inoltre, possiamo utilizzare il metodo toDate () per restituire un oggetto java.util.Date :

LocalDateTime currentDateTimeFromJavaDate = new LocalDateTime(new Date()); Date currentJavaDate = currentDateTimeFromJavaDate.toDate();

5.2. Data e ora personalizzate

Per rappresentare la data e l'ora personalizzate, Joda-Time ci fornisce diversi costruttori. Possiamo specificare i seguenti oggetti:

  • un istante
  • un oggetto Java Date
  • una rappresentazione in formato stringa della data e dell'ora utilizzando il formato ISO
  • parti della data e dell'ora: anno, mese, giorno, ora, minuti, secondi, millisecondi
Date oneMinuteAgoDate = new Date(System.currentTimeMillis() - (60 * 1000)); Instant oneMinutesAgoInstant = new Instant(oneMinuteAgoDate); DateTime customDateTimeFromInstant = new DateTime(oneMinutesAgoInstant); DateTime customDateTimeFromJavaDate = new DateTime(oneMinuteAgoDate); DateTime customDateTimeFromString = new DateTime("2018-05-05T10:11:12.123"); DateTime customDateTimeFromParts = new DateTime(2018, 5, 5, 10, 11, 12, 123); 

Un altro modo in cui possiamo definire una data e un'ora personalizzate è analizzare una data rappresentazione di stringa di una data e ora nel formato ISO:

DateTime parsedDateTime = DateTime.parse("2018-05-05T10:11:12.123");

Possiamo anche analizzare rappresentazioni personalizzate di una data e ora definendo un DateTimeFormatter personalizzato :

DateTimeFormatter dateTimeFormatter = DateTimeFormat.forPattern("MM/dd/yyyy HH:mm:ss"); DateTime parsedDateTimeUsingFormatter = DateTime.parse("05/05/2018 10:11:12", dateTimeFormatter);

6. Lavorare con data e ora

6.1. Utilizzando Instant

Un istante rappresenta il numero di millisecondi da 1970-01-01T00: 00: 00Z fino a un determinato momento. Ad esempio, l'attuale momento temporale può essere ottenuto utilizzando il costruttore predefinito o il metodo now () :

Instant instant = new Instant(); Instant.now();

To create an Instant for a custom moment in time we can use either one of the constructors or use the methods ofEpochMilli() and ofEpochSecond():

Instant instantFromEpochMilli = Instant.ofEpochMilli(milliesFromEpochTime); Instant instantFromEpocSeconds = Instant.ofEpochSecond(secondsFromEpochTime);

The constructors accept a String representing a date and time in the ISO format, a Java Date or a long value representing the number of milliseconds from 1970-01-01T00:00:00Z:

Instant instantFromString = new Instant("2018-05-05T10:11:12"); Instant instantFromDate = new Instant(oneMinuteAgoDate); Instant instantFromTimestamp = new Instant(System.currentTimeMillis() - (60 * 1000));

When date and time are represented as a String we have the option to parse the String using our desired format:

Instant parsedInstant = Instant.parse("05/05/2018 10:11:12", dateTimeFormatter);

Now that we know what Instant represents and how we can create one, let's see how it can be used.

To compare to Instant objects we can use compareTo() because it implements the Comparable interface, but also we can use the Joda-Time API methods provided in the ReadableInstant interface which Instant also implements:

assertTrue(instantNow.compareTo(oneMinuteAgoInstant) > 0); assertTrue(instantNow.isAfter(oneMinuteAgoInstant)); assertTrue(oneMinuteAgoInstant.isBefore(instantNow)); assertTrue(oneMinuteAgoInstant.isBeforeNow()); assertFalse(oneMinuteAgoInstant.isEqual(instantNow));

Another helpful feature is that Instant can be converted to a DateTime object or event a Java Date:

DateTime dateTimeFromInstant = instant.toDateTime(); Date javaDateFromInstant = instant.toDate();

When we need to access parts of a date and time, like the year, the hour and so on, we can use the get() method and specify a DateTimeField:

int year = instant.get(DateTimeFieldType.year()); int month = instant.get(DateTimeFieldType.monthOfYear()); int day = instant.get(DateTimeFieldType.dayOfMonth()); int hour = instant.get(DateTimeFieldType.hourOfDay());

Now that we covered the Instant class let's see some examples of how we can use Duration, Period and Interval.

6.2. Using Duration, Period and Interval

A Duration represents the time in milliseconds between two points in time or in this case it could be two Instants. We'll use this when we need to add or subtract a specific amount of time to or from another Instant without considering chronology and time zones:

long currentTimestamp = System.currentTimeMillis(); long oneHourAgo = currentTimestamp - 24*60*1000; Duration duration = new Duration(oneHourAgo, currentTimestamp); Instant.now().plus(duration);

Also, we can determine how many days, hours, minutes, seconds or milliseconds the duration represents:

long durationInDays = duration.getStandardDays(); long durationInHours = duration.getStandardHours(); long durationInMinutes = duration.getStandardMinutes(); long durationInSeconds = duration.getStandardSeconds(); long durationInMilli = duration.getMillis();

The main difference between Period and Duration is that Period is defined in terms of its date and time components (years, months, hours, etc.) and doesn't represent an exact number of milliseconds. When using Period date and time calculations will consider the time zone and daylight saving.

For example, adding a Period of 1 month to the February 1st will result in the date representation of March 1st. By using Period the library will take into account leap years.

If we're to use a Duration we the result wouldn't be correct, because the Duration represents a fixed amount of time that doesn't take into account chronology or time zones:

Period period = new Period().withMonths(1); LocalDateTime datePlusPeriod = localDateTime.plus(period);

An Interval, as the name states, represents the date and time interval between two fixed points in time represented by two Instant objects:

Interval interval = new Interval(oneMinuteAgoInstant, instantNow);

The class is useful when we need to check whether two intervals overlap or calculate the gap between them. The overlap() method will return the overlapping Interval or null when they don't overlap:

Instant startInterval1 = new Instant("2018-05-05T09:00:00.000"); Instant endInterval1 = new Instant("2018-05-05T11:00:00.000"); Interval interval1 = new Interval(startInterval1, endInterval1); Instant startInterval2 = new Instant("2018-05-05T10:00:00.000"); Instant endInterval2 = new Instant("2018-05-05T11:00:00.000"); Interval interval2 = new Interval(startInterval2, endInterval2); Interval overlappingInterval = interval1.overlap(interval2);

The difference between intervals can be calculated using the gap() method, and when we want to know whether the end of an interval is equal to the start of another interval we can use the abuts() method:

assertTrue(interval1.abuts(new Interval( new Instant("2018-05-05T11:00:00.000"), new Instant("2018-05-05T13:00:00.000"))));

6.3. Date and Time Operations

Some of the most common operations are to add, subtract and convert date and time. The library provides specific methods for each of the classes LocalDate, LocalTime, LocalDateTime, and DateTime. It's important to note that these classes are immutable so that every method invocation will create a new object of its type.

Let's take LocalDateTime for the current moment and try to change its value:

LocalDateTime currentLocalDateTime = LocalDateTime.now();

To add an extra day to currentLocalDateTime we use the plusDays() method:

LocalDateTime nextDayDateTime = currentLocalDateTime.plusDays(1);

We can also use plus() method to add a Period or Duration to our currentLocalDateTime:

Period oneMonth = new Period().withMonths(1); LocalDateTime nextMonthDateTime = currentLocalDateTime.plus(oneMonth);

The methods are similar for the other date and time components, for example, plusYears() for adding extra years, plusSeconds() for adding more seconds and so on.

To subtract a day from our currentLocalDateTime we can use the minusDays() method:

LocalDateTime previousDayLocalDateTime = currentLocalDateTime.minusDays(1);

Besides, doing calculations with date and time, we can also, set individual parts of the date or time. For example, setting the hour to 10 can be achieved using the withHourOfDay() method. Other methods that start with the prefix “with” can be used to set components of that date or time:

LocalDateTime currentDateAtHour10 = currentLocalDateTime .withHourOfDay(0) .withMinuteOfHour(0) .withSecondOfMinute(0) .withMillisOfSecond(0);

Another important aspect is that we can convert from a date and time class type to another. To do this, we can use specific methods provided by the library:

  • toDateTime() – converts LocalDateTime to a DateTime object
  • toLocalDate() – converts LocalDateTime to a LocalDate object
  • toLocalTime() – converts LocalDateTime to a LocalTime object
  • toDate() – converts LocalDateTime to a Java Date object

7. Working with Time Zones

Joda-Time makes it easy for us to work with different time zones and changed between them. We have the DateTimeZone abstract class which is used to represent all aspects regarding a time zone.

The default time zone used by Joda-Time is selected from the user.timezone Java system property. The library API lets us specify, individually for each class or calculation what timezone should be used. For example, we can create a LocalDateTime object

When we know that we'll use a specific time zone across the whole application, we can set the default time zone:

DateTimeZone.setDefault(DateTimeZone.UTC);

From now one all the date and time operations, if not otherwise specified, will be represented in the UTC time zone.

To see all the available time zones we can use the method getAvailableIDs():

DateTimeZone.getAvailableIDs()

When we need to represent the date or time in a specific time zone we can use any of the classes LocalTime, LocalDate, LocalDateTime, DateTime and specify in the constructor the DateTimeZone object:

DateTime dateTimeInChicago = new DateTime(DateTimeZone.forID("America/Chicago")); DateTime dateTimeInBucharest = new DateTime(DateTimeZone.forID("Europe/Bucharest")); LocalDateTime localDateTimeInChicago = new LocalDateTime(DateTimeZone.forID("America/Chicago"));

Also, when converting between those classes we can specify the desired time zone. The method toDateTime() accepts a DateTimeZone object and toDate() accepts java.util.TimeZone object:

DateTime convertedDateTime = localDateTimeInChicago.toDateTime(DateTimeZone.forID("Europe/Bucharest")); Date convertedDate = localDateTimeInChicago.toDate(TimeZone.getTimeZone("Europe/Bucharest"));

8. Conclusion

Joda-Time è una fantastica libreria che è iniziata con l'obiettivo principale di risolvere i problemi nel JDK riguardanti le operazioni di data e ora. Presto divenne la libreria di fatto per la gestione di data e ora e recentemente i concetti principali da essa sono stati introdotti in Java 8.

È importante notare che l'autore lo considera "un progetto in gran parte finito" e consiglia di migrare il codice esistente per utilizzare l'implementazione di Java 8.

Il codice sorgente dell'articolo è disponibile su GitHub.