Java格式化输出printf()详解

怼烎@ 2022-12-06 15:23 264阅读 0赞

**概要：** 本文通过实例详细介绍Java格式化输出 System.out.printf() 方法的使用、参数的含义、格式转换符使用时的注意事项。

### 文章目录 ###

*   *  1. printf API
     *  2. 参数说明
     *   *  1. format
         *   *  表1-用于printf flags(标志) 说明
             *  表2-用于printf conversion(转换符) 说明
             *  补充1: 使用 s 转换符格式化任意的对象
             *  补充2: String.format()
             *  表3-日期和时间的转换符
         *  2. args
         *  3. locale
     *  3.printf 使用实例
     *  关于 printf 转换符使用的注意事项

`System.out.printf()` 是 Java 5 开始引入的，用法类似 C语言的 printf() 函数， **但注意存在一定差异**。

## 1. printf API ##

// 使用指定的格式字符串和参数将格式化字符串写入入到输出流
    public PrintStream printf(String format, Object ... args)
    
    // 基于本地化环境使用指定的格式字符串和参数将格式化字符串写入到输出流
    public PrintStream printf(Locale l, String format, Object ... args)

以上2个方法，当 format 为 null 时，抛出 NPE.

## 2. 参数说明 ##

### 1. format ###

format 是以百分号(%) 开头的格式说明字符串，具体格式如下

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

![img-01][]

*  可选的 *argument\_index* 是十进制整数，表示参数列表中参数的位置。 第一个参数由“ `1$` ”引用，第二个由“ `2$` ” 引用 ，等等。 *argument\_index* 必须紧跟`%`后面，并以`$` 结束。
    
    note: 参数索引值从1开始，而不是从0开始，`%1$` 对第一个参数格式化。这就避免了与0标志混淆。
 *  可选 *flags* 指定格式化输出外观的各种标志。 有效标志集取决于 conversion。
 *  可选 *width*是正十进制整数，表示要写入到输出的字符个数（**注意对于浮点数：也包含小数点所占的1个字和 负数的负号所占的1个字符）**。 **当实际字符数小于指定的宽度时，最前面用 flags 指定的标志填充（若未指定，默认用空格）。**
    
    eg: v=2.3, `%5.2f` 输出`5.20`，且前面包含1个空格。共打印5个字符，整数位1个5，1个小数点，2个精度，长度为4，比指定的宽度少1为，用1个前导空格代替。
 *  可选 *precision* 是一个非负十进制整数，通常用于限制字符数。 具体行为取决于转换。
 *  *conversion* **（必需）** 是一个字符，指示如何格式化参数。 给定参数的有效转换集取决于参数的数据类型。

#### 表1-用于printf flags(标志) 说明 ####

