Java 中字符串的格式化

1、格式字符串语法

产生格式化输出的每个方法都需要格式字符串 和参数列表。格式字符串是一个String，它可以包含固定文本以及一个或多个嵌入的格式说明符。请考虑以下示例：

Calendar c = Calendar.getInstance();
String s = String.format("今天是：%1$tY年%1$tm月%1$te日", c);

此格式字符串是 format 方法的第一个参数。它包含三个格式说明符 "%1$tm"、"%1$te" 和 "%1$tY"，它们指出应该如何处理参数以及在文本的什么地方插入它们。格式字符串的其余部分是固定文本。 参数列表由传递给位于格式字符串之后的方法的所有参数组成。在上述示例中，参数列表的大小为 1，由对象 Calendar c 组成。

1.1、常规类型、字符类型和数值类型的格式说明符的语法

%[argument_index$][flags][width][.precision]conversion

可选的 argument_index 是一个十进制整数，用于表明参数在参数列表中的位置。第一个参数由 "1$" 引用，第二个参数由 "2$" 引用，依此类推。

可选 flags 是修改输出格式的字符集。有效标志集取决于转换类型。

可选 width 是一个非负十进制整数，表明要向输出中写入的最少字符数。

可选 precision 是一个非负十进制整数，通常用来限制字符数。特定行为取决于转换类型。

所需 conversion 是一个表明应该如何格式化参数的字符。给定参数的有效转换集取决于参数的数据类型。

1.2、日期和时间类型的格式说明符的语法

%[argument_index$][flags][width]conversion

可选的 argument_index、flags 和 width 的定义同上。

所需的 conversion 是一个由两字符组成的序列。第一个字符是 't' 或 'T'。第二个字符表明所使用的格式。这些字符类似于但不完全等同于那些由 GNU date 和 POSIX strftime(3c) 定义的字符。

1.3、与参数不对应的格式说明符的语法

%[flags][width]conversion

可选 flags 和 width 的定义同上。

所需的 conversion 是一个表明要在输出中所插内容的字符。

2、转换

转换可以分为以下几类：

常规 - 可应用于任何参数类型
字符 - 可应用于表示 Unicode 字符的基本类型：char、Character、byte、Byte、short 和 Short。当 Character.isValidCodePoint(int) 返回 true 时，可将此转换应用于 int 和 Integer 类型
数值
1. 整数 - 可应用于 Java 的整数类型：byte、Byte、short、Short、int、Integer、long、Long 和 BigInteger
2. 浮点 - 可用于 Java 的浮点类型：float、Float、double、Double 和 BigDecimal
日期/时间 - 可应用于 Java 的、能够对日期或时间进行编码的类型：long、Long、Calendar 和 Date。
百分比 - 产生字面值 '%' ('\u0025')
行分隔符 - 产生特定于平台的行分隔符

下表总结了受支持的转换。由大写字符（如 'B'、'H'、'S'、'C'、'X'、'E'、'G'、'A' 和 'T'）表示的转换与由相应的小写字符的转换等同，根据流行的 Locale 规则将结果转换为大写形式除外。后者等同于String.toUpperCase() 的以下调用：out.toUpperCase()

转换	参数类别	说明
`'b'`, `'B'`	常规	如果参数 arg 为 `null`，则结果为 "`false`"。如果 arg 是一个 `boolean` 值或 `Boolean`，则结果为 `String.valueOf()` 返回的字符串。否则结果为 "true"。
`'h'`, `'H'`	常规	如果参数 arg 为 `null`，则结果为 "`null`"。否则，结果为调用 `Integer.toHexString(arg.hashCode())` 得到的结果。
`'s'`, `'S'`	常规	如果参数 arg 为 `null`，则结果为 "`null`"。如果 arg 实现 `Formattable`，则调用 `arg.formatTo`。否则，结果为调用 `arg.toString()` 得到的结果。
`'c'`, `'C'`	字符	结果是一个 Unicode 字符
`'d'`	整数	结果被格式化为十进制整数
`'o'`	整数	结果被格式化为八进制整数
`'x'`, `'X'`	整数	结果被格式化为十六进制整数
`'e'`, `'E'`	浮点	结果被格式化为用计算机科学记数法表示的十进制数
`'f'`	浮点	结果被格式化为十进制数
`'g'`, `'G'`	浮点	根据精度和舍入运算后的值，使用计算机科学记数形式或十进制格式对结果进行格式化。
`'a'`, `'A'`	浮点	结果被格式化为带有效位数和指数的十六进制浮点数
`'t'`, `'T'`	日期/时间	日期和时间转换字符的前缀。请参阅日期/时间转换。
`'%'`	百分比	结果为字面值 `'%'` (`'\u0025'`)
`'n'`	行分隔符	结果为特定于平台的行分隔符

