String.format w Javie: printf i specyfikatory formatu

Dwa sposoby formatowania

Java formatuje napisy na podstawie szablonu zawierającego specyfikatory formatu (miejsca oznaczone %) oraz wartości, które mają w nie trafić. Są dwa punkty wejścia i mają identyczną składnię:

• String.format(template, values...) zwraca nowy String.
• System.out.printf(template, values...) od razu wypisuje wynik.

public class Main {
    public static void main(String[] args) {
        String name = "Ada";
        int age = 36;

        String line = String.format("%s is %d years old", name, age);
        System.out.println(line);

        System.out.printf("%s is %d years old%n", name, age);
    }
}

Oba dają ten sam tekst. String.format go zwraca, żeby dało się go zapisać; printf wypisuje go na konsolę. Zwróć uwagę na %n na końcu szablonu printf: to znak nowej linii niezależny od platformy (w napisach formatujących używaj go zamiast \n).

Najczęstsze specyfikatory

Każdy specyfikator zaczyna się od % i kończy literą, która mówi, jakiego rodzaju wartości się spodziewać:

public class Main {
    public static void main(String[] args) {
        System.out.printf("string: %s%n", "hello");
        System.out.printf("integer: %d%n", 42);
        System.out.printf("float: %f%n", 3.14);
        System.out.printf("boolean: %b%n", true);
        System.out.printf("char: %c%n", 'A');
        System.out.printf("hex: %x%n", 255);
        System.out.printf("percent sign: %%%n");
    }
}

Na co dzień używa się trzech: %s (dowolna wartość, przez jej toString), %d (liczby całkowite) i %f (liczby dziesiętne). Użyj %%, aby wypisać sam znak procentu. Przekazanie złego typu, np. String do %d, rzuca w czasie działania wyjątek IllegalFormatConversionException.

Kontrola miejsc po przecinku

%f domyślnie pokazuje sześć miejsc po przecinku, co rzadko jest tym, czego chcesz. Wstaw .N przed f, żeby ustalić precyzję (wartość jest zaokrąglana):

public class Main {
    public static void main(String[] args) {
        double price = 3.14159;

        System.out.printf("%f%n", price);     // 3.141590
        System.out.printf("%.2f%n", price);   // 3.14
        System.out.printf("%.0f%n", price);   // 3
    }
}

Dodaj flagę przecinka, żeby duże liczby miały separatory grup cyfr:

public class Main {
    public static void main(String[] args) {
        double total = 1234567.891;
        System.out.printf("%,.2f%n", total);   // 1,234,567.89
    }
}

Szerokość i wypełnienie

Liczba między % a literą typu ustala minimalną szerokość pola i dopełnia je spacjami, żeby kolumny się wyrównały. Poprzedzające - wyrównuje do lewej; poprzedzające 0 dopełnia liczby zerami:

public class Main {
    public static void main(String[] args) {
        System.out.printf("[%10s]%n", "hi");    // right-aligned in 10 cols
        System.out.printf("[%-10s]%n", "hi");   // left-aligned
        System.out.printf("[%05d]%n", 42);      // zero-padded to width 5
    }
}

Dzięki temu sformatowane tabele i wyrównane raporty są czytelne, zwłaszcza gdy wypisujesz każdy wiersz w pętli for:

public class Main {
    public static void main(String[] args) {
        String[] names = {"Ada", "Boris", "Chen"};
        int[] scores = {95, 8, 142};

        for (int i = 0; i < names.length; i++) {
            System.out.printf("%-8s %5d%n", names[i], scores[i]);
        }
    }
}

%-8s wyrównuje imiona do lewej w kolumnie o szerokości 8, a %5d wyrównuje wyniki do prawej w kolumnie o szerokości 5, więc liczby są wyrównane niezależnie od liczby cyfr.

Kolejność argumentów

Domyślnie specyfikatory pobierają wartości od lewej do prawej. Możesz powtórzyć albo przestawić wartość przez N$ (indeks liczony od jedynki), co przydaje się, gdy ta sama wartość występuje dwa razy:

public class Main {
    public static void main(String[] args) {
        System.out.printf("%1$s, %1$s, hello %2$s%n", "echo", "world");
    }
}

%1$s za każdym razem odnosi się do pierwszego argumentu, więc echo wypisuje się dwa razy.

Metoda formatted()

Od Javy 15 każdy napis ma metodę instancji formatted. To ten sam mechanizm co String.format, tylko zapisany jako wywołanie metody na szablonie:

public class Main {
    public static void main(String[] args) {
        String msg = "%s scored %d".formatted("Ada", 95);
        System.out.println(msg);
    }
}

Szczególnie dobrze łączy się z blokami tekstowymi (wielolinijkowe napisy w potrójnych cudzysłowach) przy budowaniu większych sformatowanych wyników.

Kiedy nie używać String.format

Przy prostym, jednorazowym łączeniu zwykła konkatenacja przez + jest czytelniejsza i szybsza:

String greeting = "Hi, " + name + "!";   // simpler than String.format here

Po String.format / printf sięgaj, gdy potrzebujesz prawdziwego formatowania: stałej liczby miejsc po przecinku, wypełnienia, wyrównania, grupowania cyfr, a nie tylko sklejenia kilku wartości.

Dalej: operatory

Formatowanie zamienia wartości na tekst. Żeby w ogóle obliczyć te wartości, potrzebujesz operatorów Javy: arytmetycznych, porównania i logicznych. O nich jest następna strona.