Comment remplacer un ensemble de tokens dans une chaîne Java ?

Question

J'ai le modèle suivant String : "Hello [Name] Please find attached [Invoice Number] which is due on [Due Date]" .

J'ai également des variables de type String pour le nom, le numéro de facture et la date d'échéance. Quelle est la meilleure façon de remplacer les tokens du modèle par les variables ?

(Notez que si une variable contient un jeton, elle ne doit PAS être remplacée).

---

EDIT

Avec les remerciements de @laginimaineb et @alan-moore, Voici ma solution :

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

Je ne pense vraiment pas que vous ayez besoin d'utiliser un moteur de modèles ou quelque chose de ce genre pour cela. Vous pouvez utiliser le String.format comme suit :

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

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

Answer 2

Le moyen le plus efficace serait d'utiliser un matcheur pour trouver continuellement les expressions et les remplacer, puis d'ajouter le texte à un constructeur de chaînes :

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

Malheureusement, la méthode confortable String.format mentionnée ci-dessus n'est disponible qu'à partir de Java 1.5 (qui devrait être assez standard de nos jours, mais on ne sait jamais). Au lieu de cela, vous pouvez également utiliser la méthode Java classe MessageFormat pour remplacer les caractères de remplacement.

Il prend en charge les caractères de remplacement de la forme "{numéro}", de sorte que votre message pourrait ressembler à "Bonjour {0} Veuillez trouver ci-joint {1} qui est dû le {2}". Ces chaînes de caractères peuvent facilement être externalisées à l'aide de ResourceBundles (par exemple, pour la localisation avec plusieurs langues). Le remplacement se ferait à l'aide de la méthode statique "format" de la classe 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

Vous pouvez essayer d'utiliser une bibliothèque de modèles comme Apache Velocity.

http://velocity.apache.org/

Voici un exemple :

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

La sortie serait :

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

Answer 5

Vous pouvez utiliser la bibliothèque de modèles pour le remplacement de modèles complexes.

FreeMarker est un très bon choix.

http://freemarker.sourceforge.net/

Mais pour les tâches simples, il existe une classe utilitaire simple qui peut vous aider.

org.apache.commons.lang3.text.StrSubstitutor

Il est très puissant, personnalisable et facile à utiliser.

Cette classe prend un morceau de texte et remplace toutes les variables qu'il contient. La définition par défaut d'une variable est ${variableName}. Le préfixe et le suffixe peuvent être modifiés via les constructeurs et les méthodes set.

Les valeurs variables sont généralement résolues à partir d'une carte, mais peuvent également être également être résolues à partir des propriétés du système, ou en fournissant un personnalisée.

Par exemple, si vous voulez substituer une variable d'environnement du système dans une chaîne de modèle, voici le code :

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