Вступление
В Java существует несколько способов форматирования строк. Некоторые из них старой школы и заимствованы непосредственно из старой классики (например, printf из C), в то время как другие больше соответствуют духу объектно-ориентированного программирования, например, класс MessageFormat .
В этой статье мы рассмотрим несколько из этих подходов. Мы покажем некоторые особенности того, как можно использовать каждую из техник и в каких обстоятельствах. Используя эти знания, вы будете знать, как подходить к форматированию строк и какие методы использовать.
System.out.printf()
Давайте начнем со старой классики, printf() . Как упоминалось ранее, printf() происходит из языка программирования C и расшифровывается как формат печати . Под капотом printf() использует java.util.Форматер , о котором мы поговорим позже.
То, как работает printf () , можно объяснить его аргументами. Наиболее распространенный способ использования printf() заключается в следующем:
System.out.printf(String format, String... arguments);
Мы видим, что метод ожидает формат и vararg аргументы . Аргумент format определяет способ форматирования строки – шаблон для конечного результата.
Например, вы можете напечатать десятичное число с точностью до семи знаков после запятой или число в шестнадцатеричном представлении. Или у вас может быть предопределенное сообщение для приветствия пользователей, но вы хотели бы отформатировать его, чтобы включить имя пользователя.
аргументы vararg удобно ожидает аргументы (т. Е. Значения) для строки шаблона. Например, если шаблон содержит заполнители для двух чисел, метод printf() также будет ожидать два числа в качестве аргументов :
System.out.printf("%d %d", 42, 23);
Мы поместили два символа %d в строку шаблона. Эти два символа представляют собой заполнители для определенного типа значений. Например, %d является заполнителем для десятичного числового значения. Поскольку у нас их два, мы должны передать два аргумента, соответствующих числовым значениям, таким как 42 и 23 .
Выполнение этого кода приведет к:
42 23
Спецификаторы Формата
С помощью printf () вы можете печатать такие значения , как числа, строки, даты и т.д. Чтобы метод знал, что именно вы пытаетесь распечатать, вам необходимо указать спецификатор формата для каждого из значений. Давайте рассмотрим пример:
System.out.printf("Hello, %s!", "reader");
В случае выполнения этот код выведет Привет, читатель на консоль. Символ %s представляет спецификатор формата для строк, аналогично тому, как %d представляет спецификатор формата для десятичных чисел.
Существует множество спецификаторов формата, которые мы можем использовать. Вот некоторые из наиболее распространенных:
- %c – Символ
- %d – Десятичное число (основание 10)
- %e – Экспоненциальное число с плавающей запятой
- %f – Число с плавающей запятой
- %i – Целое число (основание 10)
- %o – Восьмеричное число (основание 8)
- %s – Строка
- %u – Десятичное (целое) число без знака
- %x – Шестнадцатеричное число (основание 16)
- %t – Дата/время
- %n – Новая строка
Если мы хотим напечатать, например, символ и восьмеричное число, мы будем использовать %c и %o спецификаторы соответственно. Вы можете заметить что-то необычное: спецификатор новой строки. Если вы не привыкли к поведению printf () из C, может показаться немного странным указывать такие вещи.
Ну, printf() по умолчанию не пишет новую строку. На самом деле, по умолчанию он почти ничего не делает. В принципе, если вы хотите, чтобы что-то произошло, вы должны сделать это сами.
То есть – если у нас есть несколько операторов printf() без спецификатора новой строки:
System.out.printf("Hello, %s!", "Michael Scott");
System.out.printf("Hello, %s!", "Jim");
System.out.printf("Hello, %s!", "Dwight");
Результатом было бы:
Hello, Michael Scott!Hello, Jim!Hello, Dwight!
Хотя, если мы включим символ новой строки:
System.out.printf("Hello, %s!%n", "Michael Scott");
System.out.printf("Hello, %s!%n", "Jim");
System.out.printf("Hello, %s!%n", "Dwight");
Тогда результат был бы:
Hello, Michael Scott! Hello, Jim! Hello, Dwight!
Примечание: %n – это специальный формат, который может быть либо \r\n , либо просто \n . \n является фактическим символом новой строки, в то время как \r является символом возврата каретки. Как правило, рекомендуется использовать \n , поскольку он работает должным образом во всех системах, в отличие от %n , который можно понимать как один из двух. Подробнее об этом позже.
Escape-символы
В дополнение к описанным выше спецификаторам формата существует еще один тип символов форматирования: Escape-символы.
Давайте представим, что мы хотим напечатать символ " с помощью printf() . Мы можем попробовать что-то вроде:
System.out.printf(""");
Если вы попытаетесь запустить это, ваш компилятор наверняка выдаст исключение. Если вы посмотрите внимательно, даже код, который выделяет код на этой странице, выделит ); как строку, а не закрытую скобку метода.
Произошло то, что мы попытались напечатать символ, который имеет особое, скрытое значение. Кавычки используются для обозначения начала и конца строки.
Мы начали и закончили строку "" , после чего открыли другую " , но не закрыли ее. Это делает печать зарезервированных символов, подобных этому , невозможной при использовании этого подхода.
Способ обойти это – сбежать . Чтобы напечатать специальные символы (такие как " ) напрямую, нам сначала нужно избежать его эффектов, а в Java это означает добавление к нему обратной косой черты ( \ ). Чтобы законно напечатать кавычки на Java, мы бы сделали следующее:
System.out.printf("\"");
Комбинация \ и " конкретно указывает компилятору, что мы хотели бы вставить символ " в это место и что он должен рассматривать " как конкретное значение, а не зарезервированный символ.
Применение escape-символа \ может вызвать различные эффекты, основанные на последующем. Передача обычного символа (не зарезервированного) ничего не даст, и \ будет рассматриваться как значение.
Хотя некоторые комбинации (также называемые командами) имеют другое значение для компилятора:
- \b – Вставить пробел
- \f – Первый символ следующей строки начинается справа от последнего символа текущей строки
- \n – Вставить новую строку
- \r – Вставить возврат каретки
- \t – Вставка вкладки
- \\ – Вставить обратную косую черту
- %% – Вставить знак процента
Таким образом, вы бы использовали \n для печати разделителя строк на консоль, эффективно начиная любое новое содержимое с начала следующей строки. Аналогично, для добавления вкладок вы бы использовали спецификатор \t .
Возможно, вы заметили %% в качестве последней комбинации.
Почему это так? Почему \% просто не используется?
Символ % уже является escape-символом специально для метода printf () . За ними следуют такие символы, как d , i , f и т.д., форматер во время выполнения знает, как обрабатывать эти значения.
Однако символ \ предназначен для компилятора. Он указывает, куда и что вставлять. Команда \% просто не определена, и мы используем % escape – символ, чтобы избежать эффекта последующего % символа-если это имеет смысл.
Для компилятора % не является специальным символом, но \ является. Кроме того, это условно, что специальные символы сами убегают. \ сбегает \ и % сбегает % .
Основное Использование
Давайте отформатируем строку с несколькими аргументами разных типов:
System.out.printf("The quick brown %s jumps %d times over the lazy %s.\n", "fox", 2, "dog");
Результатом будет:
The quick brown fox jumps 2 times over the lazy dog.
Поплавок и двойная точность
С помощью printf () мы можем определить пользовательскую точность для чисел с плавающей запятой:
double a = 35.55845;
double b = 40.1245414;
System.out.printf("a = %.2f b = %.4f", a, b);
Поскольку %f используется для поплавков, мы можем использовать его для печати double s. Однако, добавив .n , где n – количество знаков после запятой, мы можем определить пользовательскую точность.
Выполнение этого кода дает:
a = 35.56 b = 40.1245
Заполнение Формата
Мы также можем добавить заполнение, включая переданную строку:
Git Essentials
Ознакомьтесь с этим практическим руководством по изучению Git, содержащим лучшие практики и принятые в отрасли стандарты. Прекратите гуглить команды Git и на самом деле изучите это!
System.out.printf("%10s\n", "stack");
Здесь после символа % мы передали число и спецификатор формата. В частности, нам нужна строка с 10 символы, за которыми следует новая строка. Поскольку stack содержит только 5 символов, еще 5 добавляются в качестве дополнения, чтобы “заполнить” строку целевым символом:
stack
Вместо этого вы также можете добавить отступ справа:
System.out.printf("%-10s\n", "stack");
Место действия
Мы также можем передать Locale в качестве первого аргумента, отформатировав строку в соответствии с ним:
System.out.printf(Locale.US, "%,d\n", 5000); System.out.printf(Locale.ITALY, "%,d\n", 5000);
Это приведет к получению двух целых чисел разного формата:
5,000 5.000
Индекс Аргументов
Если индекс аргумента не указан, аргументы будут просто следовать порядку присутствия в вызове метода:
System.out.printf("First argument is %d, second argument is %d", 2, 1);
Это привело бы к:
First argument is 2, argument number is 1
Однако после % escape-символа и перед спецификатором формата мы можем добавить другую команду. $n укажет индекс аргумента:
System.out.printf("First argument is %2$d, second argument is %1$d", 2, 1);
Здесь 2$ находится между % и d . 2$ указывает, что мы хотели бы прикрепить второй аргумент из списка аргументов к этому спецификатору. Аналогично, 1$ указывает, что мы хотели бы присоединить первый аргумент из списка к другому указанному.
Выполнение этого кода приводит к:
First argument is 1, second argument is 2
Вы можете указать обоим спецификаторам на один и тот же аргумент. В нашем случае это означало бы, что мы используем только один аргумент, указанный в списке. Это совершенно нормально, хотя нам все равно придется указать все аргументы, присутствующие в строке шаблона:
System.out.printf("First argument is %2$d, second argument is %2$d", 2, 1);
Это приведет к:
First argument is 1, second argument is 1
System.out.формат()
Прежде чем говорить о System.out.format() , давайте кратко остановимся на System.out .
Все системы UNIX имеют три основных канала – стандартный входной канал ( stdin ), стандартный выходной канал ( stdout ) и стандартный канал ошибок ( stderr ). Поле out соответствует каналу stdout и имеет тип PrintStream .
Этот класс имеет множество различных методов для печати форматированных текстовых представлений в поток, некоторые из которых являются format() и printf() .
Согласно документации, они оба ведут себя совершенно одинаково . Это означает, что между ними нет разницы, и их можно использовать для одних и тех же результатов. Все, что мы до сих пор говорили о printf () , также работает для format() .
Как printf () , так и System.out.format() печать в канал stdout , который обычно нацелен на консоль/терминал.
Строка.формат()
Другим способом форматирования строк является метод String.format() , который внутренне также использует java.util.Форматер , который мы рассмотрим в следующем разделе.
Основным преимуществом String.format() над printf() является его тип возврата – он возвращает Строку . Вместо того, чтобы просто печатать содержимое в стандартном выходном канале и не иметь возвращаемого типа ( void ), как это делает printf () , String.format() используется для форматирования строки, которую можно использовать или повторно использовать в будущем:
String formattedString = String.format("Local time: %tT", Calendar.getInstance());
Теперь вы можете делать все, что захотите, с отформатированной строкой . Вы можете распечатать его, сохранить в файл, изменить или сохранить в базе данных. Печать этого приведет к:
Local time: 16:01:42
Метод String.format() использует тот же базовый принцип, что и метод printf () . Оба внутренне используют класс Форматирования для фактического форматирования строк. Таким образом, все, что сказано для printf () , также относится к методу String.format () .
Использование printf() , String.format() или Форматирования по сути одно и то же. Единственное, что отличается, – это тип возврата – printf() выводит в стандартный поток вывода (обычно на вашу консоль) и String.format() возвращает отформатированную строку .
Тем не менее, String.format() более универсален, поскольку вы действительно можете использовать результат более чем одним способом.
Класс форматирования
Поскольку все вышеперечисленные методы по своей сути вызывают Форматер , знание только одного означает, что вы знаете их все.
Использование Форматирования очень похоже на другие методы, показанные ранее. Самая большая разница заключается в том, что для его использования необходимо создать экземпляр Форматера объекта:
Formatter f = new Formatter();
f.format("There are %d planets in the Solar System. Sorry, Pluto", 8);
System.out.println(f);
В связи с этим возникает вопрос:
Почему бы мне не всегда просто использовать предыдущие методы, поскольку они более лаконичны?
Есть еще одно важное различие, которое делает класс Форматер довольно гибким:
StringBuilder sb = new StringBuilder();
Formatter formatter = new Formatter(sb);
formatter.format("%d, %d, %d...\n", 1, 2, 3);
Вместо работы только с String s, Форматер также может работать с StringBuilder , что позволяет (повторно)эффективно использовать оба класса.
На самом деле, Форматер способен работать с любым классом, реализующим Добавляемый интерфейс. Одним из таких примеров является вышеупомянутый StringBuilder , но другие примеры включают такие классы, как BufferedWriter , Файловая машина , Поток печати , PrintWriter , StringBuffer и т.д. Полный список можно найти в документации .
Наконец, все спецификаторы формата, escape-символы и т. Д. Также допустимы для класса форматирования , Поскольку это основная логика форматирования строк во всех трех случаях: String. format() , printf () и Форматирование .
Формат сообщения
Наконец, давайте покажем один последний метод форматирования, который не использует Форматер под капотом.
Формат сообщения был создан для создания и предоставления объединенных сообщений нейтральным к языку способом. Это означает, что форматирование будет одинаковым, независимо от того, используете ли вы Java, Python или какой-либо другой язык, поддерживающий MessageFormat .
Формат сообщения расширяет абстрактный Формат класс, точно так же, как Формат даты и Формат числа . Класс Format предназначен для форматирования объектов, зависящих от языкового стандарта, в строки.
Давайте рассмотрим хороший пример, любезно предоставленный Формат сообщения s документация .
int planet = 7;
String event = "a disturbance in the Force";
String result = MessageFormat.format(
"At {1, time} on {1, date}, there was {2} on planet {0, number, integer}.",
planet, new Date(), event
);
Кодовый кредит: Документы Oracle
На выходе получается:
At 11:52 PM on May 4, 2174, there was a disturbance in the Force on planet 7.
Вместо спецификаторов процента, которые мы видели до сих пор, здесь мы используем фигурные скобки для каждого из аргументов. Давайте возьмем первый аргумент, {1, время} . Число 1 представляет индекс аргумента, который следует использовать вместо него. В нашем случае аргументами являются планета , новая дата () и событие .
Вторая часть, время , относится к типу значения. Типы форматов верхнего уровня: число , дата , время и выбор . Для каждого из значений можно сделать более конкретный выбор, например, с помощью {0, число, целое число} , в котором говорится, что значение следует рассматривать не только как число, но и как целое число.
Полный набор типов и подтипов форматов можно найти в документации .
Вывод
В этой статье мы рассмотрели довольно много способов форматирования строк в ядре Java.
Каждая из техник, которые мы показали, имеет свою собственную причину существования. printf() , например, напоминает метод C старой школы с тем же названием.
Другие подходы, такие как Форматирование или Формат сообщений , предлагают более современный подход, который использует некоторые преимущества объектно-ориентированного программирования.
Каждая техника имеет конкретные варианты использования, поэтому, надеюсь, вы сможете знать, когда использовать каждую из них в будущем.