Formatowanie za pomocą printf () w Javie

1. Wstęp

W tym tutorialu, będziemy wykazywać różne przykłady formatowania z printf () metody .

Metoda jest częścią klasy java.io.PrintStream i zapewnia formatowanie ciągów podobne do funkcji printf () w języku C.

2. Składnia

Możemy użyć jednej z następujących metod PrintStream , aby sformatować dane wyjściowe:

System.out.printf(format, arguments); System.out.printf(locale, format, arguments);

Reguły formatowania określamy za pomocą parametru format . Reguły zaczynają się od znaku „%” .

Spójrzmy na krótki przykład, zanim zagłębimy się w szczegóły różnych reguł formatowania:

System.out.printf("Hello %s!%n", "World");

Daje to następujący wynik:

Hello World!

Jak pokazano powyżej, ciąg formatu zawiera zwykły tekst i dwie reguły formatowania. Pierwsza reguła służy do formatowania argumentu ciągu. Druga reguła dodaje znak nowego wiersza na końcu ciągu.

2.1. Zasady formatowania

Przyjrzyjmy się bliżej ciągowi formatu. Składa się z literałów i specyfikatorów formatu. Specyfikatory formatu obejmują flagi, szerokość, dokładność i znaki konwersji w następującej kolejności:

%[flags][width][.precision]conversion-character

Specyfikatory w nawiasach są opcjonalne.

Wewnętrznie printf () używa klasy java.util.Formatter do analizowania ciągu formatu i generowania danych wyjściowych. Dodatkowe opcje ciągu formatu można znaleźć w pliku Javadoc programu Formatter.

2.2. Znaki konwersji

Znak konwersji jest wymagany i określa sposób formatowania argumentu . Znaki konwersji są ważne tylko dla niektórych typów danych. Niektóre z nich to:

  • s - formatuje ciągi
  • d - formatuje dziesiętne liczby całkowite
  • f - formatuje liczby zmiennoprzecinkowe
  • t - formatuje wartości daty / czasu

Omówimy je i kilka innych w dalszej części artykułu.

2.3. Opcjonalne modyfikatory

W [flagi] określają standardowe sposoby modyfikowania wyjście i są najczęstszą formatowania liczb całkowitych i liczb zmiennoprzecinkowych.

[Szerokość] określa szerokość pola do wyprowadzenia argumentu. Reprezentuje minimalną liczbę znaków zapisanych na wyjściu.

[.Precision] określa liczbę cyfr precyzji podczas wyprowadzania wartości zmiennoprzecinkowych. Dodatkowo możemy go użyć do zdefiniowania długości podciągu do wyodrębnienia z String .

3. Separator linii

Aby podzielić ciąg na oddzielne wiersze, mamy specyfikator % n :

System.out.printf("baeldung%nline%nterminator");

Powyższy fragment kodu wygeneruje następujące dane wyjściowe:

baeldung line terminator

% N separatora printf () automatycznie wstawić natywnego separator linii systemu hosta .

4. Formatowanie boolowskie

Aby sformatować wartości logiczne, używamy formatu % b . Działa to w następujący sposób: Jeśli wartość wejściowa jest prawdziwa , dane wyjściowe są prawdziwe . W przeciwnym razie dane wyjściowe są fałszywe .

Więc jeśli to zrobimy:

System.out.printf("%b%n", null); System.out.printf("%B%n", false); System.out.printf("%B%n", 5.3); System.out.printf("%b%n", "random text");

Wtedy zobaczymy:

false FALSE TRUE true 

Zauważ, że możemy użyć % B do formatowania wielkich liter.

5. Formatowanie ciągów

Aby sformatować prosty ciąg, użyjemy kombinacji % s . Dodatkowo możemy napisać wielkie litery:

printf("'%s' %n", "baeldung"); printf("'%S' %n", "baeldung");

A wynik to:

'baeldung' 'BAELDUNG'

Ponadto, aby określić minimalną długość, możemy określić szerokość :

printf("'%15s' %n", "baeldung");

Co daje nam:

' baeldung'

Jeśli musimy wyrównać nasz ciąg do lewej, możemy użyć flagi-” :

printf("'%-10s' %n", "baeldung");

A wynik to:

'baeldung '

Even more, we can limit the number of characters in our output by specifying a precision:

