字符串工具 - StrUtil

简介

StrUtil 是 Hutool 提供的一个功能全面的字符串操作工具类，涵盖了字符串处理的各个方面。它的功能包括判断空值、字符串截取、格式化、前后缀处理、替换、拼接等。

---

1. 判断字符串是否为空或仅包含空白字符

在开发中，经常需要判断一个字符串是否为空（null 或空字符串）或仅包含空白字符。StrUtil 提供以下方法来处理这一需求：

• isEmpty 和 isNotEmpty：用于判断字符串是否为 null 或空字符串（""）。
• isBlank 和 isNotBlank：除了判断字符串是否为 null 或空字符串（""），还判断是否为仅包含空白字符的字符串（如 " "）。

示例代码：

import cn.hutool.core.util.StrUtil;

public class StrUtilExample {
    public static void main(String[] args) {
        String str1 = "";
        String str2 = "Hello";
        String str3 = " ";

        // 判断是否为空字符串或 null
        boolean isEmpty = StrUtil.isEmpty(str1);
        System.out.println("str1 是否为空: " + isEmpty); // true

        // 判断是否不为空字符串且不为 null
        boolean isNotEmpty = StrUtil.isNotEmpty(str2);
        System.out.println("str2 是否不为空: " + isNotEmpty); // true

        // 判断是否为空白字符串（包含空格、制表符等）
        boolean isBlank = StrUtil.isBlank(str3);
        System.out.println("str3 是否为空白字符串: " + isBlank); // true

        // 判断是否不为空白字符串
        boolean isNotBlank = StrUtil.isNotBlank(str2);
        System.out.println("str2 是否不为空白字符串: " + isNotBlank); // true
    }
}

参数说明：

• isEmpty(String str) 和 isNotEmpty(String str)

  • str：需要判断的字符串。可以为 null。
  • 返回值：true 如果字符串为 null 或空字符串；否则返回 false。

• isBlank(String str) 和 isNotBlank(String str)

  • str：需要判断的字符串。可以为 null。
  • 返回值：true 如果字符串为 null、空字符串或仅包含空白字符（如空格、制表符等）；否则返回 false。

开发场景：

• 在表单验证、数据清理等场景中，经常需要判断输入的字符串是否为空或仅包含空白字符，以确保数据的完整性和有效性。

---

2. 判断多个字符串中是否存在空值或空白字符

当需要同时判断多个字符串中是否存在空值或空白字符时，可以使用以下方法：

• hasEmpty：判断多个字符串中是否存在 null 或空字符串（""）。
• hasBlank：判断多个字符串中是否存在空白字符串（包括空格、制表符等空白字符）。

示例代码：

import cn.hutool.core.util.StrUtil;

public class StrUtilExample {
    public static void main(String[] args) {
        // 判断是否存在空字符串
        boolean hasEmpty = StrUtil.hasEmpty("Hello", "World", "");
        System.out.println("是否有空字符串: " + hasEmpty); // true

        // 判断是否存在空白字符串（包括空格）
        boolean hasBlank = StrUtil.hasBlank("Hello", "World", " ");
        System.out.println("是否有空白字符串: " + hasBlank); // true
    }
}

参数说明：

• hasEmpty(String... strs) 和 hasBlank(String... strs)
  • strs：需要判断的多个字符串。可以为 null（可变参数，表示需要判断的字符串集合）。
  • 返回值：true 如果任意一个字符串为 null 或空字符串（对于 hasEmpty），或者为空白字符串（对于 hasBlank）；否则返回 false。

开发场景：

• 在批量数据处理或表单验证时，可以使用这些方法快速判断多个字符串中是否存在空值或空白字符，避免逐个判断的麻烦。

---

3. 去除字符串的前缀或后缀

在处理文件路径、URL、标识符等内容时，常常需要去除特定的前缀或后缀。StrUtil 提供了如下方法：

• removePrefix 和 removeSuffix：去除字符串的前缀和后缀。
• removePrefixIgnoreCase 和 removeSuffixIgnoreCase：忽略大小写去除前缀和后缀。

示例代码：

import cn.hutool.core.util.StrUtil;

