MessageFormat与占位符

Bertha 。 2022-04-06 14:08 293阅读 0赞

\{\}的数字代表了相应顺序位置的参数

应用于短信，参数模板的使用方法（尤其是定时任务）

参数模板的话后面应用的时候用split--用这个主要是存在公用的参数

参数模板的示例：

taskparam.openAccountNotify=\{0\}|0|300|1800|2|5||\{1\}||||SUCCESS||||2

@Value("$\{jdan.taskparam.openAccountNotify\}")

private String openAccountNotify;

\{0\}|   --》对应位数      0

0|       --》    1

300|     --》     2

1800|    --》    3

2|         --》  4

5|         --》  5

|         --》   6

\{1\}|     --》    7

|         --》   8

|         --》   9

|           --》 10

SUCCESS|  --》  11

|           --》 12

|          --》  13

|          --》  14

2         --》   15

String taskParams = MessageFormat.format(openAccountNotify, "confirmLoanUrl", JSON.toJSONString(confirmLoan));//???

String\[\] p = taskParams.split("\\\\|");

TaskParam taskParam = new TaskParam();

taskParam.setTaskUrl(p\[0\]);

taskParam.setWaitingTime(p\[1\]);

taskParam.setPeriod(p\[2\]);

taskParam.setPartDelay(p\[3\]);

taskParam.setPartCount(p\[4\]);

taskParam.setExecutionCount(p\[5\]);

taskParam.setArgs(p\[7\]);

taskParam.setSuccessCdn(p\[11\]);

taskParam.setHttpType(p\[15\]);

sendTaskUtil.sendTask(taskParam);

源码：