System.out.printf("%2.2s", "Hi there!");

The first ‘x' number in %x.ys syntax is the padding. ‘y' is the number of chars.

For our example here, the output is Hi.

6. Char Formatting

The result of %c is a Unicode character:

System.out.printf("%c%n", 's'); System.out.printf("%C%n", 's');

The capital letter C will uppercase the result:

s S

But, if we give it an invalid argument, then Formatter will throw IllegalFormatConversionException.

7. Number Formatting

7.1. Integer Formatting

The printf() method accepts all the integers available in the language; byte, short, int, long and BigInteger if we use %d:

System.out.printf("simple integer: %d%n", 10000L);

With the help of the ‘d' character, we'll have:

simple integer: 10000

In case we need to format our number with the thousands separator, we can use the ‘,'flag. And we can also format our results for different locales:

System.out.printf(Locale.US, "%,d %n", 10000); System.out.printf(Locale.ITALY, "%,d %n", 10000);

As we see, the formatting in the US is different than in Italy:

10,000 10.000

7.2. Float and Double Formatting

To format a float number, we'll need the ‘f' format:

System.out.printf("%f%n", 5.1473);

Which will output:

5.147300

Of course, the first thing that comes to mind is to control the precision:

System.out.printf("'%5.2f'%n", 5.1473);

Here we define the width of our number as 5, and the length of the decimal part is 2:

' 5.15'

Here we have one space padding from the beginning of the number to support the predefined width.

To have our output in scientific notation, we just use the ‘e' conversion character:

System.out.printf("'%5.2e'%n", 5.1473);

And the result is the following:

'5.15e+00'

8. Date and Time Formatting

For date and time formatting, the conversion string is a sequence of two characters: the ‘t' or ‘T' character and the conversion suffix. Let's explore the most common time and date formatting suffix characters with the examples.

Definitely, for more advanced formatting we can use DateTimeFormatter which has been available since Java 8.

8.1. Time Formatting

First, let's see the list of some useful suffix characters for Time Formatting:

  • ‘H', ‘M', ‘S' – characters are responsible for extracting the hours, minutes and second from the input Date
  • ‘L', ‘N' – to represent the time in milliseconds and nanoseconds accordingly
  • ‘p' – adds am/pm formatting
  • ‘z' – prints out the timezone offset

Now, let's say we wanted to print out the time part of a Date:

Date date = new Date(); System.out.printf("%tT%n", date);

The code above along with ‘%tT' combination produces the following output:

13:51:15

In case we need more detailed formatting, we can call for different time segments:

System.out.printf("hours %tH: minutes %tM: seconds %tS%n", date, date, date);

Having used ‘H', ‘M', and ‘S' we get:

hours 13: minutes 51: seconds 15

Though, listing date multiple times is a pain. Alternatively, to get rid of multiple arguments, we can use the index reference of our input parameter which is 1$ in our case:

System.out.printf("%1$tH:%1$tM:%1$tS %1$tp %1$tL %1$tN %1$tz %n", date);

Here we want as an output the current time, am/pm, time in milliseconds, nanoseconds and the timezone offset:

13:51:15 pm 061 061000000 +0400

8.2. Date Formatting

Like time formatting, we have special formatting characters for date formatting:

  • ‘A' – prints out the full day of the week
  • ‘d' – formats a two-digit day of the month
  • ‘B' – is for the full month name
  • ‘m' – formats a two-digit month
  • ‘Y' – outputs a year in four digits
  • ‘y' – outputs the last two digits of the year

So, if we wanted to show the day of the week, followed by the month:

System.out.printf("%1$tA, %1$tB %1$tY %n", date);

Then using ‘A', ‘B', and ‘Y', we'd get:

Thursday, November 2018

To have our results all in numeric format, we can replace the ‘A', ‘B', ‘Y ‘ letters with ‘d', ‘m', ‘y':

System.out.printf("%1$td.%1$tm.%1$ty %n", date);

Which will result in:

22.11.18

9. Summary

W tym artykule omówiliśmy, jak używać metody PrintStream # printf do formatowania danych wyjściowych. Przyjrzeliśmy się różnym wzorcom formatu używanym do kontrolowania danych wyjściowych dla typowych typów danych.

Wreszcie, jak zawsze, kod używany podczas dyskusji można znaleźć na GitHub.