任何未明确定义为转换的字符都是非法字符，并且都被保留，以供将来扩展使用。

以下日期和时间转换的后缀字符是为 't' 和 'T' 转换定义的。这些类型相似于但不完全等同于那些由 GNU date 和 POSIX strftime(3c) 定义的类型。提供其他转换类型是为了访问特定于 Java 的功能（如将 'L' 用作秒中的毫秒）。

2.1.、格式化时间：

`'H'`	24 小时制的小时，被格式化为必要时带前导零的两位数，即 `00 - 23`。
`'I'`	12 小时制的小时，被格式化为必要时带前导零的两位数，即 `01 - 12`。
`'k'`	24 小时制的小时，即 `0 - 23`。
`'l'`	12 小时制的小时，即 `1 - 12`。
`'M'`	小时中的分钟，被格式化为必要时带前导零的两位数，即 `00 - 59`。
`'S'`	分钟中的秒，被格式化为必要时带前导零的两位数，即 `00 - 60` （"`60`" 是支持闰秒所需的一个特殊值）。
`'L'`	秒中的毫秒，被格式化为必要时带前导零的三位数，即 `000 - 999`。
`'N'`	秒中的毫微秒，被格式化为必要时带前导零的九位数，即 `000000000 - 999999999`。
`'p'`	特定于语言环境的上午或下午标记以小写形式表示，例如 "`am`" 或 "`pm`"。使用转换前缀 `'T'` 可以强行将此输出转换为大写形式。
`'z'`	相对于 GMT 的 RFC 822 格式的数字时区偏移量，例如 `-0800`。
`'Z'`	表示时区缩写形式的字符串。Formatter 的语言环境将取代参数的语言环境（如果有）。
`'s'`	自协调世界时 (UTC) 1970 年 1 月 1 日 `00:00:00` 至现在所经过的秒数，即 `Long.MIN_VALUE/1000` 与 `Long.MAX_VALUE/1000` 之间的差值。
`'Q'`	自协调世界时 (UTC) 1970 年 1 月 1 日 `00:00:00` 至现在所经过的毫秒数，即 `Long.MIN_VALUE` 与 `Long.MAX_VALUE` 之间的差值。

2.2、格式化日期：

`'B'`	特定于语言环境的月份全称，例如 `"January"` 和 `"February"`。
`'b'`	特定于语言环境的月份简称，例如 `"Jan"` 和 `"Feb"`。
`'h'`	与 `'b'` 相同。
`'A'`	特定于语言环境的星期几全称，例如 `"Sunday"` 和 `"Monday"`
`'a'`	特定于语言环境的星期几简称，例如 `"Sun"` 和 `"Mon"`
`'C'`	除以 `100` 的四位数表示的年份，被格式化为必要时带前导零的两位数，即 `00 - 99`
`'Y'`	年份，被格式化为必要时带前导零的四位数（至少），例如，`0092` 等于格里高利历的 `92` CE。
`'y'`	年份的最后两位数，被格式化为必要时带前导零的两位数，即 `00 - 99`。
`'j'`	一年中的天数，被格式化为必要时带前导零的三位数，例如，对于格里高利历是 `001 - 366`。
`'m'`	月份，被格式化为必要时带前导零的两位数，即 `01 - 13`。
`'d'`	一个月中的天数，被格式化为必要时带前导零两位数，即 `01 - 31`
`'e'`	一个月中的天数，被格式化为两位数，即 `1 - 31`。

