Panduan untuk java.util.Formatter

1. Ikhtisar

Dalam artikel ini, kita akan membahas pemformatan String di Java menggunakan kelas java.util.Formatter , yang menyediakan dukungan untuk justifikasi dan penyelarasan tata letak.

2. Cara Menggunakan Formatter

Ingat printf C ? Memformat String di Java terasa sangat mirip.

Metode format () dari Formatter diekspos melalui metode statis dari kelas String . Metode ini menerima String template dan daftar argumen untuk mengisi template dengan:

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

String yang dihasilkan adalah:

"Hello Folks, welcome to Baeldung !"

Template adalah String yang berisi beberapa teks statis dan satu atau lebih penentu format, yang menunjukkan argumen mana yang akan ditempatkan pada posisi tertentu.

Dalam kasus ini, ada penentu format tunggal % s , yang diganti dengan argumen yang sesuai.

3. Format Penentu

3.1. Sintaks Umum

Sintaks penentu format untuk tipe Umum, Karakter, dan Numerik adalah:

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

Specifier argument_index, flag, width , dan precision adalah opsional.

  • bagian argument_index adalah integer i - menunjukkan bahwa argumen ke - i dari daftar argumen harus digunakan di sini
  • flags adalah sekumpulan karakter yang digunakan untuk mengubah format keluaran
  • width adalah bilangan bulat positif yang menunjukkan jumlah minimum karakter yang akan ditulis ke output
  • presisi adalah bilangan bulat yang biasanya digunakan untuk membatasi jumlah karakter, yang perilaku spesifiknya bergantung pada konversi
  • adalah bagian wajib. Ini adalah karakter yang menunjukkan bagaimana argumen harus diformat. Kumpulan konversi yang valid untuk argumen tertentu bergantung pada tipe data argumen

Dalam contoh kami di atas, jika kami ingin menentukan jumlah argumen secara eksplisit, kami dapat menulisnya menggunakan 1 $ dan 2 $ indeks argumen.

Keduanya menjadi argumen pertama dan kedua masing-masing:

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

3.2. Untuk Representasi Tanggal / Waktu

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

Sekali lagi argument_index, flags , dan width adalah opsional.

Mari kita ambil contoh untuk memahami ini:

@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); }

Di sini, untuk setiap penentu format, argumen pertama akan digunakan, oleh karena itu 1 $ . Di sini jika kita melewatkan argument_index untuk penentu format ke-2 dan ke-3, ia mencoba menemukan 3 argumen, tetapi kita perlu menggunakan argumen yang sama untuk semua 3 penentu format.

Jadi, tidak apa-apa jika kita tidak menentukan argumen _index untuk yang pertama, tetapi kita perlu menentukannya untuk dua lainnya.

The flag disini terdiri dari dua karakter. Dimana karakter pertama selalu berupa 't' atau 'T' . Karakter kedua tergantung pada bagian Kalender mana yang akan ditampilkan.

Dalam contoh kita, format pertama penentu tm , menunjukkan bulan diformat sebagai dua digit, te menunjukkan hari dalam sebulan dan tY menunjukkan Tahun diformat sebagai empat digit.

3.3. Format Penentu Tanpa Argumen

%[flags][width]conversion

Bendera dan lebar opsional sama seperti yang ditentukan di bagian atas.

Konversi yang diperlukan adalah karakter atau String yang menunjukkan konten yang akan dimasukkan ke dalam output. Saat ini, hanya '%' dan baris baru 'n' yang dapat dicetak menggunakan ini:

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

Di dalam format () , jika kita ingin mencetak '%' - kita perlu menghindarinya dengan menggunakan '%%' .

4. Konversi

Sekarang mari kita gali setiap detail sintaks Format Specifier, dimulai dengan konversi . Perhatikan bahwa Anda dapat menemukan semua detail di Formatter javadocs.

Seperti yang kami perhatikan pada contoh di atas, bagian konversi diperlukan di semua penentu format, dan dapat dibagi menjadi beberapa kategori.

Mari kita lihat masing-masing dengan mengambil contoh.

4.1. Umum

Digunakan untuk semua tipe argumen. Konversi umum adalah:

  1. 'b' atau 'B' - untuk nilai Boolean
  2. 'h' atau 'H' - untuk HashCode
  3. 's' atau 'S' - untuk String , jika null , ini akan menampilkan "null", else arg.toString ()

Kami sekarang akan mencoba menampilkan nilai boolean dan String , menggunakan konversi yang sesuai:

@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. Karakter

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.