Java8 StringJoiner

一、说明

StringJoiner是java.util包下的一个工具类，jdk1.8出来的作用是在构造字符串时，可以自动添加前缀、后缀及分隔符，而不需要自己去实现这些添加字符的逻辑。StringJoiner有两个构造方法：
1、只传入分隔符

public StringJoiner(CharSequence delimiter) {
    // 这里只是调用了第二个构造方法，前缀和后缀传入空字符串，表示没有前后缀
    this(delimiter, "", "");
}

2、传入分隔符，还有前缀和后缀

public StringJoiner(CharSequence delimiter,
                    CharSequence prefix,
                    CharSequence suffix) {
    // 做了以下判断，如果分隔符，前后缀为null，则抛出NullPointerException异常
    Objects.requireNonNull(prefix, "The prefix must not be null");
    Objects.requireNonNull(delimiter, "The delimiter must not be null");
    Objects.requireNonNull(suffix, "The suffix must not be null");
    
    // 赋值给当前对象的属性
    this.prefix = prefix.toString();
    this.delimiter = delimiter.toString();
    this.suffix = suffix.toString();
    this.emptyValue = this.prefix + this.suffix;
}

StringJoiner成员属性，其实StringJoiner主要是通过维护了一个StringBuilder对象value去添加元素的

// 当前StringJoiner对象前缀
private final String prefix;
// 每个添加元素的分隔符
private final String delimiter;
// 当前StringJoiner对象后缀
private final String suffix;
// 前缀+元素+分隔符+后缀的值，如果没有添加元素，那么value是null
private StringBuilder value;
// 前缀+后缀的值，如果没有前后缀，那么这个值为空字符串，可以理解为value的副本，在value为null时，用它来代替
private String emptyValue;

二、示例代码

2.1 按分隔符拼装字符串

2.1.1 单个加

public static void main(String[] args) {
        StringJoiner sj = new StringJoiner(",");
        String str = sj.add("a").add("b").add("c").toString();

        //a,b,c
        System.out.println(str);
    }

2.1.2 字符串转List

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

        String str = list.stream()
                .collect(Collectors.joining(","));

        // a,b,c
        System.out.println(str);
    }

2.1.3 对象List转String

public static void main(String[] args) {
        Cat cat1 = new Cat();
        cat1.setName("a");
        cat1.setAge(1);

        Cat cat2 = new Cat();
        cat2.setName("b");
        cat2.setAge(2);

        Cat cat3 = new Cat();
        cat3.setName("c");
        cat3.setAge(3);

        List<Cat> list = Arrays.asList(cat1, cat2, cat3);
        String str = list.stream().map(Cat::getName).collect(Collectors.joining(","));

        // a,b,c
        System.out.println(str);
    }

2.2 按分隔符、前缀、后缀拼装字符串

public static void main(String[] args) {
        StringJoiner sj = new StringJoiner(",","[", "]");
        String str = sj.add("a").add("b").add("c").toString();

        //[a,b,c]
        System.out.println(str);
    }

2.3 合并一个StringJoiner对象到当前StringJoiner对象

public static void main(String[] args) {
        StringJoiner sj1 = new StringJoiner(",");
        String str1 = sj1.add("a").add("b").add("c").toString();
        //a,b,c
        System.out.println(str1);

        StringJoiner sj2 = new StringJoiner(",");
        String str2 = sj2.add("d").add("e").add("f").toString();
        //d,e,f
        System.out.println(str2);

        String str3 = sj1.merge(sj2).toString();
        //a,b,c,d,e,f
        System.out.println(str3);
    }

三、String.join

如果是想将一个list中的元素快速的以这种方式添加，可以通过String.join来实现，String.join方法也是jdk1.8出来的

public static void main(String[] args) {
        // 第一个参数是分隔符，第二个参数是list
        //打印a,b,c
        System.out.println(String.join(",", Arrays.asList("a", "b", "c")));

        // 第二个参数是可变数组
        //打印a,b,c
        System.out.println(String.join(",", "a", "b", "c"));
    }