2.3、格式化常见的日期/时间组合：

`'R'`	24 小时制的时间，被格式化为 `"%tH:%tM"`
`'T'`	24 小时制的时间，被格式化为 `"%tH:%tM:%tS"`。
`'r'`	12 小时制的时间，被格式化为 `"%tI:%tM:%tS %Tp"`。上午或下午标记 (`'%Tp'`) 的位置可能与语言环境有关。
`'D'`	日期，被格式化为 `"%tm/%td/%ty"`。
`'F'`	ISO 8601 格式的完整日期，被格式化为 `"%tY-%tm-%td"`。
`'c'`	日期和时间，被格式化为 `"%ta %tb %td %tT %tZ %tY"`，例如 `"Sun Jul 20 16:17:00 EDT 1969"`。

任何未明确定义为转换的字符都是非法字符，并且都被保留，以供将来扩展使用。

3、标志

下表总结了受支持的标志。y 表示该标志受指示参数类型支持。

标志	常规	字符	整数	浮点	日期/时间	说明
'-'	y	y	y	y	y	结果将是左对齐的。
'#'	y¹	-	y³	y	-	结果应该使用依赖于转换类型的替换形式
'+'	-	-	y⁴	y	-	结果总是包括一个符号
' '	-	-	y⁴	y	-	对于正值，结果中将包括一个前导空格
'0'	-	-	y	y	-	结果将用零来填充
','	-	-	y²	y⁵	-	结果将包括特定于语言环境的组分隔符
'('	-	-	y⁴	y⁵	-	结果将是用圆括号括起来的负数

¹ 取决于 Formattable 的定义。

² 只适用于 'd' 转换。

³ 只适用于 'o'、'x' 和 'X' 转换。

⁴ 对 BigInteger 应用 'd'、'o'、'x' 和 'X' 转换时，或者对 byte 及 Byte、short 及 Short、int 及 Integer、long 及 Long 分别应用 'd' 转换时适用。

⁵ 只适用于 'e'、'E'、'f'、'g' 和 'G' 转换。

任何未显式定义为标志的字符都是非法字符，并且都被保留，以供扩展使用。

4、宽度

宽度是将向输出中写入的最少字符数。对于行分隔符转换，不适用宽度，如果提供宽度，则会抛出异常。

5、精度

对于常规参数类型，精度是将向输出中写入的最多字符数。

对于浮点转换 'e'、'E' 和 'f'，精度是小数点分隔符后的位数。如果转换是 'g' 或 'G'，那么精度是舍入计算后所得数值的所有位数。如果转换是 'a' 或 'A'，则不必指定精度。

对于字符、整数和日期/时间参数类型转换，以及百分比和行分隔符转换，精度是不适用的；如果提供精度，则会抛出异常。

6、参数索引

参数索引是一个十进制整数，用于表明参数在参数列表中的位置。第一个参数由 "1$" 引用，第二个参数由 "2$" 引用，依此类推。

根据位置引用参数的另一种方法是使用 '<' ('\u003c') 标志，这将会重用以前格式说明符的参数。例如，以下两条语句产生的字符相同：

Calendar c = Calendar.getInstance();
String s1 = String.format("今天是：%1$tY年%1$tm月%1$te日", c);
String s2 = String.format("今天是：%1$tY年%<tm月%<te日", c);

在格式说明符中既不包含参数索引也不包含 '<' 标志时使用。每个使用普通索引的格式说明符都分配了一个连续隐式索引，分配在独立于显式索引或相对索引使用的参数列表中。例如：

Formatter formatter = new Formatter();
System.out.println(formatter.format("%s %s %s %s", "a", "b", "c", "d"));
//Output: "a b c d"

可能有一个使用所有索引形式的格式字符串，例如：

Formatter formatter = new Formatter();
System.out.println(formatter.format("%2$s %s %<s %s", "a", "b", "c", "d"));
//Output: "b a a b"
// "c" 和 "d" 因为没有被分配索引而被忽略了