首页 > 其他分享> 文章详细

StringJoiner真香

2020-12-01 11:30:50 阅读：255 来源： 互联网

标签：code String 真香 delimiter add stringJoiner StringJoiner

你只会用 StringBuilder？试试 StringJoiner，真香！

你只会用 StringBuilder/ StringBuffer 拼接字符串？

那你就 OUT 了！！

如果需要拼接分隔符的字符串，建议使用 Java 8 中的这款拼接神器：StringJoiner，你值得拥有。

1.StringJoiner 基本使用

字面上理解就是用来拼接字符串的，一般需要分隔符进行拼接，如：

hello, guys, 欢迎关注摩托车驾驶员小杨

这种三段式由 “,” 分隔的字符串，在 Java 8 之前要使用 StringBuilder/ StringBuffer 进行拼接，如：

StringBuilder sb = new StringBuilder();
sb.append("hello");
sb.append(",");
sb.append("guys");
sb.append(",");
sb.append("欢迎关注摩托车驾驶员小杨");
String str = sb.toString();

都是相同的分隔符逗号，这样拼接显然过于傻瓜式，如果要拼接的字符串非常多，代码会十分难看，写完感觉要崩溃。

然而 Java 8 之后有了 StringJoiner，这件事件就变得更简单，分隔符这种全部一次性交给 StringJoiner 即可。

2.StringJoiner 基本使用示例：

public static void main(String[] args) {
 StringJoiner stringJoiner = new StringJoiner(",");
 stringJoiner.add("hello");
 stringJoiner.add("guys");
 stringJoiner.add("欢迎关注摩托车驾驶员小杨");
 System.out.println(stringJoiner.toString());
}

输出：

hello,guys,欢迎关注摩托车驾驶员小杨

可以看到，这样写十分的干净清爽，也省去了许多没有必要的分隔符拼接操作，代码更优雅、只是可读性没 SB 直接拼接那么直观。

No!!!

StringJoiner 还有其他几种用法，下面的篇幅栈长会带大家解读一下。

3.StringJoiner 详细介绍

StringJoiner 的类结构图：

在这里插入图片描述

它的父类就是 Object，这些成员变量和方法都有什么用呢？

3.1 成员变量

prefix：拼接后的字符串前缀
delimiter：拼接时的字符串分隔符
suffix：拼接后的字符串后缀
value：拼接后的值
emptyValue：空值的情况，value为 null 时返回

3.2 构造方法：

public StringJoiner(CharSequence delimiter) {
        this(delimiter, "", "");
    }

  
    public StringJoiner(CharSequence delimiter,
                        CharSequence prefix,
                        CharSequence suffix) {
        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");
        // make defensive copies of arguments
        this.prefix = prefix.toString();
        this.delimiter = delimiter.toString();
        this.suffix = suffix.toString();
        this.emptyValue = this.prefix + this.suffix;
    }

提供了两个构造方法，一个必须带分隔符，另一个必须带分隔符、前缀、后缀，可以看了 emptyValue 默认为前缀+后缀组成。

3.3 公开方法：

setEmptyValue：设置空值
toString：转换成 String
add：添加字符串
merge：从另一个 StringJoiner 合并
length：长度（包括前缀后缀）

4.流式 API

我们重点看下 add 方法源码：

  public StringJoiner add(CharSequence newElement) {
        prepareBuilder().append(newElement);
        return this;
    }
    
     private StringBuilder prepareBuilder() {
        if (value != null) {
            value.append(delimiter);
        } else {
            value = new StringBuilder().append(prefix);
        }
        return value;
    }

可以看到内部其实就是用的 StringBuilder 进行封装的，首次创建会先拼接前缀，后续先添加分隔符，再添加字符串。

其实 String 底层也是用的 StringBuilder，具体可以关注公众号Java技术栈在 Java 核心技术系列专栏中进行阅读。

另外一点，add 方法就是返回 StringJoiner 本身，所以可以像StringBuilder/ StringBuffer 一样进行流式处理。

如上面的示例一行代码搞定：

public static void main(String[] args) {
 StringJoiner stringJoiner = new StringJoiner(",").add("hello").add("guys").add("欢迎关注公众号Java技术栈");
 System.out.println(stringJoiner.toString());
}

5.前后缀拼接

在示例中需要指定前后缀：

public static void main(String[] args) {
 StringJoiner stringJoiner = new StringJoiner(",", "[", "]");
 stringJoiner.add("hello");
 stringJoiner.add("guys");
 stringJoiner.add("欢迎关注公众号Java技术栈");
 System.out.println(stringJoiner.toString());
}

输出：

[hello,guys,欢迎关注摩托车驾驶员小杨]

如上所示，前后都带中括号进行了包装。

6.空值处理

