Guida a java.util.Formatter

1. Panoramica

In questo articolo, discuteremo la formattazione delle stringhe in Java utilizzando la classe java.util.Formatter , che fornisce supporto per la giustificazione e l'allineamento del layout.

2. Come utilizzare il formattatore

Ricordi il printf di C ? La formattazione di una stringa in Java è molto simile.

Il metodo format () del Formatter viene esposto tramite un metodo statico della classe String . Questo metodo accetta una stringa modello e un elenco di argomenti con cui popolare il modello:

String greetings = String.format( "Hello Folks, welcome to %s !", "Baeldung");

La stringa risultante è:

"Hello Folks, welcome to Baeldung !"

Un modello è una stringa che contiene del testo statico e uno o più specificatori di formato, che indicano quale argomento deve essere posizionato nella posizione particolare.

In questo caso, c'è un unico identificatore di formato % s , che viene sostituito dall'argomento corrispondente.

3. Identificatori di formato

3.1. Sintassi generale

La sintassi degli identificatori di formato per il tipo Generale, Carattere e Numerico è:

%[argument_index$][flags][width][.precision]conversion

Gli specificatori argomento_indice, flag, larghezza e precisione sono facoltativi.

  • argomento_indice è un numero intero i - che indica che l' argomento i- esimo dalla lista degli argomenti dovrebbe essere usato qui
  • flags è un insieme di caratteri utilizzati per modificare il formato di output
  • larghezza è un numero intero positivo che indica il numero minimo di caratteri da scrivere nell'output
  • precisione è un numero intero solitamente utilizzato per limitare il numero di caratteri, il cui comportamento specifico dipende dalla conversione
  • è la parte obbligatoria. È un carattere che indica come deve essere formattato l'argomento. L'insieme di conversioni valide per un dato argomento dipende dal tipo di dati dell'argomento

Nel nostro esempio sopra, se vogliamo specificare il numero di un argomento in modo esplicito, possiamo scriverlo usando gli indici di argomento 1 $ e 2 $ .

Entrambi sono rispettivamente il primo e il secondo argomento:

String greetings = String.format( "Hello %2$s, welcome to %1$s !", "Baeldung", "Folks");

3.2. Per Data / Ora Rappresentanza

%[argument_index$][flags][width]conversion

Anche in questo caso , argomento_indice, flag e larghezza sono opzionali.

Facciamo un esempio per capire questo:

@Test public void whenFormatSpecifierForCalendar_thenGotExpected() { Calendar c = new GregorianCalendar(2017, 11, 10); String s = String.format( "The date is: %tm %1$te,%1$tY", c); assertEquals("The date is: 12 10,2017", s); }

Qui, per ogni identificatore di formato, verrà utilizzato il primo argomento, quindi 1 $ . Qui, se saltiamo l' argomento_index per il 2 ° e il 3 ° identificatore di formato, prova a trovare 3 argomenti, ma dobbiamo usare lo stesso argomento per tutti e 3 gli identificatori di formato.

Quindi, va bene se non specifichiamo l' argomento _index per il primo, ma dobbiamo specificarlo per gli altri due.

La bandiera qui è composta da due personaggi. Dove il primo carattere è sempre una "t" o una "T" . Il secondo carattere dipende dalla parte del calendario da visualizzare.

Nel nostro esempio, i primi specificatori di formato tm , indica il mese formattato come due cifre, te indica il giorno del mese e tY indica l'anno formattato come quattro cifre.

3.3. Identificatori di formato senza argomenti

%[flags][width]conversion

Le bandiere e la larghezza opzionali sono le stesse definite nelle sezioni precedenti.

La conversione richiesta è un carattere o una stringa che indica il contenuto da inserire nell'output. Attualmente, solo il '%' e la nuova riga 'n' possono essere stampati usando questo:

@Test public void whenNoArguments_thenExpected() { String s = String.format("John scored 90%% in Fall semester"); assertEquals("John scored 90% in Fall semester", s); } 

All'interno di format () , se vogliamo stampare '%' , dobbiamo evitarlo usando '%%' .

4. Conversioni

Analizziamo ora ogni dettaglio della sintassi dell'identificatore di formato, iniziando con una conversione . Nota che puoi trovare tutti i dettagli nei javadoc del formattatore .

Come abbiamo notato negli esempi precedenti, la parte di conversione è richiesta in tutti gli specificatori di formato e può essere suddivisa in diverse categorie.

Diamo un'occhiata a ciascuno prendendo esempi.

4.1. Generale

Utilizzato per qualsiasi tipo di argomento. Le conversioni generali sono:

  1. "b" o "B" - per i valori booleani
  2. 'h' o 'H' - per HashCode
  3. 's' o 'S' - per String , se null , stampa "null", altrimenti arg.toString ()

Ora proveremo a visualizzare i valori booleani e String , utilizzando le conversioni corrispondenti:

@Test public void givenString_whenGeneralConversion_thenConvertedString() { String s = String.format("The correct answer is %s", false); assertEquals("The correct answer is false", s); s = String.format("The correct answer is %b", null); assertEquals("The correct answer is false", s); s = String.format("The correct answer is %B", true); assertEquals("The correct answer is TRUE", s); }

4.2. Personaggio

Used for the basic types which represent Unicode characters: char, Character, byte, Byte, short, and Short. This conversion can also be used for the types int and Integer when the Character.isValidCodePoint(int) returns true for them.

It can be written as ‘c’ or ’C’ based on the case we want.

Let's try to print some characters:

