Java21-String Templates（字符串模版）

在日常写 Java 的时候，对于字符串的操作是非常普遍的，其中最常见的就是对字符串的组织。也因为这个操作非常普遍，所以诞生了很多方案，总下来大概有这么几种：

使用 + 拼接
使用 StringBuffer 和 SpringBuilder
String::format and String::formatted
使用 java.text.MessageFormat

下面，我们一起来学习一下 Java 21 中的新方案！

模版表达式

在 Java 21 中处理字符串的新方法称为：Template Expressions，即：模版表达式。

模版表达式是 Java 语言中的一种新表达式。它可以执行字符串插值，帮助开发人员通过编程的方式安全高效地组织字符串。此外，模板表达式不仅仅可以用于组织字符串，它还可以根据特定模型的规则将结构化文本转换为任何类型的对象。

下面通过一个简单的案例来认识一下它：

String blog = "xuewei.world";
String str = STR."My blog is \{blog}";

上述代码中的第 2 行就是一个模版表达式，其中主要包含三个部分：

模版处理器：STR
包含内嵌表达式（\{blog}）的模版
通过 . 把前面两部分组合起来，形式上类似方法调用

当模版表达式运行的时候，模版处理器会将模版内容与内嵌表达式的值组合起来，生成结果，所以上面案例中的字符串 str 在运行时的结果为：My blog is xuewei.world。

多行模版表达式

String html = """
    <html>
    <body>
      <h1>Hello</h1>
      <p>Hello World</p>
    </body>
    </html>
    """;

模版表达式也支持类似的多行字符串处理，所以开发者可以用它来方便的组织 html、json、xml 等字符串内容，比如下面这样：

var json = STR."""
{
    "user": "\{name}",
    "age: \{age}
}
""";

STR 模版处理器

上面案例中我们所用的 STR 模版处理器中的内嵌表达式都采用了字符串内容，而实际上 STR 模版处理器还有更多的用途。

数学运算

内嵌表达式中还可以支持数学运算，比如：

int x = 10, y = 20;
String s = STR."\{x} + \{y} = \{x + y}";

最终s字符串结果为：10 + 20 = 30

调用方法

内嵌表达式中还可以调用方法，比如：

String s = STR."Hello \{getName()}";

访问对象的成员变量

User u = new User("xw", 25);
String s = STR."\{u.name} 今年 \{u.age} 岁";

FMT 模版处理器

除了 STR 模版处理器之外，Java 中还提供了另外一个模版处理器：FMT。FMT 模版处理器除了与 STR 模版处理器一样提供插值能力之外，还提供了左侧的格式化处理。下面通过例子来直接理解 FMT 的功能：

record Rectangle(String name, double width, double height) {
    double area() {
        return width * height;
    }
}
Rectangle[] zone = new Rectangle[] {
    new Rectangle("Alfa", 17.8, 31.4),
    new Rectangle("Bravo", 9.6, 12.4),
    new Rectangle("Charlie", 7.1, 11.23),
};
String table = STR."""
    Description  Width  Height  Area
    \{zone[0].name}  \{zone[0].width}  \{zone[0].height}     \{zone[0].area()}
    \{zone[1].name}  \{zone[1].width}  \{zone[1].height}     \{zone[1].area()}
    \{zone[2].name}  \{zone[2].width}  \{zone[2].height}     \{zone[2].area()}
    Total \{zone[0].area() + zone[1].area() + zone[2].area()}
    """;

上面这块是由 STR 模版处理器组织字符串表格数据，从模版表达式来看是非常整齐的，但是由于模版中内嵌表达式的值长短不一，最终输出结果很有可能差强人意，比如 STR 模版处理器处理后的结果是这样的：

Description  Width  Height  Area
Alfa  17.8  31.4     558.92
Bravo  9.6  12.4     119.03999999999999
Charlie  7.1  11.23     79.733
Total 757.693

为了解决这个问题，就可以采用 FMT 模版处理器，在每一列左侧定义格式

String table = FMT."""
    Description     Width    Height     Area
    %-12s\{zone[0].name}  %7.2f\{zone[0].width}  %7.2f\{zone[0].height}     %7.2f\{zone[0].area()}
    %-12s\{zone[1].name}  %7.2f\{zone[1].width}  %7.2f\{zone[1].height}     %7.2f\{zone[1].area()}
    %-12s\{zone[2].name}  %7.2f\{zone[2].width}  %7.2f\{zone[2].height}     %7.2f\{zone[2].area()}
    \{" ".repeat(28)} Total %7.2f\{zone[0].area() + zone[1].area() + zone[2].area()}
    """;

Description     Width    Height     Area
Alfa            17.80    31.40      558.92
Bravo            9.60    12.40      119.04
Charlie          7.10    11.23       79.73
                             Total  757.69

关于 Java 21 中推出的 String Templates 特性还有很多高级能力，比如：自定义模版处理器等。