基础工具类Joiner的使用

柔情只为你懂 2023-10-07 21:25 21阅读 0赞

Guava 中有一些基础的工具类，如下所列：

1.  Joiner 类：根据给定的分隔符把字符串连接到一起。MapJoiner 执行相同的操作，但是针对 Map 的 key 和 value。
2.  Splitter 类：与 Joiner 操作相反的类，是根据给定的分隔符，把一个字符串分隔成若个子字符串。
3.  CharMatcher，Strings 类：对字符串通用的操作，例如移除字符串的某一部分，字符串匹配等等操作。
4.  其他类：针对Object操作的方法，例如 toString 和 hashCode 方法等。

### 一、 Joiner ###

这是在我们代码中出现频率比较高的一个功能。经常需要将几个字符串，或者字符串数组、集合之类的东西，拼接成一个以指定符号分隔各个元素的字符串，比如要将一个用List保存的集合拼起来作为SQL语句的条件，在知道Joiner之前我们会这样做。

// 拼接： AND goods IN(123,1234,345)
    productSql.append(" AND goods IN (");
    for (Long goods : spuIdList) {
        
      productSql.append(goods + ",");
    }
    productSql.delete(productSql.length() - 1, productSql.length()).append(")");

上面的代码注意的一点就是我们要移除字符串最后的一个分隔符。虽然不难，但是很无聊，下面借助 Joiner 类，代码瞬间变得优雅起来。

productSql.append(" AND goods IN (").append(Joiner.on(",").skipNulls().join(spuIdList)).append(")");

**补充：**

*  如果传入的对象中包含空指针，会直接抛出空指针异常。Joiner 提供了两个方法，让我们能够优雅的处理待拼接集合中的空指针。
 *  如果我们希望忽略空指针，那么可以调用 `skipNulls`方法，得到一个会跳过空指针的 Joiner 实例。如果希望将空指针变为某个指定的值，那么可以调用 `useForNull` 方法，指定用来替换空指针的字符串。
    
        Joiner.on(",").skipNulls().join(spuIdList);
        Joiner.on(",").useForNull("#").join(spuIdList);
 *  Joiner 不仅可以返回string ，还有方法能够处理StringBuilder类：

### 二、Joiner.MapJoiner ###

MapJoiner 是 Joiner 的内部静态类，用于帮助将 Map 对象拼接成字符串。

@Test
    public void testJoiner(){
        
        Map<String, String> map = new HashMap<>();
        map.put("红楼梦", "刘姥姥");
        map.put("三国演义", "关羽");
        map.put("水浒传", "李逵");
        map.put("西游记", "猪八戒");
        String str = Joiner.on(" ").withKeyValueSeparator(":").join(map);
        System.out.println(str);//水浒传:李逵 红楼梦:刘姥姥 三国演义:关羽 西游记:猪八戒
    }

### 三、常用API总结： ###

##### appendTo #####

// 可追加，实现了Appendable接口的都可以使用
    A appendTo(A appendable, Iterable<?> parts)
    // 向appendable参数后追加first、second…所有参数
    A appendTo(A appendable, @Nullable Object first, @Nullable Object second, Object… rest)

比较常见的实现类：`BufferedWriter, CharArrayWriter, CharBuffer, FileWriter, FilterWriter, LogStream, OutputStreamWriter, PipedWriter, PrintStream, PrintWriter, StringBuffer, StringBuilder, StringWriter, Writer`  
**用法**

String[] arr = {
        "a","b","c"};
    StringBuilder ab = new StringBuilder("start: ");
    StringBuilder ac = Joiner.on("").appendTo(ab,arr);
    System.out.println(ab); // start: abc
    System.out.println(ac); // start: abc

##### Join+on #####

// 将可迭代的参数中所有子元素连接。
    String join(Iterable<?> parts)
    // 为static对象设置分隔符
    static Joiner on(char separator)

Joiner实例不可变，即用final修饰，一旦初始化不可变，所以分步调用joiner的静态函数是不起作用的。如：

@Test
    public void testJoiner(){
        
        Joiner joiner = Joiner.on(',');
        joiner.skipNulls(); // 不起作用!
        String str = joiner.join("wrong", null, "wrong");
        System.out.println(str);
    }
    // 会抛出 NullPointerException

这样使得joiner线程安全，并且返回的都是final static常量

##### 其他 #####

Joiner skipNulls()
    Joiner useForNull(String nullText)
    Joiner.MapJoiner withKeyValueSeparator(String keyValueSeparator)

### 最后 ###

大家有兴趣的可以去了解下Guava中其他类的用法，源码写的也很棒！

附上链接：

Joinner源码解析：[https://blog.csdn.net/dancheng1/article/details/84819034][https_blog.csdn.net_dancheng1_article_details_84819034]

强大的Google Guava类库： [https://cloud.tencent.com/developer/article/2035964][https_cloud.tencent.com_developer_article_2035964]

Guava库使用：[https://blog.csdn.net/weixin\_44139651/article/details/123804181][https_blog.csdn.net_weixin_44139651_article_details_123804181]

效率提升神器之Guava-Joiner：[https://baijiahao.baidu.com/s?id=1736921815066348757&wfr=spider&for=pc][https_baijiahao.baidu.com_s_id_1736921815066348757_wfr_spider_for_pc]

[https_blog.csdn.net_dancheng1_article_details_84819034]: https://blog.csdn.net/dancheng1/article/details/84819034
[https_cloud.tencent.com_developer_article_2035964]: https://cloud.tencent.com/developer/article/2035964
[https_blog.csdn.net_weixin_44139651_article_details_123804181]: https://blog.csdn.net/weixin_44139651/article/details/123804181
[https_baijiahao.baidu.com_s_id_1736921815066348757_wfr_spider_for_pc]: https://baijiahao.baidu.com/s?id=1736921815066348757&wfr=spider&for=pc