跳转至

Java 中拼接字符串数组（join string array）

简介

在 Java 编程中，经常会遇到需要将字符串数组中的元素拼接成一个完整字符串的情况。这在处理文本数据、生成日志信息、构建 SQL 语句等场景中十分常见。Java 提供了多种方法来实现字符串数组的拼接，本文将详细介绍这些方法，包括基础概念、使用方式、常见实践以及最佳实践。

目录

  1. 基础概念
  2. 使用方法
    • 使用 String.join() 方法
    • 使用 StringBuilder 类
    • 使用 StringUtils.join() 方法（来自 Apache Commons Lang 库）
  3. 常见实践
    • 拼接带有分隔符的字符串
    • 处理空数组或空元素
  4. 最佳实践
    • 性能考量
    • 代码可读性
  5. 小结
  6. 参考资料

基础概念

拼接字符串数组，简单来说，就是将数组中的每个字符串元素按照一定的顺序连接在一起，形成一个单独的字符串。这个过程可能涉及到添加分隔符（如逗号、空格等）来区分不同的元素，也可能直接将元素依次拼接。

使用方法

使用 String.join() 方法

String.join() 是 Java 8 引入的一个静态方法，用于拼接字符串数组。它的语法如下：

public static String join(CharSequence delimiter, CharSequence... elements)
  • delimiter：分隔符，用于分隔数组中的每个元素。
  • elements：要拼接的字符串数组。

示例代码：

public class StringJoinExample {
    public static void main(String[] args) {
        String[] fruits = {"Apple", "Banana", "Cherry"};
        String joinedFruits = String.join(", ", fruits);
        System.out.println(joinedFruits);
    }
}

输出结果：

Apple, Banana, Cherry

使用 StringBuilder 类

在 Java 8 之前，可以使用 StringBuilder 类来拼接字符串数组。StringBuilder 提供了高效的字符串拼接操作。

示例代码：

public class StringBuilderExample {
    public static void main(String[] args) {
        String[] fruits = {"Apple", "Banana", "Cherry"};
        StringBuilder sb = new StringBuilder();
        for (int i = 0; i < fruits.length; i++) {
            sb.append(fruits[i]);
            if (i < fruits.length - 1) {
                sb.append(", ");
            }
        }
        String joinedFruits = sb.toString();
        System.out.println(joinedFruits);
    }
}

输出结果：

Apple, Banana, Cherry

使用 StringUtils.join() 方法（来自 Apache Commons Lang 库）

如果项目中引入了 Apache Commons Lang 库，可以使用 StringUtils.join() 方法来拼接字符串数组。这个方法提供了更丰富的功能和灵活性。

首先，需要在项目中添加 Apache Commons Lang 库的依赖（例如使用 Maven）：

<dependency>
    <groupId>org.apache.commons</groupId>
    <artifactId>commons-lang3</artifactId>
    <version>3.12.0</version>
</dependency>

示例代码：

import org.apache.commons.lang3.StringUtils;

public class StringUtilsJoinExample {
    public static void main(String[] args) {
        String[] fruits = {"Apple", "Banana", "Cherry"};
        String joinedFruits = StringUtils.join(fruits, ", ");
        System.out.println(joinedFruits);
    }
}

输出结果：

Apple, Banana, Cherry

常见实践

拼接带有分隔符的字符串

在大多数情况下，需要在拼接的字符串中添加分隔符，以便区分不同的元素。上述三种方法都支持添加分隔符，如示例代码中所示。

处理空数组或空元素

当数组为空或者包含空元素时，不同的方法处理方式略有不同。

  • String.join()：如果数组为空，返回空字符串。如果包含空元素，空元素会正常拼接，分隔符也会正常添加。
  • StringBuilder：需要手动处理空数组和空元素的情况。
  • StringUtils.join()：可以通过重载方法来处理空元素，例如 StringUtils.join(fruits, ", ", null) 可以将空元素替换为指定的字符串（这里是 null）。

示例代码：

import org.apache.commons.lang3.StringUtils;

public class EmptyArrayAndElementExample {
    public static void main(String[] args) {
        String[] emptyArray = {};
        String[] arrayWithNull = {"Apple", null, "Cherry"};

        // 使用 String.join()
        String joinedEmptyArray = String.join(", ", emptyArray);
        String joinedArrayWithNull = String.join(", ", arrayWithNull);
        System.out.println("String.join() - 空数组: " + joinedEmptyArray);
        System.out.println("String.join() - 包含空元素: " + joinedArrayWithNull);

        // 使用 StringBuilder
        StringBuilder sbEmptyArray = new StringBuilder();
        for (String s : emptyArray) {
            sbEmptyArray.append(s);
            if (s != null && s.length() > 0) {
                sbEmptyArray.append(", ");
            }
        }
        StringBuilder sbArrayWithNull = new StringBuilder();
        for (String s : arrayWithNull) {
            if (s != null) {
                sbArrayWithNull.append(s);
                sbArrayWithNull.append(", ");
            }
        }
        if (sbArrayWithNull.length() > 0) {
            sbArrayWithNull.setLength(sbArrayWithNull.length() - 2);
        }
        System.out.println("StringBuilder - 空数组: " + sbEmptyArray.toString());
        System.out.println("StringBuilder - 包含空元素: " + sbArrayWithNull.toString());

        // 使用 StringUtils.join()
        String joinedEmptyArrayWithUtils = StringUtils.join(emptyArray, ", ");
        String joinedArrayWithNullWithUtils = StringUtils.join(arrayWithNull, ", ", "");
        System.out.println("StringUtils.join() - 空数组: " + joinedEmptyArrayWithUtils);
        System.out.println("StringUtils.join() - 包含空元素: " + joinedArrayWithNullWithUtils);
    }
}

输出结果：

String.join() - 空数组: 
String.join() - 包含空元素: Apple, , Cherry
StringBuilder - 空数组: 
StringBuilder - 包含空元素: Apple, Cherry
StringUtils.join() - 空数组: 
StringUtils.join() - 包含空元素: Apple, , Cherry

最佳实践

性能考量

  • String.join()：性能较好，因为它是 Java 标准库针对字符串拼接优化的方法。适用于大多数常规的字符串数组拼接场景。
  • StringBuilder：在 Java 8 之前是常用的方法，性能也不错。但需要手动编写循环和处理分隔符逻辑，代码相对复杂。在性能敏感且需要更多控制的场景下可以使用。
  • StringUtils.join()：功能丰富，但由于是第三方库，会增加项目的依赖。如果项目中已经引入了 Apache Commons Lang 库，且需要更多灵活的拼接功能，可以使用。

代码可读性

  • String.join()：代码简洁明了，最符合现代 Java 的编程习惯，推荐在大多数情况下使用。
  • StringBuilder：代码相对冗长，但对于理解字符串拼接的底层逻辑有帮助。在性能优化要求高且对代码可读性要求不高的场景下可以使用。
  • StringUtils.join()：代码简洁且功能强大，但需要引入第三方库。如果项目中已经使用了 Apache Commons Lang 库，不会增加额外的复杂性，推荐使用。

小结

本文详细介绍了在 Java 中拼接字符串数组的多种方法，包括 String.join()、StringBuilder 和 StringUtils.join()。每种方法都有其特点和适用场景，在实际编程中应根据性能需求、代码可读性以及项目依赖等因素选择合适的方法。通过掌握这些方法，能够更加高效地处理字符串数组拼接的问题。

参考资料