Java8（2）：Java8 对字符串连接的改进

我们提出一个需求：有一个 List<String>，将其格式化为 元素1, 元素2, 元素3, ... 元素N 的字符串形式。

毋庸置疑，Java8 之前我们的第一反应是使用 StringBuilder：

public static String formatList(List<String> list, String delimiter) {
    StringBuilder result = new StringBuilder();
    for (String str : list) {
        result.append(str).append(delimiter);
    }
    // 删除末尾多余的 delimiter
    result.delete(result.length() - delimiter.length(), result.length()); 
    
    return result.toString();
}

public static void main(String[] args) throws Exception {
    List<String> list = Arrays.asList("a", "b", "c", "d", "e", "f", "g");

    System.out.println("使用 StringBuilder：");
    String format = formatList(list, ", ");
    System.out.println(format);
}

运行结果：

---

JDK1.8 时，添加了一个新的用于字符串连接的类，专门用于这种需要 分隔符 的场合，它就是 StringJoiner。StringJoiner 在构造时可以指定一个分隔符（delimiter），然后每连接一个元素它便会加上一个 delimiter，使用 StringJoiner 改写 formatList：

public static String formatList(List<String> list, String delimiter) {
    StringJoiner result = new StringJoiner(delimiter);
    for (String str : list) {
        result.add(str);
    }
    return result.toString();
}

public static void main(String[] args) throws Exception {
    List<String> list = Arrays.asList("a", "b", "c", "d", "e", "f", "g");

    System.out.println("使用 StringJoiner：");
    String format = formatList(list, ", ");
    System.out.println(format);
}

运行结果：

formatList 的代码更加的简洁了 —— 当然我们还可以更简洁 —— JDK1.8 为 String 类添加了一个新的静态方法，String.join：

可以看到，第一个参数为一个分隔符 delimiter，第二个参数可以是一个 Iterable，或者是一个变长参数的 CharSequence（String 就是 CharSequence 的子类）。
所以 formatList 方法只需要一句代码就搞定：

public static String formatList(List<String> list, String delimiter) {
    return String.join(delimiter, list);
}

当然，我们能猜到，String.join 方法的功能内部是通过 StringJoiner 来实现的，String.join (CharSequence, Iterable) 的源码：

---

但是我们看到了 String.join 方法的不足 —— 它不能指定前缀和后缀 —— 比如我们如果想要直接将 List<String> 格式化为 { 元素1, 元素2, 元素3, ... 元素N } 呢？（此时前缀为 "{ "，后缀为 " }"）

查看 StringJoiner 的构造方法，发现 StringJoiner 除了指定 分隔符 的构造方法，还有一个可以指定 分隔符、前缀和后缀 的构造方法：

修改 formatList：

public static String formatList(
        List<String> list, String delimiter, String prefix, String suffix) {

    StringJoiner result = new StringJoiner(delimiter, prefix, suffix);
    for (String str : list) {
        result.add(str);
    }
    return result.toString();
}

public static void main(String[] args) throws Exception {
    List<String> list = Arrays.asList("a", "b", "c", "d", "e", "f", "g");

    System.out.println("使用 StringJoiner，带前缀和后缀：");
    String format = formatList(list, ", ", "{ ", " }");
    System.out.println(format);
}

运行结果：

---

很棒~ 但能不能更简洁呢？ 事实上，Java8 对于字符串集合的连接操作提供了一个专门的流式 API，即 Collectors.joining 函数：

• 无参的 joining() 方法，即不存在连接符（底层实现为 StringBuilder）；
• joining(CharSequence delimiter) 方法，即分隔符为 delimiter（底层实现为 StringJoiner）；
• joining(CharSequence delimiter, CharSequence prefix, CharSequence suffix)方法，即分隔符为 delimiter，前缀为 prefix，后缀为 suffix（底层实现为 StringJoiner）。

那怎么使用呢？ 我们直接使用三个参数的 Collectors.joining 方法改写 formatList：

public static String formatList(
        List<String> list, String delimiter, String prefix, String suffix) {

    return list.stream().collect(Collectors.joining(delimiter, prefix, suffix));
}

public static void main(String[] args) throws Exception {
    List<String> list = Arrays.asList("a", "b", "c", "d", "e", "f", "g");

    System.out.println("使用 Collectors.joining：");
    String format = formatList(list, ", ", "{ ", " }");
    System.out.println(format);
}

运行结果：

查看 StringJoiner 的源码，我们可以知道 StringJoiner 的底层实现就是 StringBuilder —— Java8 将 使用分隔符连接多个字符串 这一功能进行封装，提供这么多易用且简介的 API，确实在很大程度上方便了编码。