<table> 
 <thead> 
  <tr> 
   <th>标志</th> 
   <th>目的</th> 
   <th>示例</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>+</td> 
   <td>打印正数和负数的符号</td> 
   <td>+3333.33</td> 
  </tr> 
  <tr> 
   <td>空格</td> 
   <td>在正数之前添加空格</td> 
   <td>| 3333.33|</td> 
  </tr> 
  <tr> 
   <td>0</td> 
   <td>数字前面补0</td> 
   <td>003333.33</td> 
  </tr> 
  <tr> 
   <td>-</td> 
   <td>左对齐（不指定-时，默认为右对齐）</td> 
   <td>|3333.33 |</td> 
  </tr> 
  <tr> 
   <td>(</td> 
   <td>将负数括在括号内</td> 
   <td>%d,-90输出(90)</td> 
  </tr> 
  <tr> 
   <td>,（英文逗号）</td> 
   <td>添加分组分隔符，<strong>只对定点浮点数整数部分添加分组分隔符，小数部分不会添加</strong></td> 
   <td>3,333.33</td> 
  </tr> 
  <tr> 
   <td>#（对于f格式）</td> 
   <td>包含小数点</td> 
   <td>3,333.</td> 
  </tr> 
  <tr> 
   <td>#（对于x或o格式）</td> 
   <td>添加前缀0x或0</td> 
   <td>0xcafe</td> 
  </tr> 
  <tr> 
   <td>$</td> 
   <td>指定要格式化的参数索引。例如，%1<span><span><span> d d %1 </span><span><span><span style="height: 0.69444em; vertical-align: 0em;"></span><span>d</span></span></span></span></span>x 将以十进制和十六进制格式打印第1个参数</td> 
   <td>159 9F</td> 
  </tr> 
  <tr> 
   <td>&lt;</td> 
   <td>＜格式化前面说明的数值。例如，<code>%d&lt;%x</code> 将以十进制和十六进制打印同一个值</td> 
   <td>159 9F</td> 
  </tr> 
 </tbody> 
</table>

#### 表2-用于printf conversion(转换符) 说明 ####

<table> 
 <thead> 
  <tr> 
   <th>转换符</th> 
   <th>类型</th> 
   <th>示例</th> 
   <th>转换符</th> 
   <th>类型</th> 
   <th>示例</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>d</td> 
   <td>十进制整数</td> 
   <td>159</td> 
   <td>s</td> 
   <td>字符串</td> 
   <td>hello</td> 
  </tr> 
  <tr> 
   <td>x</td> 
   <td>十六进制整数</td> 
   <td>9f</td> 
   <td>c</td> 
   <td>字符</td> 
   <td>H</td> 
  </tr> 
  <tr> 
   <td>o</td> 
   <td>八进制整数</td> 
   <td>237</td> 
   <td>b</td> 
   <td>布尔</td> 
   <td>true</td> 
  </tr> 
  <tr> 
   <td>f</td> 
   <td>定点浮点数</td> 
   <td>1.59e+01</td> 
   <td>h</td> 
   <td>散列码</td> 
   <td>42628b2</td> 
  </tr> 
  <tr> 
   <td>e</td> 
   <td>指数浮点数</td> 
   <td></td> 
   <td>tx或Yx</td> 
   <td>日期时间（T强制大写）</td> 
   <td>已经过时，应当改为使用 java.time 类。</td> 
  </tr> 
  <tr> 
   <td>g</td> 
   <td>通用浮点数(e和f中较短的一个)</td> 
   <td>——</td> 
   <td>%</td> 
   <td>百分号</td> 
   <td>%</td> 
  </tr> 
  <tr> 
   <td>a</td> 
   <td>16进制浮点数</td> 
   <td>0x1.fccdp3</td> 
   <td>n</td> 
   <td>与平台有关的换行符</td> 
   <td>——</td> 
  </tr> 
 </tbody> 
</table>

#### 补充1: 使用 s 转换符格式化任意的对象 ####

**可以使用 s 转换符格式化任意的对象。** 对于实现了 **Formattable** 接口的任意对象，将调用这个对象的 **formatTo** 方法；否则调用 **toString** 方法将这个对象转换为字符串。

#### 补充2: String.format() ####

使用 `String.format()` 方法可创建一个格式化的字符串，而不打印输出。API:

public static String format(String format, Object... args)
    public static String format(Locale l, String format, Object... args)

参数和 printf() 中的含义相同。

#### 表3-日期和时间的转换符 ####

**Note: 以下格式符已经过时，对于新的代码，应当使用 java.time 包的方法。**

eg: `System.out.printf("%tc",new Date());`这条语句将用下面的格式打印当前的日期和时间:

Mon Feb 09 18:05:19 PST 2015

**下面的转换符前面都必须用 t/T 修饰。**

<table> 
 <thead> 
  <tr> 
   <th>转换符</th> 
   <th>类型</th> 
   <th>示例</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>c</td> 
   <td>完整的日期和时间</td> 
   <td>Mon Feb 09 18:05:19 PST 2015</td> 
  </tr> 
  <tr> 
   <td>F</td> 
   <td>ISO 8601日期</td> 
   <td>2015/2/9</td> 
  </tr> 
  <tr> 
   <td>D</td> 
   <td>美国格式的日期（月/日/年）</td> 
   <td>02/09/2015</td> 
  </tr> 
  <tr> 
   <td>T</td> 
   <td>24小时时间</td> 
   <td>18:05:19</td> 
  </tr> 
  <tr> 
   <td>r</td> 
   <td>12小时时间</td> 
   <td>6:05:19</td> 
  </tr> 
  <tr> 
   <td>R</td> 
   <td>24小时时间，没有秒</td> 
   <td>18:05</td> 
  </tr> 
  <tr> 
   <td>Y</td> 
   <td>4位数字的年（前面补0</td> 
   <td>2015</td> 
  </tr> 
  <tr> 
   <td>y</td> 
   <td>年的后两位数字（前面补0）</td> 
   <td>15</td> 
  </tr> 
  <tr> 
   <td>C</td> 
   <td>年的前两位数字（前面补0）</td> 
   <td>20</td> 
  </tr> 
  <tr> 
   <td>B</td> 
   <td>月的完整拼写</td> 
   <td>February</td> 
  </tr> 
  <tr> 
   <td>b或h</td> 
   <td>月的缩写</td> 
   <td>Feb</td> 
  </tr> 
  <tr> 
   <td>m</td> 
   <td>两位数字的月（前面补0）</td> 
   <td>02</td> 
  </tr> 
  <tr> 
   <td>d</td> 
   <td>两位数字的日（前面补0）</td> 
   <td>09</td> 
  </tr> 
  <tr> 
   <td>e</td> 
   <td>两位数字的日（前面不补0</td> 
   <td>9</td> 
  </tr> 
  <tr> 
   <td>A</td> 
   <td>星期几的完整拼写</td> 
   <td>Monday</td> 
  </tr> 
  <tr> 
   <td>a</td> 
   <td>星期几的缩写</td> 
   <td>Mon</td> 
  </tr> 
  <tr> 
   <td>j</td> 
   <td>三位数的年中第几天（前面补0）,在001到366之间</td> 
   <td>069</td> 
  </tr> 
  <tr> 
   <td>H</td> 
   <td>两位数字的小时（前面补0），在0到23之间</td> 
   <td>18</td> 
  </tr> 
  <tr> 
   <td>k</td> 
   <td>两位数字的小时（前面不补0），在0到23之间</td> 
   <td>18</td> 
  </tr> 
  <tr> 
   <td>I</td> 
   <td>两位数字的小时（前面补0），在01到12之间</td> 
   <td>06</td> 
  </tr> 
  <tr> 
   <td>l</td> 
   <td>两位数字的小时（前面不补0），在1到12之间</td> 
   <td>6</td> 
  </tr> 
  <tr> 
   <td>M</td> 
   <td>两位数字的分钟（前面补0）</td> 
   <td>05</td> 
  </tr> 
  <tr> 
   <td>S</td> 
   <td>两位数字的秒（前面补0）</td> 
   <td>19</td> 
  </tr> 
  <tr> 
   <td>L</td> 
   <td>三位数字的毫秒（前面补0）</td> 
   <td>047</td> 
  </tr> 
  <tr> 
   <td>N</td> 
   <td>九位数字的毫微秒（前面补0）</td> 
   <td>047000000</td> 
  </tr> 
  <tr> 
   <td>p</td> 
   <td>上午或下午的标志</td> 
   <td>pm</td> 
  </tr> 
  <tr> 
   <td>z</td> 
   <td>从 GMT 起，RFC 822 数字位移</td> 
   <td>-800</td> 
  </tr> 
  <tr> 
   <td>Z</td> 
   <td>时区</td> 
   <td>PST</td> 
  </tr> 
  <tr> 
   <td>s</td> 
   <td>从格林尼治时间 1970-01-01 00:00:00 起的秒数</td> 
   <td>1078884319</td> 
  </tr> 
  <tr> 
   <td>Q</td> 
   <td>从格林尼治时间 1970-01-01 00:00:00 起的毫秒数</td> 
   <td>1078884319047</td> 
  </tr> 
 </tbody> 
</table>

从上表可以看到，某些格式只给出了指定日期的部分信息。例如，只有日期或月份。如果需要多次提供日期来分别格式化每一部分就太笨拙了。为此，可以用一个格式字符串指示要格式化的参数索引。索引必须紧跟在％后面，并以＄终止。例如，

System.out.printf("%1$s %2$tB %2$te, %2$tY","Due date:",new Date());

会打印

Due date: February 9, 2015

还可以选择使用<标志。它指示前面格式说明中的参数将被再次使用。也就是说，以下语句将产生与前面语句同样的输出结果:

System.out.printf("%1$s %tB %<te, %<tY","Due date:",new Date());

### 2. args ###

args : 格式字符串中格式说明符引用的参数。如果参数多于格式说明符，则忽略额外参数。 参数的数量是可变的，可以为零。 参数的最大数量受The Java Virtual Machine Specification（java虚拟机规范）定义的Java数组的最大维数限制。 null参数上的行为取决于 conversion（转换符） 。

### 3. locale ###

数字和日期的格式化规则是**特定于本地化环境的。** 例如，在德国，分组分隔符是点号而不是逗号，另外 Monday被格式化为 Montag。**locale主要用于如何控制应用的国际化行为。**

## 3.printf 使用实例 ##

// +199 199 c7 307 0xc7 0307
    System.out.printf("%+d %<d %<x %<o %<#x %<#o\n",199);
    
    // | 23| |23|
    System.out.printf("|% d| |%<d|\n",23);
    
    // hello 第5个字符是o,that's true
    System.out.printf("%s 第%d个字符是%c,that's %b\n","hello",5,'o',true);
    
    // 15 % 6 = 3
    System.out.printf("%2$d %% %1$d = %3$d\n",6,15, 15 % 6);
    
    // |  7.33| |007.33| |7.330000| 0x1.d51eb851eb852p2
    System.out.printf("|%6.2f| |%0<6.2f| |%<f| %<a\n",7.33);
    
    // | 211.79| |211.79 |
    System.out.printf("|%7.2f| |%<-7.2f|\n",211.79);
    
    // | -211.79| |(211.79)| |(-211.79)|
    System.out.printf("|%8.2f| |%<(8.2f| |(%<.2f)|\n",-211.79);
    
    // |-21171.3333| |-21,171.3333| |-2.1171e+04| |-2.117e+04|
    System.out.printf("|%.4f| |%<,.4f| |%<.4e| |%<.4g|\n",-21171.3333);
    
    String str = new String("tree");
    // Note: %h 格式符输出对象的散列码 和 调用对象的hashCode 得到的值并不相同
    // obj %h formatinput: 36739e,hashCode:3568542
    System.out.printf("obj %%h formatinput: %h,hashCode:%s\n",str,str.hashCode());
    
    // true 25 0.0032 含
    System.out.printf("%s %s %s %s\n",true,25,3.2e-3,'含');
    
    System.out.printf("|%n| \n","world");
    System.out.printf("|%n| \n");

输出

+199 199 c7 307 0xc7 0307
    | 23| |23|
    hello 第5个字符是o,that's true
    15 % 6 = 3
    |  7.33| |007.33| |7.330000| 0x1.d51eb851eb852p2
    | 211.79| |211.79 |
    | -211.79| |(211.79)| |(-211.79)|
    |-21171.3333| |-21,171.3333| |-2.1171e+04| |-2.117e+04|
    obj %h formatinput: 36739e,hashCode:3568542
    true 25 0.0032 含
    |
    | 
    |
    |

## 关于 printf 转换符使用的注意事项 ##

*  **适用于浮点类型转换符（e,g,a,f）不能用于整形; 同样适用于整形的转换符（d,o,x）不能用于浮点型。**
 *  **可以使用 s 转换符格式化任意的对象。** 对于实现了 **Formattable** 接口的任意对象，将调用这个对象的 **formatTo** 方法；否则调用 **toString** 方法将这个对象转换为字符串。

eg:

// test in jdk 8,11,14
    
    // Exception in thread "main" java.util.IllegalFormatConversionException: o != java.lang.Float
    System.out.printf("%o\n",2.3f);
    
    // Exception in thread "main" java.util.IllegalFormatConversionException: f != java.lang.Integer
    System.out.printf("%f\n",25);

**(本文完)**

[img-01]: /images/20221123/82d728b9241b46128303f2c28a1e558b.png