จะแทนที่ชุดโทเค็นใน Java String ได้อย่างไร?

ฉันมีสตริงแม่แบบต่อไปนี้: "Hello [Name] Please find attached [Invoice Number] which is due on [Due Date]".

ฉันมีตัวแปรสตริงสำหรับชื่อหมายเลขใบแจ้งหนี้และวันครบกำหนดด้วย - วิธีใดดีที่สุดในการแทนที่โทเค็นในเทมเพลตด้วยตัวแปร

(โปรดทราบว่าหากตัวแปรมีโทเค็นอยู่ก็ไม่ควรแทนที่)

แก้ไข

ขอบคุณ @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 เท่านั้น (ซึ่งน่าจะเป็นมาตรฐานที่ดีในปัจจุบัน แต่คุณไม่เคยรู้) แทนที่จะเป็นเช่นนั้นคุณอาจใช้MessageFormat คลาสของ Java เพื่อแทนที่ตัวยึดตำแหน่ง

สนับสนุนตัวยึดตำแหน่งในรูปแบบ "{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 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);
    }
}

ผลลัพธ์จะเป็น:

สวัสดีมาร์ค โปรดดูแนบใบแจ้งหนี้ 42123 ซึ่งครบกำหนดชำระในวันที่ 6 มิถุนายน 2552

คุณสามารถใช้ไลบรารีเทมเพลตสำหรับการแทนที่เทมเพลตที่ซับซ้อน

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

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

เอาท์พุท: สวัสดีเข้าร่วม! คุณมี 10 ข้อความ "

ขึ้นอยู่กับตำแหน่งของข้อมูลจริงที่คุณต้องการแทนที่ คุณอาจมีแผนที่ดังนี้:

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

มีข้อมูลทั้งหมดที่สามารถแทนที่ได้ จากนั้นคุณสามารถทำซ้ำบนแผนที่และเปลี่ยนทุกอย่างใน String ได้ดังนี้:

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

นอกจากนี้คุณยังสามารถวนซ้ำบน String และค้นหาองค์ประกอบในแผนที่ แต่นั่นซับซ้อนกว่าเล็กน้อยเพราะคุณต้องแยกวิเคราะห์ String เพื่อค้นหา [] คุณสามารถทำได้ด้วยนิพจน์ทั่วไปโดยใช้ Pattern และ Matcher

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

วิธีแก้ปัญหาของฉันสำหรับการแทนที่โทเค็นสไตล์ $ {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();
}

http://github.com/niesfisch/tokenreplacer

ด้วย Apache Commons Library คุณสามารถใช้Stringutils.replaceEach :

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

จากเอกสารประกอบ :

แทนที่สตริงที่เกิดขึ้นทั้งหมดภายในสตริงอื่น

การอ้างอิงค่าว่างที่ส่งไปยังเมธอดนี้คือ no-op หรือหาก "สตริงการค้นหา" หรือ "สตริงที่จะแทนที่" เป็นโมฆะการแทนที่นั้นจะถูกละเว้น สิ่งนี้จะไม่เกิดซ้ำ สำหรับการแทนที่ซ้ำให้เรียกใช้เมธอดโอเวอร์โหลด

 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 แม่

ท้ายที่สุดแล้วการตัดสินใจใช้เครื่องมือสร้างเทมเพลตหรือไม่ควรขึ้นอยู่กับปัจจัยต่อไปนี้:

• คุณจะมีเทมเพลตเหล่านี้มากมายในแอปพลิเคชันหรือไม่?
• คุณต้องการความสามารถในการปรับเปลี่ยนเทมเพลตโดยไม่ต้องรีสตาร์ทแอปพลิเคชันหรือไม่?
• ใครจะเป็นผู้ดูแลเทมเพลตเหล่านี้ โปรแกรมเมอร์ 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;
    }
  }