本文深入探讨了Java中`Formatter`类在字符串拼接时常见的陷阱，特别是重复使用同一实例导致输出异常的问题。通过分析`Formatter`的内部状态机制，文章提供了多种实现精确字符串格式化的解决方案，包括独立使用`String.format()`、为每次操作创建新`Formatter`实例，以及利用单个`Formatter`构建多行输出的正确方法，并结合实际代码示例，旨在帮助开发者高效、准确地处理Java字符串格式化需求。
在Java开发中，字符串的格式化输出是一项常见而重要的任务。java.util.Formatter类提供了强大的格式化能力，但如果不了解其内部工作机制，可能会遇到意想不到的问题。本文将深入分析一个典型的Formatter使用陷阱，并提供多种可靠的解决方案，帮助开发者实现精确、可控的字符串格式化。
问题解析：Formatter的内部状态与陷阱
考虑以下代码片段，它尝试使用同一个Formatter实例来格式化并拼接多行字符串：
public class Test {
public static String test() {
Formatter fmt = new Formatter();
String a = fmt.format("%1s %28d", "Subtotal", 400) + "\n";
String b = fmt.format("%1s %28d", "IVA 21%", 55) + "\n";
String c = fmt.format("%1s %28d", "TOTAL", 555) + "\n";
return a + b + c;
}
public static void main(String argv[]) {
System.out.println(test());
}
}这段代码的预期输出是三行独立的、格式对齐的数据，例如：
立即学习“Java免费学习笔记（深入）”；
Subtotal 400 IVA 21% 55 TOTAL 555
然而，实际运行结果却可能如下所示，出现了不正确的重复和拼接：
Subtotal 400 Subtotal 400IVA 21% 55 Subtotal 400IVA 21% 55TOTAL 555
这种异常输出的原因在于java.util.Formatter实例在每次调用format()方法时，会维护其内部状态，包括已经处理过的参数和内部缓冲区。当同一个Formatter实例被重复用于看似独立的格式化操作时，它可能会将新的格式化结果追加到之前的结果中，或者以不符合预期的状态进行处理，从而导致输出混乱。Formatter更适合于将格式化结果输出到一个Appendable对象（如StringBuilder或PrintStream），或者一次性构建一个复杂的格式化字符串。
解决方案
针对上述问题，我们有多种方法可以实现正确的字符串格式化。
方法一：独立使用 String.format()
最直接且推荐的方法是为每次独立的格式化操作调用String.format()。String.format()是一个静态方法，每次调用都会创建一个新的内部Formatter实例并立即处理格式化，因此不会受到之前操作的干扰。
public class FormatterDemo {
public static String formatLinesSeparately() {
// 使用%-Ns实现左对齐，%Nd实现右对齐，确保良好的对齐效果
String line1 = String.format("%-10s %20d", "Subtotal", 400);
String line2 = String.format("%-10s %20d", "IVA 21%", 55);
String line3 = String.format("%-10s %20d", "TOTAL", 555);
return line1 + "\n" + line2 + "\n" + line3;
}
public static void main(String[] args) {
System.out.println(formatLinesSeparately());
}
}输出示例：
Subtotal 400 IVA 21% 55 TOTAL 555
说明： %后紧跟的数字表示最小宽度，-表示左对齐，默认是右对齐。这里我们使用了%-10s来确保字符串左对齐并占据至少10个字符，%20d确保数字右对齐并占据至少20个字符，从而实现良好的对齐效果。
方法二：为每次格式化创建新的 Formatter 实例
如果出于某种原因需要使用Formatter类而非String.format()静态方法，那么正确的做法是为每次独立的格式化操作创建新的Formatter实例。
import java.util.Formatter;
public class FormatterDemo {
public static String newFormatterPerLine() {
StringBuilder sb = new StringBuilder();
// 使用try-with-resources确保Formatter关闭
try (Formatter fmt1 = new Formatter(sb)) {
fmt1.format("%-10s %20d\n", "Subtotal", 400);
}
try (Formatter fmt2 = new Formatter(sb)) {
fmt2.format("%-10s %20d\n", "IVA 21%", 55);
}
try (Formatter fmt3 = new Formatter(sb)) {
fmt3.format("%-10s %20d\n", "TOTAL", 555);
}
return sb.toString();
}
public static void main(String[] args) {
System.out.println(newFormatterPerLine());
}
}输出示例：
Subtotal 400 IVA 21% 55 TOTAL 555
说明： 每次格式化都创建了一个新的Formatter实例，并将其关联到一个StringBuilder。try-with-resources语句确保了Formatter在使用后被正确关闭，释放资源。
方法三：利用单个 Formatter 构建多行输出
如果希望使用单个Formatter实例来构建一个包含多行内容的字符串，正确的做法是将所有格式化指令和数据一次性传递给format()方法，或者利用其向Appendable对象（如StringBuilder）追加内容的特性。
import java.util.Formatter;
public class FormatterDemo {
public static String singleFormatterMultiLine() {
StringBuilder sb = new StringBuilder();
try (Formatter fmt = new Formatter(sb)) {
fmt.format("%-10s %20d\n", "Subtotal", 400);
fmt.format("%-10s %20d\n", "IVA 21%", 55);
fmt.format("%-10s %20d\n", "TOTAL", 555);
} // fmt在此处自动关闭
return sb.toString(); 
