Как заменить набор токенов в строке Java?

Question

У меня есть следующий шаблон строки: "Hello [Name] Please find attached [Invoice Number] which is due on [Due Date]".

У меня также есть строковые переменные для имени, номера счета и срока оплаты - как лучше заменить токены в шаблоне переменными?

(Обратите внимание, что если переменная содержит токен, ее НЕ следует заменять).

---

EDIT

Благодаря @laginimaineb и @ alan-moore, вот мое решение:

public static String replaceTokens(String text, 
                                   Map<String, String> replacements) {
    Pattern pattern = Pattern.compile("\\[(.+?)\\]");
    Matcher matcher = pattern.matcher(text);
    StringBuffer buffer = new StringBuffer();

    while (matcher.find()) {
        String replacement = replacements.get(matcher.group(1));
        if (replacement != null) {
            // matcher.appendReplacement(buffer, replacement);
            // see comment 
            matcher.appendReplacement(buffer, "");
            buffer.append(replacement);
        }
    }
    matcher.appendTail(buffer);
    return buffer.toString();
}

Answer 1

Я действительно не думаю, что вам нужно использовать шаблонизатор или что-то подобное для этого. Вы можете использовать метод String.format, например:

String template = "Hello %s Please find attached %s which is due on %s";

String message = String.format(template, name, invoiceNumber, dueDate);

Answer 2

Самый эффективный способ - использовать средство сравнения для постоянного поиска выражений и их замены, а затем добавить текст в построитель строк:

Pattern pattern = Pattern.compile("\\[(.+?)\\]");
Matcher matcher = pattern.matcher(text);
HashMap<String,String> replacements = new HashMap<String,String>();
//populate the replacements map ...
StringBuilder builder = new StringBuilder();
int i = 0;
while (matcher.find()) {
    String replacement = replacements.get(matcher.group(1));
    builder.append(text.substring(i, matcher.start()));
    if (replacement == null)
        builder.append(matcher.group(0));
    else
        builder.append(replacement);
    i = matcher.end();
}
builder.append(text.substring(i, text.length()));
return builder.toString();

Answer 3

К сожалению, упомянутый выше удобный метод String.format доступен только начиная с Java 1.5 (который должен быть довольно стандартным в наше время, но вы никогда не знаете). Вместо этого вы также можете использовать Java * класс MessageFormat для замены заполнителей.

Он поддерживает заполнители в форме '{number}', поэтому ваше сообщение будет выглядеть так: "Здравствуйте, {0} Пожалуйста, найдите прикрепленный {1}, который должен {2}" Эти строки могут быть легко выведены с помощью ResourceBundles (например, для локализации с несколькими локалями). Замена будет выполнена с использованием статического метода 'format' класса MessageFormat:

String msg = "Hello {0} Please find attached {1} which is due on {2}";
String[] values = {
  "John Doe", "invoice #123", "2009-06-30"
};
System.out.println(MessageFormat.format(msg, values));

Answer 4

Вы можете попробовать использовать библиотеку шаблонов, такую ​​как Apache Velocity.

http://velocity.apache.org/

Вот пример:

import org.apache.velocity.VelocityContext;
import org.apache.velocity.app.Velocity;

import java.io.StringWriter;

public class TemplateExample {
    public static void main(String args[]) throws Exception {
        Velocity.init();

        VelocityContext context = new VelocityContext();
        context.put("name", "Mark");
        context.put("invoiceNumber", "42123");
        context.put("dueDate", "June 6, 2009");

        String template = "Hello $name. Please find attached invoice" +
                          " $invoiceNumber which is due on $dueDate.";
        StringWriter writer = new StringWriter();
        Velocity.evaluate(context, writer, "TemplateName", template);

        System.out.println(writer);
    }
}

Вывод будет:

Hello Mark. Please find attached invoice 42123 which is due on June 6, 2009.

Answer 5

Вы можете использовать библиотеку шаблонов для замены сложных шаблонов.

FreeMarker - очень хороший выбор.

http://freemarker.sourceforge.net/

Но для простой задачи вам может помочь простой класс утилит.

org.apache.commons.lang3.text.StrSubstitutor

Это очень мощный, настраиваемый и простой в использовании.

Этот класс берет фрагмент текста и заменяет все переменные внутри. Определение переменной по умолчанию - $ {variableName}. Префикс и суффикс можно изменить с помощью конструкторов и методов набора.

Значения переменных обычно разрешаются с карты, но также могут быть разрешается из системных свойств или путем предоставления пользовательской переменной распознаватель.

Например, если вы хотите заменить системную переменную среды на строку шаблона, вот код:

public class SysEnvSubstitutor {
    public static final String replace(final String source) {
        StrSubstitutor strSubstitutor = new StrSubstitutor(
                new StrLookup<Object>() {
                    @Override
                    public String lookup(final String key) {
                        return System.getenv(key);
                    }
                });
        return strSubstitutor.replace(source);
    }
}

Answer 6

System.out.println(MessageFormat.format("Hello {0}! You have {1} messages", "Join",10L));

Выход: Привет Присоединяйтесь! У вас есть 10 сообщений "

Answer 7

String.format("Hello %s Please find attached %s which is due on %s", name, invoice, date)

Answer 8

Это зависит от того, где находятся фактические данные, которые вы хотите заменить. У вас может быть такая карта:

Map<String, String> values = new HashMap<String, String>();

содержит все данные, которые можно заменить. Затем вы можете перебрать карту и изменить все в строке следующим образом:

String s = "Your String with [Fields]";
for (Map.Entry<String, String> e : values.entrySet()) {
  s = s.replaceAll("\\[" + e.getKey() + "\\]", e.getValue());
}

Вы также можете перебрать строку и найти элементы на карте. Но это немного сложнее, потому что вам нужно проанализировать строку в поисках []. Вы можете сделать это с помощью регулярного выражения, используя Pattern и Matcher.

Answer 9

Мое решение для замены токенов в стиле $ {variable} (вдохновлено ответами здесь и Spring UriTemplate):

public static String substituteVariables(String template, Map<String, String> variables) {
    Pattern pattern = Pattern.compile("\\$\\{(.+?)\\}");
    Matcher matcher = pattern.matcher(template);
    // StringBuilder cannot be used here because Matcher expects StringBuffer
    StringBuffer buffer = new StringBuffer();
    while (matcher.find()) {
        if (variables.containsKey(matcher.group(1))) {
            String replacement = variables.get(matcher.group(1));
            // quote to work properly with $ and {,} signs
            matcher.appendReplacement(buffer, replacement != null ? Matcher.quoteReplacement(replacement) : "null");
        }
    }
    matcher.appendTail(buffer);
    return buffer.toString();
}

Answer 10

FYI

На новом языке Котлин, вы можете использовать «String Templates» в вашем исходном коде напрямую, нет необходимости в сторонней библиотеке или шаблонизаторе для замены переменных.

Это особенность самого языка.

См: https://kotlinlang.org/docs/reference/basic-types.html#string-templates