没有拼接任何字符串的几个空值处理场景。

6.1 输出空白字符串：

public static void main(String[] args) {
 StringJoiner stringJoiner = new StringJoiner(",");
 System.out.println(stringJoiner.toString());
}

6.2 输出前后缀：

public static void main(String[] args) {
 StringJoiner stringJoiner = new StringJoiner(",", "[", "]");
}

输出：

[]

6.3 输出指定字符串：

通过 setEmptyValue 进行设置。

public static void main(String[] args) {
 StringJoiner stringJoiner = new StringJoiner(",", "[", "]");
 stringJoiner.setEmptyValue("void");
 System.out.println(stringJoiner.toString());
}

输出：

void

7.String.join()

String.join() 这是针对 StringJoiner 又封装了一层的 API，同样出自 Java 8，可以传入动态参数或者迭代器。

java.lang.String#join(java.lang.CharSequence, java.lang.CharSequence…)
java.lang.String#join(java.lang.CharSequence, java.lang.Iterable<? extends java.lang.CharSequence>)

源码如下：

/**
     * Returns a new String composed of copies of the
     * {@code CharSequence elements} joined together with a copy of
     * the specified {@code delimiter}.
     *
     * <blockquote>For example,
     * <pre>{@code
     *     String message = String.join("-", "Java", "is", "cool");
     *     // message returned is: "Java-is-cool"
     * }</pre></blockquote>
     *
     * Note that if an element is null, then {@code "null"} is added.
     *
     * @param  delimiter the delimiter that separates each element
     * @param  elements the elements to join together.
     *
     * @return a new {@code String} that is composed of the {@code elements}
     *         separated by the {@code delimiter}
     *
     * @throws NullPointerException If {@code delimiter} or {@code elements}
     *         is {@code null}
     *
     * @see java.util.StringJoiner
     * @since 1.8
     */
@NotNull
public static String join(CharSequence delimiter, CharSequence... elements) {
        Objects.requireNonNull(delimiter);
        Objects.requireNonNull(elements);
        // Number of elements not likely worth Arrays.stream overhead.
        StringJoiner joiner = new StringJoiner(delimiter);
        for (CharSequence cs: elements) {
            joiner.add(cs);
        }
        return joiner.toString();
    }


  /**
     * Returns a new {@code String} composed of copies of the
     * {@code CharSequence elements} joined together with a copy of the
     * specified {@code delimiter}.
     *
     * <blockquote>For example,
     * <pre>{@code
     *     List<String> strings = new LinkedList<>();
     *     strings.add("Java");strings.add("is");
     *     strings.add("cool");
     *     String message = String.join(" ", strings);
     *     //message returned is: "Java is cool"
     *
     *     Set<String> strings = new LinkedHashSet<>();
     *     strings.add("Java"); strings.add("is");
     *     strings.add("very"); strings.add("cool");
     *     String message = String.join("-", strings);
     *     //message returned is: "Java-is-very-cool"
     * }</pre></blockquote>
     *
     * Note that if an individual element is {@code null}, then {@code "null"} is added.
     *
     * @param  delimiter a sequence of characters that is used to separate each
     *         of the {@code elements} in the resulting {@code String}
     * @param  elements an {@code Iterable} that will have its {@code elements}
     *         joined together.
     *
     * @return a new {@code String} that is composed from the {@code elements}
     *         argument
     *
     * @throws NullPointerException If {@code delimiter} or {@code elements}
     *         is {@code null}
     *
     * @see    #join(CharSequence,CharSequence...)
     * @see    java.util.StringJoiner
     * @since 1.8
     */
@NotNull
 public static String join(CharSequence delimiter,
            Iterable<? extends CharSequence> elements) {
        Objects.requireNonNull(delimiter);
        Objects.requireNonNull(elements);
        StringJoiner joiner = new StringJoiner(delimiter);
        for (CharSequence cs: elements) {
            joiner.add(cs);
        }
        return joiner.toString();
    }

看源码，这两个方法只能进行简单的拼接操作，不能添加前后缀、空值设置处理等。

来个示例：

public static void main(String[] args) {
 String str = String.join(",", "hello", "guys", "欢迎关注公众号Java技术栈");
 System.out.println(str);
}

可以看到，简单处理这样使用更简便。

8.总结

今天介绍了 StringJoiner、StringBuilder、String.join() 之间的关系及使用。在使用拼间多个相同的分隔符时，使用 StringJoiner，简单处理使用 String.join() 也能完成。

针对不同的场景使用不同的 API，这才是最佳最优雅的处理方式，不要只会使用 StringBuilder！

标签：code,String,真香,delimiter,add,stringJoiner,StringJoiner
来源： https://blog.csdn.net/MissOfSpring/article/details/110425976

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

ICode9