MessageFormatter字符串格式化

前言

字符串格式化最常见的方式，莫过于使用String.format来完成工作中想要的格式化效果。但是，字符串中使用%s占位符，它真的不太显眼。
slf4j-api的包中，提供了非常好的格式化类org.slf4j.helpers.MessageFormatter。

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

使用

想要使用一个类，最快的方式就是先看它的注释，大概率都有示例和详细说明。当我们进入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.

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

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

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

Demo

# 格式化字符串输出
public static void main(String[] args) {

        Integer integer = 10;
        Double db = 20.123d;
        List<String> list = new ArrayList<>(Arrays.asList("list1", "list2", "listr3"));
        Map<String, Integer> map = new HashMap<>();
        map.put("key1", 1);
        map.put("key2", 2);
        map.put("key3", 3);
        String[] arr = {"arr1", "arr2", "arrr3"};

        Object[] arrObj = {"aaa", integer, db, list, map, arr};

        # {} 定位变量位置
        FormattingTuple tuple = MessageFormatter.arrayFormat("str {} int {} double {} list {} map {} array {}", arrObj);
        System.out.println(tuple.getMessage());

        # \{} 表示 跳过该对括号
        FormattingTuple tuple1 = MessageFormatter.format("Set \\{} is not equal to {}.", "1,2");
        System.out.println(tuple1.getMessage());

        # 前面再加 \ 则取消跳过
        FormattingTuple tuple2 = MessageFormatter.format("File name is C:\\\\{}.", "file.zip");
        System.out.println(tuple2.getMessage());

        FormattingTuple tuple3 = MessageFormatter.format("File \\ name is C:\\\\\\{}.", "file.zip");
        System.out.println(tuple3.getMessage());
    }

#输出结果
str aaa int 10 double 20.123 list [list1, list2, listr3] map {key3=3, key2=2, key1=1} array [arr1, arr2, arrr3]
Set {} is not equal to 1,2.
File name is C:\file.zip.
File \ name is C:\\file.zip.