Як замінити набір жетонів у Java String?

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

У мене також є змінні String для імені, номера рахунка-фактури та строку - який найкращий спосіб замінити маркери в шаблоні змінними?

(Зверніть увагу, що якщо змінна містить маркер, її НЕ слід замінювати).

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

Найефективнішим способом буде використання матчера для постійного пошуку виразів та заміни їх, а потім додавання тексту до конструктора рядків:

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

Я дійсно не думаю, що вам для цього не потрібно використовувати двигун-шаблон або щось подібне. Ви можете використовувати String.formatметод, як-от так:

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

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

На жаль, зручний метод String.format, згаданий вище, доступний лише починаючи з Java 1.5 (що сьогодні має бути досить стандартним, але ви ніколи не знаєте). Замість цього ви можете також використовувати клас Java MessageFormat для заміни заповнювачів.

Він підтримує заповнювачі у формі "{number}", тож ваше повідомлення буде виглядати як "Привіт {0} Будь ласка, знайдіть додаток {1}, що належить {2}". Ці рядки можна легко екстерналізувати за допомогою ResourceBundles (наприклад, для локалізації з декількома локалями). Заміна проводиться методом static'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));

Ви можете спробувати використати бібліотеку шаблонів на зразок швидкості Apache.

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

Вихід буде:

Привіт Марку. Прошу знайти доданий рахунок-фактуру 42123, який має вийти 6 червня 2009 року.

Ви можете використовувати бібліотеку шаблонів для складної заміни шаблонів.

FreeMarker - дуже хороший вибір.

http://freemarker.sourceforge.net/

Але для простого завдання вам може допомогти простий клас корисності.

org.apache.commons.lang3.text.StrSubstitutor

Він дуже потужний, налаштовується та простий у використанні.

Цей клас займає фрагмент тексту та замінює всі змінні в ньому. За замовчуванням визначення змінної - $ {variaName}. Префікс і суфікс можна змінювати за допомогою конструкторів та встановлених методів.

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

Наприклад, якщо ви хочете замінити змінну системного середовища на рядок шаблону, ось код:

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

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

Вихід: Привіт, приєднуйтесь! У вас є 10 повідомлень "

Це залежить від того, де знаходяться фактичні дані, які ви хочете замінити. Можливо, у вас є така карта:

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.

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

Моє рішення щодо заміни лексем у стилі $ {змінний} (натхненний відповідями тут та 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();
}

http://github.com/niesfisch/tokenreplacer

З бібліотекою Apache Commons ви можете просто використовувати Stringutils.replaceEach :

public static String replaceEach(String text,
                             String[] searchList,
                             String[] replacementList)

З документації :

Замінює всі виникнення рядків у іншій рядку.

Нульова посилання, передана на цей метод, є неоперативною, або якщо будь-яка "рядок пошуку" або "рядок для заміни" є нульовою, ця заміна буде проігнорована. Це не повториться. Для повторення заміни викликайте метод перевантаження.

 StringUtils.replaceEach(null, *, *)        = null

  StringUtils.replaceEach("", *, *)          = ""

  StringUtils.replaceEach("aba", null, null) = "aba"

  StringUtils.replaceEach("aba", new String[0], null) = "aba"

  StringUtils.replaceEach("aba", null, new String[0]) = "aba"

  StringUtils.replaceEach("aba", new String[]{"a"}, null)  = "aba"

  StringUtils.replaceEach("aba", new String[]{"a"}, new String[]{""})  = "b"

  StringUtils.replaceEach("aba", new String[]{null}, new String[]{"a"})  = "aba"

  StringUtils.replaceEach("abcde", new String[]{"ab", "d"}, new String[]{"w", "t"})  = "wcte"
  (example of how it does not repeat)

StringUtils.replaceEach("abcde", new String[]{"ab", "d"}, new String[]{"d", "t"})  = "dcte"

FYI

У новій мові Kotlin ви можете використовувати "String Templates" у своєму вихідному коді безпосередньо, жодна стороння бібліотека чи механізм шаблонів не потребують заміни змінної.

Це особливість самої мови.

Дивіться: https://kotlinlang.org/docs/reference/basic-types.html#string-templates

Раніше я вирішував подібну проблему за допомогою StringTemplate та Groovy Templates .

Зрештою, рішення про використання шаблонного двигуна чи ні має базуватися на таких чинниках:

• Чи буде у вас багато таких шаблонів у додатку?
• Вам потрібна можливість змінювати шаблони без перезавантаження програми?
• Хто підтримуватиме ці шаблони? Java-програміст чи бізнес-аналітик, що бере участь у проекті?
• Чи буде вам потрібно вміти вводити логіку у ваші шаблони, як умовний текст на основі значень змінних?
• Вам потрібна можливість включення інших шаблонів до шаблону?

Якщо будь-яке з перерахованого вище стосується вашого проекту, я б розглядав можливість використання механізму шаблонів, більшість з яких забезпечує цю функціональність та інше.

я використав

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

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

Далі замінюються змінні форми <<VAR>>із значеннями, знайденими з карти. Ви можете протестувати його онлайн тут

Наприклад, із наступним рядком введення

BMI=(<<Weight>>/(<<Height>>*<<Height>>)) * 70
Hi there <<Weight>> was here

та наступні змінні значення

Weight, 42
Height, HEIGHT 51

виводить наступне

BMI=(42/(HEIGHT 51*HEIGHT 51)) * 70

Hi there 42 was here

Ось код

  static Pattern pattern = Pattern.compile("<<([a-z][a-z0-9]*)>>", Pattern.CASE_INSENSITIVE);

  public static String replaceVarsWithValues(String message, Map<String,String> varValues) {
    try {
      StringBuffer newStr = new StringBuffer(message);
      int lenDiff = 0;
      Matcher m = pattern.matcher(message);
      while (m.find()) {
        String fullText = m.group(0);
        String keyName = m.group(1);
        String newValue = varValues.get(keyName)+"";
        String replacementText = newValue;
        newStr = newStr.replace(m.start() - lenDiff, m.end() - lenDiff, replacementText);
        lenDiff += fullText.length() - replacementText.length();
      }
      return newStr.toString();
    } catch (Exception e) {
      return message;
    }
  }


  public static void main(String args[]) throws Exception {
      String testString = "BMI=(<<Weight>>/(<<Height>>*<<Height>>)) * 70\n\nHi there <<Weight>> was here";
      HashMap<String,String> values = new HashMap<>();
      values.put("Weight", "42");
      values.put("Height", "HEIGHT 51");
      System.out.println(replaceVarsWithValues(testString, values));
  }

і хоча це не вимагається, ви можете використовувати аналогічний підхід для заміни змінних у рядку властивостями з вашого файла application.properties, хоча це вже може бути зроблено:

private static Pattern patternMatchForProperties =
      Pattern.compile("[$][{]([.a-z0-9_]*)[}]", Pattern.CASE_INSENSITIVE);

protected String replaceVarsWithProperties(String message) {
    try {
      StringBuffer newStr = new StringBuffer(message);
      int lenDiff = 0;
      Matcher m = patternMatchForProperties.matcher(message);
      while (m.find()) {
        String fullText = m.group(0);
        String keyName = m.group(1);
        String newValue = System.getProperty(keyName);
        String replacementText = newValue;
        newStr = newStr.replace(m.start() - lenDiff, m.end() - lenDiff, replacementText);
        lenDiff += fullText.length() - replacementText.length();
      }
      return newStr.toString();
    } catch (Exception e) {
      return message;
    }
  }