Форматирование строк в Java: String.format, printf и спецификаторы формата

Два способа форматирования

Java форматирует строки на основе шаблона, содержащего спецификаторы формата (заполнители %), плюс значения для подстановки. Есть две точки входа, и у них одинаковый синтаксис:

• String.format(template, values...) возвращает новый String.
• System.out.printf(template, values...) выводит результат напрямую.

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

Оба дают один и тот же текст. String.format возвращает его, чтобы вы могли сохранить; printf пишет его в консоль. Обратите внимание на %n в конце шаблона printf - это платформонезависимый перевод строки (в форматных строках предпочитайте его вместо \n).

Распространённые спецификаторы

Каждый спецификатор начинается с % и заканчивается буквой, которая указывает, какой тип значения ожидается:

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

Три повседневных - это %s (любое значение, через его toString), %d (целые числа) и %f (десятичные). Используйте %%, чтобы вывести буквальный знак процента. Передача неправильного типа - скажем, String в %d - выбрасывает IllegalFormatConversionException во время выполнения.

Управление десятичными знаками

%f по умолчанию использует шесть десятичных знаков, что редко вам нужно. Поставьте .N перед f, чтобы зафиксировать точность (значение округляется):

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
    }
}

Добавьте флаг запятой для разделителей групп в больших числах:

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

Ширина и выравнивание

Число между % и буквой типа задаёт минимальную ширину поля, заполняя пробелами, чтобы столбцы выравнивались. Ведущий - выравнивает по левому краю; ведущий 0 дополняет числа нулями:

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
    }
}

Именно это делает отформатированные таблицы и выровненные отчёты читаемыми:

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 выравнивает имена по левому краю в столбце шириной 8, а %5d выравнивает баллы по правому краю в столбце шириной 5, поэтому числа выстраиваются ровно независимо от количества цифр.

Порядок аргументов

По умолчанию спецификаторы потребляют значения слева направо. Вы можете повторить или переставить значение с помощью N$ (индекс с единицы), что удобно, когда одно и то же значение встречается дважды:

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

%1$s оба раза ссылается на первый аргумент, поэтому echo выводится дважды.

Метод formatted()

Начиная с Java 15, у каждой строки есть метод экземпляра formatted - тот же движок, что и у String.format, только записанный как вызов метода на шаблоне:

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

Он особенно хорошо сочетается с text blocks (многострочными строками в тройных кавычках) при построении более крупного отформатированного вывода.

Когда не стоит использовать String.format

Для простых разовых соединений обычная конкатенация через + понятнее и быстрее:

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

Прибегайте к String.format / printf, когда вам нужно настоящее форматирование - фиксированные десятичные знаки, выравнивание, отступы, группировка, - а не просто склейка пары значений.

Далее: Операторы

Форматирование превращает значения в текст. Чтобы сначала вычислить эти значения, вам нужны операторы Java - арифметические, сравнения и логические. Это следующая страница.