public class StrUtilExample {
    public static void main(String[] args) {
        // 去除文件扩展名作为后缀
        String fileName = StrUtil.removeSuffix("pretty_girl.jpg", ".jpg");
        System.out.println("去除后缀后的文件名: " + fileName); // pretty_girl

        // 去除 URL 的协议部分作为前缀
        String url = StrUtil.removePrefix("https://www.example.com", "https://");
        System.out.println("去除前缀后的 URL: " + url); // www.example.com
    }
}

参数说明：

• removePrefix(String str, String prefix) 和 removeSuffix(String str, String suffix)

  • str：需要处理的字符串。不能为 null。
  • prefix / suffix：要去除的前缀或后缀。如果字符串不包含指定的前缀/后缀，则返回原字符串。
  • 返回值：去除前缀/后缀后的字符串。如果前缀/后缀不存在，则返回原字符串。

• removePrefixIgnoreCase(String str, String prefix) 和 removeSuffixIgnoreCase(String str, String suffix)

  • str：需要处理的字符串。不能为 null。
  • prefix / suffix：要去除的前缀或后缀，忽略大小写。如果字符串不包含指定的前缀/后缀（忽略大小写），则返回原字符串。
  • 返回值：去除前缀/后缀后的字符串，忽略大小写。

开发场景：

• 在处理文件名时，可以用于去除文件扩展名；在处理 URL 时，可以用于去除协议部分或域名前缀。

---

4. 灵活截取字符串，支持负数索引

字符串截取操作是常见需求，而 StrUtil.sub 方法提供了更为灵活的方式，支持使用负数索引表示从末尾开始计算，并且不会抛出越界异常。

示例代码：

import cn.hutool.core.util.StrUtil;

public class StrUtilExample {
    public static void main(String[] args) {
        String str = "abcdefgh";

        // 从索引 2 开始截取，直到索引 3（不包括索引 3）
        String result1 = StrUtil.sub(str, 2, 3);
        System.out.println("子串1: " + result1); // c

        // 从索引 2 开始截取，直到倒数第 3 个字符
        String result2 = StrUtil.sub(str, 2, -3);
        System.out.println("子串2: " + result2); // cde

        // 反向索引也可以自动修正（例如 fromIndex 大于 toIndex 时）
        String result3 = StrUtil.sub(str, 3, 2);
        System.out.println("子串3: " + result3); // c
    }
}

参数说明：

• sub(String str, int fromIndex, int toIndex)
  • str：需要截取的字符串。不能为 null。
  • fromIndex：起始索引（包含）。支持负数，表示从末尾开始计算索引。
  • toIndex：结束索引（不包含）。支持负数，表示从末尾开始计算索引。
  • 返回值：截取后的子字符串。如果索引超出范围，则返回空字符串（""）。

开发场景：

• 在需要从字符串中灵活提取特定部分内容时，特别是在动态生成索引的场景下，这个方法尤为有用。

---

5. 字符串与字节数组之间的转换

在处理数据传输、文件读写或序列化时，字符串和字节数组之间的转换非常重要。`StrUtil

` 提供了以下方法支持指定字符集的安全转换：

示例代码：

import cn.hutool.core.util.StrUtil;

import java.nio.charset.StandardCharsets;

public class StrUtilExample {
    public static void main(String[] args) {
        String original = "Hello, 世界";

        // 将字符串转换为字节数组，使用 UTF-8 编码
        byte[] bytes = StrUtil.bytes(original, StandardCharsets.UTF_8);
        System.out.println("字节数组长度: " + bytes.length);

        // 将字节数组转换回字符串
        String result = StrUtil.str(bytes, StandardCharsets.UTF_8);
        System.out.println("转换回的字符串: " + result); // Hello, 世界
    }
}

参数说明：

• str(byte[] bytes, Charset charset)

  • bytes：需要转换的字节数组。不能为 null。
  • charset：指定的字符集（如 StandardCharsets.UTF_8）。不能为 null。
  • 返回值：转换后的字符串。

• bytes(String str, Charset charset)

  • str：需要转换的字符串。不能为 null。
  • charset：指定的字符集（如 StandardCharsets.UTF_8）。不能为 null。
  • 返回值：转换后的字节数组。

开发场景：

