以后我准备告别String.format()了，因为它不够香！

搞IT的成龙同学
20,484 阅读3分钟

开发环境

  • JDK - 17
  • Slf4j - 2.0.7

前言

作为一名合格的Java开发者，字符串格式化最常见的方式，莫过于使用String.format来完成工作中想要的格式化效果。但是，字符串中使用%s占位符，它真的不太显眼。

我个人来讲，使用最多的场景就是英文和中文的格式化操作，内容中间突然来个%s占位符，我有时候真的找不到它！就比如这(还不算痛苦)：String.format("Resolve all today's questions %s, using String.format. ", "slf4j");

某天我偶然好奇，天天在程序中打Log日志，使用的{}分隔符就很爽啊！我应该也可以直接用！果然，slf4j-api的包中，提供了非常好的格式化类org.slf4j.helpers.MessageFormatter。

注意，千万别用错类了，因为JDK中有个java.text.MessageFormat类，使用方式可大不相同。

Pom引用

<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>2.0.7</version>
</dependency>

简单使用

想要使用一个类，最快的方式就是先看它的注释，大概率都有示例和详细说明。当我们进入MessageFormatter类中之后，可以看到几个比较突出、简单的小示例以及说明。符号{}在类中的描述为"锚点"，用于参数的占位符。

1. 简单替换

通过简单的替换规则，完成1个或多个参数的替换，已经能满足日常大部分场景的使用了！

MessageFormatter.format("Hi {}.", "there").getMessage();

输出：Hi there.

2. 不生效的{1,2,3}占位符

平时可能拼接的字符串带{}符号，比如：{1,2,3}字符串且中间有字母，其实可以直接让占位符无效。

MessageFormatter.format("Set {1,2,3} is not equal to {}.", "1,2").getMessage();

输出：Set {1,2,3} is not equal to 1,2.

3. 纯粹的输出{}符号

通过反斜杠来转义，轻松输出{}符号

MessageFormatter.format("Set \\{} is not equal to {}.", "1,2").getMessage();

输出：Set {} is not equal to 1,2.

4. Windows上拼接磁盘注意看

Window系统中日常拼接路径本身就带\\转义符，如果需要让占位符{}生效，需要再转一次！

MessageFormatter.format("File name is C:\\\\{}.", "file.zip").getMessage();

输出：File name is C:\file.zip.

不过日常使用，使用MessageFormatter.format("xxx {} xxx", "file.zip").getMessage();这一大串，还是太长了。

缩短一点

通过MessageFormatter.basicArrayFormat(format, args);方法，完成第一步的缩短操作。这个方法可以说是对上面长方法的简单封装。

final public static String basicArrayFormat(final String messagePattern, final Object[] argArray) {
    FormattingTuple ft = arrayFormat(messagePattern, argArray, null);
    return ft.getMessage();
}

再短一点呢！

再短就只能自己来了！搞个Strings类，自己想咋地就咋地。

public class Slf4jDemo {
    public static void main(String[] args) {
        Strings.format("hello %s", "world");
    }
    
    public static class Strings {
        public static String format(String format, Object... args) {
            return MessageFormatter.basicArrayFormat(format, args);
        }
    }
}

效果更佳

如果是习惯使用Kotlin编写代码的小伙伴，可以直接把它作为字符串的扩展方法来使用的。那叫一个爽啊！

//扩展字符串类型
fun String.format(vararg args: Any): String {
    return MessageFormatter.basicArrayFormat(this, args)
}

fun main() {
    //直接用
    println("hello {}".format("world"))
}

总结

有了Slf4j的MessageFormatter类，我个人目前已经对String.format放弃了。当然，有些小伙伴已经习惯了String.format的使用，那就接着用。技术方案没有最好的，只有最适合自己的！加班写代码已经够苦了，平时还不怎么爽怎么来！

兴趣

关注公众号【搞IT的成龙同学】，有时间可一起讨论。偶尔搞点黑科技，才是真香现场！

avatar
文章
阅读
粉丝