Использование StringTemplate: часть 1 «Введение в StringTemplate»

Обратите внимание: я привожу примеры SQL, потому что они могут быть короткими и простыми для понимания. Как уже отмечалось, не рекомендуется создавать SQL со строками независимо от используемой техники.

Процитируем домашнюю страницу StringTemplate : «StringTemplate — это шаблонизатор Java для генерации исходного кода, веб-страниц, электронных писем или любого другого форматированного текста».

Отлично, но что такое «движок шаблонов»?
          Механизм шаблонов (также известный как процессор шаблонов или анализатор шаблонов) — это программный компонент, который предназначен для объединения одного или нескольких шаблонов с моделью данных для создания одного или нескольких документов результатов ( Википедия ). Для нас с вами это означает, что механизм шаблонов — это альтернативный способ создания сложного текста. То, что я чувствую, — это полезность. Прежде чем мы углубимся в это, давайте рассмотрим несколько примеров традиционной конструкции String в Java.

Сначала у нас есть старый надежный оператор «+».

String message = "Hello" + " World"; 

Пока удобно для небольших конкатенаций. Это становится настоящей болью, когда количество встроенных переменных увеличивается.   

    String strSQL = "UPDATE customers SET customerName='" + name
         + "', customerAddress='" + address
         + "', customerEmail = '”+ email + "
         + "customerNumber = " + phone
         + " customerPurchase = " + purchase
         + "' WHERE id=" + 12;

String new419 = "Hello "
     + "Dear, " + name + ", \n"
     + "Permit me to inform you of my desire of "
     + "going into business relationship with you. "
     + "I have the believe you are a reputable "
     + "and responsible and trustworthy person \n"
     + "I can do business with from the little"
     + "information so far I gathered about you "
     + "during my search for a partner and by matter "
     + "of trust I must not hesitate to confide "
     + "in you for this simple and sincere business. ";

Далее у нас есть StringBuilder. Обычно рекомендуется использовать StringBuilder из-за его профиля производительности.

    StringBuilder sqlBuilder = new StringBuilder(
         "UPDATE customers SET customerName='").append(name).append(
         "', customerAddress='").append(address).append(
         "', customerEmail = '").append(email).append(
         "', customerNumber = '").append(phone).append(
         "', customerPurchase = '").append(purchase).append(
         "' WHERE id=").append(12);

К сожалению, это не делает создание строки значительно проще. 

Наконец мы отформатировали текст .

// Explicit argument indices may be used to re-order output.
String.format("%4$2s %3$2s %2$2s %1$2s", "a", "b", "c", "d");
>> d c b a

// Optional locale as the first argument can be used to get
// locale-specific formatting of numbers. The precision and width can be given
// to round and align the value.

String.format(Locale.FRANCE, "e = %+10.4f", Math.E);

>> e = +2,7183

// The '(' numeric flag may be used to format negative numbers with
// parentheses rather than a minus sign. Group separators are
// automatically inserted.

String.format("Amount gained or lost since last statement: $ %(,.2f",balanceDelta);

>> Amount gained or lost since last statement: $ (6,217.58)

Формат мощный, но масштабируется только до нескольких параметров. Это не потому, что есть какой-то программный предел для класса Format, а больше практичности. Отслеживать сто параметров по их индексу было бы довольно сложно.

Шаблоны, лучший способ.

Шаблон — это просто документ с «заполнителями». Эти «заполнители» являются выражениями, которые сообщают шаблонному движку, куда помещать данные. Все (все в порядке) пробелы и символы перевода строки соблюдаются. Это также имеет приятное преимущество отделения форматирования (представления) от данных. Вот простой однострочный пример:

     StringTemplate query = new StringTemplate(
         "UPDATE customers SET customerName='$customer$'," +
         " customerAddress='$address$' WHERE id=$id$");

    query.setAttribute("customer", "Frank");
    query.setAttribute("address", "1313 Mocking Bird Lane");
    query.setAttribute("id", "4453");

    System.out.println(query);

Выход:

    UPDATE customers SET customerName='Frank', customerAddress='1313 Mocking Bird Lane' WHERE id=4453 

Как видите, «заполнители» ограничены $ … $ (или <…>, если вы того пожелаете). Таким образом, это напоминает подстановку переменных в таких языках, как PHP или bash. Имя внутри разделителей используется для поиска правильного фрагмента данных. Наличие имен важно для поддержания читабельности. Это также позволяет помещать данные в шаблон в любом порядке. Это был пример из одной строки. Когда вы получите многострочный текст, вы, вероятно, захотите использовать файл шаблона . Файл шаблона представляет собой простой текстовый документ, который содержит полностью отформатированную версию желаемого результата. $ … $ атрибуты размещаются в документе, чтобы указать части, которые вы хотите заменить позже StringTemplate.

    StringTemplateGroup templateGroup = new StringTemplateGroup("spam group", "templates");
    StringTemplate spam419 = templateGroup.getInstanceOf("spam419");
    spam419.setAttribute("to", "Collin");
    spam419.setAttribute("to_addr", "[email protected]");
    spam419.setAttribute("from", "Ima Spammer");
    spam419.setAttribute("from_addr", "[email protected]");

    System.out.println(spam419.toString());