public static String format(String pattern, Object ... arguments) \{

MessageFormat temp = new MessageFormat(pattern);

return temp.format(arguments);

=============理论知识==============

如果一个字符串文本中包含了多个与国际化相关的数据，可以使用MessageFormat类对这些数据进行批量处理。

例如：

在2016年1月9日的时候，一场台风导致了500间房屋的摧毁和￥1000000元人民币的损失。

在上面这句话中，包含了时间、数字和货币等多个与国家化相关的数据，已经用下划线标出，而我们可以使用MessageFormat对这句话中多个数据进行批量处理。

要想使用MessageFormat进行批量处理，就要使用到占位符，用占位符替换上面的数据(不需要写死的数据或者与国际化相关的数据)。占位符由花括号\{\}和在花括号中的数字组成，数字代表这是第几个占位符，现在我们对上面的那个示例使用占位符：

在\{0\}的时候，一场台风导致了\{1\}间房屋的摧毁和\{2\}元人民币的损失。

经过占位符修改的字符串文本也称为模式字符串，如上面这句话，有了模式字符串后，我们需要一个对象数组来指定每个占位符对应的数据，在数组中的位置就对应着其相同位置的占位符。现在拥有了模式字符串和对象数组后，我们就可以使用MessageFormat对象的format方法，将数组中的数据一一对应到占位符上了。

占位符由三种书写格式：

① \{index\}：index为0~9之间的数字，对应对象数组中的位置。

② \{index，formatType\}：index为0~9之间的数字，formatType为参数的格式化类型

③  \{index，formatType，formatStyle\}：formatStyle为参数的格式化样式。

有关占位符的使用稍后说明。

注：在创建MessageFormat对象时可以直接将模式字符串以参数传入构造器，也可以直接使用MessageFormat的静态方法format(String pattern , Object …params)只执行一次。

例1：

![ExpandedBlockStart.gif][]

1     String pattern = "在{0}的时候，一场台风导致了{1}间房屋的摧毁和{2}元人民币的损失。";
    2     Object[] params = {
         new Date(),500,1000000};
    3     MessageFormat mf = new MessageFormat(pattern);
    4     String content = mf.format(params);
    5     System.out.println(content);

上述代码等同于：

![ExpandedBlockStart.gif][]

1     String pattern = "在{0}的时候，一场台风导致了{1}间房屋的摧毁和{2}元人民币的损失。";
    2     Object[] params = {
         new Date(),500,1000000};
    3     String content = MessageFormat.format(pattern, params);
    4     System.out.println(content);

输出：

![787876-20160119221419390-913191746.png][]

结果就是：在16-1-9 下午7:56的时候，一场台风导致了500间房屋的摧毁和1,000,000元人民币的损失。

可以看到在对应的占位符上，我们用对象数组中的内容替代了占位符。但是似乎和最开始我们规定的字符串文本有点不同？

最开始我们规定的文本：

在2016年1月9日的时候，一场台风导致了500间房屋的摧毁和￥1,000,000元人民币的损失。

例1占位符被替代后的文本：

在16-1-9 下午7:56的时候，一场台风导致了500间房屋的摧毁和1,000,000元人民币的损失。

可以看到日期格式和货币格式跟我们规定的不同，而这一点可以想到前一篇博客我们学到的DateFormat和NumberFormat中可以指定日期/时间或货币的输出格式。而这里我们要先了解下占位符：

占位符有三种书写格式：

① \{index\}：index为0~9之间的数字，对应对象数组中的位置。

② \{index，formatType\}：index为0~9之间的数字，formatType为参数的格式化类型

③ \{index，formatType，formatStyle\}：formatStyle为参数的格式化样式，该样式必须是格式化类型相匹配的合法模式，或表示合法模式的字符串。

在Java的API关于MessageFormat中，已经定义了formatType和formatStyle能使用的参数有哪些：

![787876-20160119221526265-557221913.png][]

通过上图我们就明白了formatType和formatStyle到底能使用哪些值，比如formatType如果我选了“date”，就代表该占位符是一个日期，那么可以指定formatStyle(使用占位符第三种书写方式)，也就是DateFormat的日期显示格式；当然也可以不指定(使用占位符第二种书写方式)，那么该DateFormat就采用默认(MEDIUM)的日期显示格式。如果formatType选择为“number”也是一样的道理。如果对DateFormat和NumberFormat不熟悉的可以看上一篇博客《国际化之DateFormat、NumberFormat》 。

总结：

formatType如果使用“date”，那么就是采用DateFormat类的getDateInstance方法获取只关于日期的DateFormat类实例对象，根据formatStyle来获取日期输出格式。

formatType如果使用“time”，那么就是采用DateFormat类的getTimeInstance方法获取只关于时间的DateFormat类实例对象，根据formatStyle来获取时间输出格式。

formatType如果使用“number”，如果也指定了formatStyle为“currency”，那么就是调用了NumberFormat的getCurrencyInstance方法获取有关于货币格式的NumberFormat类对象。

当然通过上图还可以获得很多对象，还有其他类型的格式转换器类，比如SimpleDateFormat等等，具体根据上图和实际情况满足需求即可。

例2：

![ExpandedBlockStart.gif][]

![复制代码][copycode.gif]

1     String pattern = "在{0,date,long}的时候，一场台风导致了{1}间房屋的摧毁和{2,number,currency}元人民币的损失。";
    2     Object[] params = {
         new Date(),500,1000000};
    3         
    4     String content = MessageFormat.format(pattern, params);
    5     System.out.println(content);

![复制代码][copycode.gif]

输出：

![787876-20160119221636672-1452233749.png][]

结果就是：在2016年1月9日的时候，一场台风导致了500间房屋的摧毁和￥1,000,000.00元人民币的损失。

可以看到这就跟我们的最开始定义的字符串文本相同了。

占位符在框架中是经常被使用到的，当然占位符一般不会在程序代码中被使用，而是在资源文件properties被使用，这是想Struts2这样的框架经常被使用到的，结合前两篇的《国际化之ResourceBundle》，如果模式字符串在properties中使用，那么我们需要通过ResourceBundle通过资源文件的基名获取对象，并使用getString方法获取模式字符串，最后只要使用MessageFormat像上面一样处理就行了。

例3：

在工程中用一个包来封装一组资源包，该组资源包中默认的资源配置文件基名为“MessageResource”，同时配有中文和英文两个资源配置文件，如下图所示：

![787876-20160119221732078-50122626.png][]

在默认的资源文件“MessageResource.properties”中定义的内容如下：

![787876-20160119221746000-1979623390.png][]

在中文资源文件“MessageResource\_zh.properties”中定义的内容如下：

![787876-20160119221808234-1863780849.png][]

英文资源文件和默认资源文件中的内容是一样的，这里就不再贴出。

因为我们将资源文件放在包中，所以基名应该包括包名，这一点在博文《《国际化之ResourceBundle》中已经说明。

在程序中代码如下：

![ExpandedBlockStart.gif][]

![复制代码][copycode.gif]

1     ResourceBundle bundle = ResourceBundle.getBundle("com.fjdingsd.resource.MessageResource",Locale.CHINA);
    2     String pattern = bundle.getString("message");  //获取模式字符串
    3     Object[] params = {
         new Date(),500,10000000};
    4         
    5     String content = MessageFormat.format(pattern, params);
    6     System.out.println(content);

![复制代码][copycode.gif]

输出：在16-1-9 下午8:59的时候，一场台风导致了500间房屋的摧毁和10,000,000元人民币的损失。

注意：⑴ 这里占位符对应的地方格式并不友好，这是因为占位符没有使用特定的格式，参见例2。

⑵ 在ResourceBundle获取对象中使用到了Locale是以中国的形式，因此最后输出的是中文，如果想以美国作为Locale，那么将会输出英文：

修改代码为：

![ExpandedBlockStart.gif][]

![复制代码][copycode.gif]

1     ResourceBundle bundle = ResourceBundle.getBundle("com.fjdingsd.resource.MessageResource",Locale.US);
    2     String pattern = bundle.getString("message"); //获取模式字符串
    3     Object[] params = {
         new Date(),500,10000000};
    4         
    5     String content = MessageFormat.format(pattern, params);
    6     System.out.println(content);

![复制代码][copycode.gif]

输出：On 16-1-9 下午9:03, a typhoon destory 500 houses and caused 10,000,000 of damage.

看上去似乎很正确，但是在这些英文中出现了中文，而且是在占位符对应的地方，说明我们还未将MessageFormat对象的代表的语言国家环境修改，最终代码如下：

![ExpandedBlockStart.gif][]

![复制代码][copycode.gif]

1     ResourceBundle bundle = ResourceBundle.getBundle("com.fjdingsd.resource.MessageResource",Locale.US);
    2     String pattern = bundle.getString("message");  //获取模式字符串
    3     Object[] params = {
         new Date(),500,10000000};
    4         
    5     MessageFormat mf = new MessageFormat(pattern, Locale.US);
    6     String content = mf.format(params);
    7     System.out.println(content);

![复制代码][copycode.gif]

输出：On 1/9/16 9:07 PM, a typhoon destory 500 houses and caused 10,000,000 of damage.

[ExpandedBlockStart.gif]: /images/20220406/f6d69bef60d2413db51b31a8b3e14278.png
[787876-20160119221419390-913191746.png]: /images/20220406/b26cfa5b732d4a8ca792d0a0fe12ff1c.png
[787876-20160119221526265-557221913.png]: /images/20220406/da70a733e7cb41a9a28caa5604774bb6.png
[copycode.gif]: /images/20220406/c72cd455c4b5491fa1c99cb354add542.png
[787876-20160119221636672-1452233749.png]: /images/20220406/f9f7ea8d8c574d998127f9f972a7ede1.png
[787876-20160119221732078-50122626.png]: /images/20220406/1f88baaf7c0d47658278ffe61cbe013f.png
[787876-20160119221746000-1979623390.png]: /images/20220406/99a3543c5feb4f16a74932ff2e261bec.png
[787876-20160119221808234-1863780849.png]: /images/20220406/8758d5738a5b4f2dbcb4ad30c6171295.png