字符串格式化工具 - StrFormatter

简介

StrFormatter 是一个针对字符串进行格式化的工具类，灵感来自 SLF4J 的 {} 占位符格式化。通过使用 {} 作为占位符，可以方便地进行字符串拼接和替换。与传统的 String.format 相比，StrFormatter 提供了更简洁和直观的格式化方式。
推荐使用 StrUtil.format 作为 StrFormatter.format 的快捷方式。

1. 基本使用

StrFormatter.format 通过 {} 占位符进行字符串格式化，按顺序将后续的参数填入对应位置。

示例：基础字符串格式化

import cn.hutool.core.text.StrFormatter;

public class StrFormatterExample {
    public static void main(String[] args) {
        // 使用 {} 占位符进行格式化
        String result = StrFormatter.format("This is {} for {}", "Java", "developers");
        System.out.println(result); // 输出：This is Java for developers
    }
}

方法签名：

public static String format(String strPattern, Object... argArray)

参数说明：

• strPattern：包含 {} 占位符的字符串模板。
• argArray：用于替换占位符的参数列表。

作用：该方法用于快速格式化包含多个占位符的字符串，减少手动拼接字符串的繁琐。

实际开发场景：在需要动态生成文本内容（如日志、提示信息）时，可以使用该方法进行字符串格式化。

2. 占位符转义

在一些特殊场景下，可能需要在模板中显示 {} 字符，而不是将其作为占位符。这种情况下，可以通过在 {} 前添加反斜杠 \ 来实现转义。

示例：占位符转义

import cn.hutool.core.text.StrFormatter;

public class StrFormatterExample {
    public static void main(String[] args) {
        // 转义 {} 占位符，使其显示为普通字符
        String result = StrFormatter.format("This is \\{} for {}", "Java", "developers");
        System.out.println(result); // 输出：This is {} for Java
    }
}

作用：当需要在格式化字符串中显示 {} 而非替换内容时，可以使用转义符 \。

实际开发场景：在生成文档或处理特殊字符时，可以使用该方法确保输出的内容符合预期。

3. 反斜杠转义

如果字符串中包含反斜杠 \，也需要进行转义。使用双反斜杠 \\ 表示一个普通的反斜杠。

示例：反斜杠转义

import cn.hutool.core.text.StrFormatter;

public class StrFormatterExample {
    public static void main(String[] args) {
        // 转义反斜杠，使其显示为普通字符
        String result = StrFormatter.format("This is \\\\{} for {}", "Java", "developers");
        System.out.println(result); // 输出：This is \Java for developers
    }
}

作用：在处理文件路径或需要输出反斜杠时，通过双反斜杠进行转义，确保内容显示正确。

实际开发场景：在生成文件路径、处理网络地址或进行转义字符处理时，可以使用该方法进行正确输出。

4. 参数自动匹配

StrFormatter 支持根据参数顺序自动匹配 {} 占位符。未提供的参数将不会替换，依然显示为 {}。

示例：自动匹配参数

import cn.hutool.core.text.StrFormatter;

public class StrFormatterExample {
    public static void main(String[] args) {
        // 仅替换前两个参数，第三个占位符保持不变
        String result = StrFormatter.format("This is {} for {} and {}", "Java", "developers");
        System.out.println(result); // 输出：This is Java for developers and {}
    }
}

作用：当占位符数量与参数数量不匹配时，未替换的占位符将保持原样，有助于调试和检查输出。

实际开发场景：在动态生成复杂字符串模板时，部分占位符可能暂时不提供数据，可以使用该功能简化处理。

5. 快捷方法 StrUtil.format

StrUtil.format 是 StrFormatter.format 的快捷方式，推荐在项目中使用 StrUtil.format 进行字符串格式化。

示例：使用 StrUtil.format

import cn.hutool.core.util.StrUtil;

public class StrFormatterExample {
    public static void main(String[] args) {
        // 使用 StrUtil.format 进行字符串格式化
        String result = StrUtil.format("This is {} for {}", "Java", "developers");
        System.out.println(result); // 输出：This is Java for developers
    }
}

作用：StrUtil.format 提供了更加直观和简洁的调用方式，是项目中推荐的字符串格式化工具。

实际开发场景：在 Hutool 项目中，建议统一使用 StrUtil.format 进行字符串处理，保持代码风格一致。

总结

StrFormatter 提供了一种高效、简洁的字符串格式化方式，特别适用于需要动态生成字符串内容的场景。通过 {} 占位符和参数自动匹配，开发者可以更轻松地处理复杂的字符串拼接需求。此外，通过提供转义和快捷方法，StrFormatter 进一步提升了使用体验，使字符串处理更加便捷和统一。