• 在网络传输数据、文件内容的读写、序列化与反序列化时，字符集的正确处理非常关键，能够有效避免乱码问题。

---

6. 使用模板格式化字符串

在开发中，格式化字符串是非常常见的需求，尤其在动态生成日志或提示信息时。StrUtil.format 方法使用 {} 作为占位符，提供了更加简洁和直观的格式化方式。

示例代码：

import cn.hutool.core.util.StrUtil;

public class StrUtilExample {
    public static void main(String[] args) {
        // 定义字符串模板
        String template = "{} 爱 {}，就像老鼠爱大米";

        // 使用模板进行格式化
        String result = StrUtil.format(template, "我", "你");
        System.out.println(result); // 我爱你，就像老鼠爱大米
    }
}

参数说明：

• format(String template, Object... args)
  • template：字符串模板，使用 {} 作为占位符。不能为 null。
  • args：用于替换模板中占位符的参数。可以为 null，此时会输出字符串 "null"。
  • 返回值：格式化后的字符串。如果没有传入占位符对应的参数，则保留 {}。

开发场景：

• 在生成动态提示信息或构建复杂的日志内容时，使用格式化字符串比直接拼接字符串更加清晰、易读。

---

7. 替换字符串中的指定内容

StrUtil.replace 方法提供了灵活的字符串替换功能，支持普通替换和忽略大小写替换。

示例代码：

import cn.hutool.core.util.StrUtil;

public class StrUtilExample {
    public static void main(String[] args) {
        String str = "I like Java, Java is powerful.";

        // 替换字符串中的内容，忽略大小写
        String replaced = StrUtil.replace(str, "Java", "Python", true);
        System.out.println("替换后的字符串: " + replaced); // I like Python, Python is powerful.
    }
}

参数说明：

• replace(String str, String searchStr, String replacement, boolean ignoreCase)
  • str：原始字符串。不能为 null。
  • searchStr：需要替换的子字符串。不能为 null。
  • replacement：替换后的子字符串。可以为 null，此时会替换为空字符串。
  • ignoreCase：是否忽略大小写进行替换。如果为 true，则不区分大小写。
  • 返回值：替换后的字符串。如果原始字符串不包含要替换的子字符串，则返回原字符串。

开发场景：

• 在文本处理、模板渲染、内容替换等场景中，这个方法可以帮助高效地进行字符串替换操作。

---

8. 拼接多个字符串

当需要将多个字符串或对象组合成一个字符串时，可以使用 StrUtil.join 方法，通过指定分隔符进行拼接。

示例代码：

import cn.hutool.core.util.StrUtil;

public class StrUtilExample {
    public static void main(String[] args) {
        String[] parts = {"Apple", "Banana", "Orange"};

        // 使用分隔符拼接字符串
        String joined = StrUtil.join(", ", parts);
        System.out.println("拼接后的字符串: " + joined); // Apple, Banana, Orange
    }
}

参数说明：

• join(String delimiter, Object... elements)
  • delimiter：分隔符。不能为 null。
  • elements：需要拼接的多个字符串或对象。可以为 null，此时会跳过该元素不进行拼接。
  • 返回值：拼接后的字符串。如果没有元素传入，则返回空字符串（""）。

开发场景：

• 在生成列表、处理动态生成的文本内容或构建复杂的输出字符串时，join 方法非常实用。

---

9. 常见的字符串常量

为了减少硬编码，StrUtil 提供了一些常见的字符串常量，如空字符串、点、换行符等，方便在代码中直接引用。

示例代码：

import cn.hutool.core.util.StrUtil;

public class StrUtilExample {
    public static void main(String[] args) {
        // 使用常量定义
        String empty = StrUtil.EMPTY;
        String dot = StrUtil.DOT;
        String newLine = StrUtil.CRLF;

        System.out.println("空字符串: " + empty);
        System.out.println("点: " + dot);
        System.out.println("换行符: " + newLine);
    }
}

常量说明：

• StrUtil.EMPTY：空字符串 ""。
• StrUtil.DOT：点 .。
• StrUtil.CRLF：回车换行符 \r\n。

开发场景：

• 在拼接字符串、构建文件路径、生成 HTML 内容时，直接使用这些常量可以提升代码的可读性，并减少硬编码带来的问题。