@Test public void givenString_whenCharConversion_thenConvertedString() { String s = String.format("The correct answer is %c", 'a'); assertEquals("The correct answer is a", s); s = String.format("The correct answer is %c", null); assertEquals("The correct answer is null", s); s = String.format("The correct answer is %C", 'b'); assertEquals("The correct answer is B", s); s = String.format("The valid unicode character: %c", 0x0400); assertTrue(Character.isValidCodePoint(0x0400)); assertEquals("The valid unicode character: Ѐ", s); }

Let's take one more example of an invalid code point:

@Test(expected = IllegalFormatCodePointException.class) public void whenIllegalCodePointForConversion_thenError() { String s = String.format("The valid unicode character: %c", 0x11FFFF); assertFalse(Character.isValidCodePoint(0x11FFFF)); assertEquals("The valid unicode character: Ā", s); }

4.3. Numeric – Integral

These are used for Java integral types: byte, Byte, short, Short, int and Integer, long, Long, and BigInteger. There are three conversions in this category:

  1. ‘d' – for decimal number
  2. ‘o' – for octal number
  3. ‘X' or ‘x' – for hexadecimal number

Let's try to print each of these:

@Test public void whenNumericIntegralConversion_thenConvertedString() { String s = String.format("The number 25 in decimal = %d", 25); assertEquals("The number 25 in decimal = 25", s); s = String.format("The number 25 in octal = %o", 25); assertEquals("The number 25 in octal = 31", s); s = String.format("The number 25 in hexadecimal = %x", 25); assertEquals("The number 25 in hexadecimal = 19", s); }

4.4. Numeric – Floating Point

Used for Java floating-point types: float, Float, double, Double, and BigDecimal

  1. ‘e' or ‘E'formatted as a decimal number in computerized scientific notation
  2. ‘f'formatted as a decimal number
  3. ‘g' or ‘G'based on the precision value after rounding, this conversion formats into computerized scientific notation or decimal format

Let's try to print the floating point numbers:

@Test public void whenNumericFloatingConversion_thenConvertedString() { String s = String.format( "The computerized scientific format of 10000.00 " + "= %e", 10000.00); assertEquals( "The computerized scientific format of 10000.00 = 1.000000e+04", s); String s2 = String.format("The decimal format of 10.019 = %f", 10.019); assertEquals("The decimal format of 10.019 = 10.019000", s2); }

4.5. Other Conversions

  • Date/Time – for Java types which are capable of encoding a date or time: long, Long, Calendar, Date and TemporalAccessor. For this, we need to use prefixed ‘t' or ‘T', as we saw earlier
  • Percent – prints a literal ‘%' (‘\u0025')
  • Line Separator – prints a platform-specific line separator

Let's have a look at a simple example:

@Test public void whenLineSeparatorConversion_thenConvertedString() { String s = String.format("First Line %nSecond Line"); assertEquals("First Line \n" + "Second Line", s); }

5. Flags

Flags, in general, are used to format the output. Whereas in case of date and time, they are used to specify which part of the date is to be displayed, as we saw in the Section 4 example.

A number of flags are available, a list of which can be found in the documentation.

Let’s see a flag example to understand it’s usage. ‘-‘ is used to format the output as left justified:

@Test public void whenSpecifyFlag_thenGotFormattedString() { String s = String.format("Without left justified flag: %5d", 25); assertEquals("Without left justified flag: 25", s); s = String.format("With left justified flag: %-5d", 25); assertEquals("With left justified flag: 25 ", s); }

6. Precision

For general conversions, precision is just the maximum number of characters to be written to the output. Whereas, f or the floating-point conversions the precision is the number of digits after the radix point.

The first statement is an example of precision with floating-point numbers, and the second one with general conversions:

@Test public void whenSpecifyPrecision_thenGotExpected() { String s = String.format( "Output of 25.09878 with Precision 2: %.2f", 25.09878); assertEquals("Output of 25.09878 with Precision 2: 25.10", s); String s2 = String.format( "Output of general conversion type with Precision 2: %.2b", true); assertEquals("Output of general conversion type with Precision 2: tr", s2); }

7. Argument Index

As mentioned previously, theargument_index is an integer that indicates the position of the argument in the argument list. 1$ indicates the first argument, 2$ the second argument, and so on.

Also, there is another way to reference arguments by position, by using the ‘<‘ (‘\u003c') flag, which means the argument from the previous format specifier will be re-used. For example, these two statements would produce the identical output:

@Test public void whenSpecifyArgumentIndex_thenGotExpected() { Calendar c = Calendar.getInstance(); String s = String.format("The date is: %tm %1$te,%1$tY", c); assertEquals("The date is: 12 10,2017", s); s = String.format("The date is: %tm %
    

8. Other Ways of Using Formatter

Till now we saw the use of format() method of the Formatter class. We can also create a Formatter instance, and use that to invoke the format() method.

We can create an instance by passing in an Appendable, OutputStream, File or file name. Based on this, the formatted String is stored in an Appendable, OutputStream, File respectively.

Let's see an example of using it with an Appendable. We can use it with others in the same way.

8.1. Using Formatter With Appendable

Let's create a StringBuilder instance sb, and create a Formatter using it. Then we'll invoke format() to format a String:

@Test public void whenCreateFormatter_thenFormatterWithAppendable() { StringBuilder sb = new StringBuilder(); Formatter formatter = new Formatter(sb); formatter.format("I am writting to a %s Instance.", sb.getClass()); assertEquals( "I am writting to a class java.lang.StringBuilder Instance.", sb.toString()); }

9. Conclusion

In this article, we saw the formatting facilities provided by the java.util.Formatter class. We saw various syntax that can be used to format the String and the conversion types that can be used for different data types.

As usual, the code for the examples we saw can be found over on Github.