Java格式化工具详解：解决代码对齐问题

欢迎各位小伙伴来到golang学习网，相聚于此都是缘哈哈哈！今天我给大家带来《Java Formatter详解：解决拼接与对齐问题》，这篇文章主要讲到等等知识，如果你对文章相关的知识非常感兴趣或者正在自学，都可以关注我，我会持续更新相关文章！当然，有什么建议也欢迎在评论留言提出！一起学习！

本文深入探讨了Java中`java.util.Formatter`在重复使用同一实例时可能导致的字符串拼接与对齐异常。通过分析其内部机制，提供了多种正确的解决方案，包括每次创建新实例、利用`String.format()`便捷方法以及一次性格式化整个字符串，旨在帮助开发者避免常见陷阱，实现精确的字符串输出。

1. java.util.Formatter 的重复使用陷阱

在Java中，java.util.Formatter 类提供了一种强大的机制来格式化字符串输出，类似于C语言中的printf。然而，当开发者尝试重复使用同一个 Formatter 实例来格式化多行或多个独立的字符串片段时，可能会遇到意料之外的结果，尤其是在字符串拼接的场景中。

考虑以下代码示例，它尝试使用同一个 Formatter 实例来生成三行格式化后的文本：

import java.util.Formatter;

public class FormatterIssue {

    public static String demonstrateProblem() {
        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("--- 原始代码输出 ---");
        System.out.println(demonstrateProblem());
    }
}

运行上述代码，其输出结果如下：

--- 原始代码输出 ---
Subtotal                          400
Subtotal                          400IVA 21%                           55
Subtotal                          400IVA 21%                           55TOTAL                    555

这与我们预期的每行独立格式化的结果（如下所示）大相径庭：

Subtotal    400
IVA 21%     55
TOTAL       555

2. 问题根源分析：Formatter 的状态性

出现这种非预期结果的原因在于 java.util.Formatter 实例是有状态的。当创建一个 Formatter 实例时，它通常会关联一个内部的 Appendable 对象（例如 StringBuilder 或 StringBuffer）。每次调用 format() 方法时，格式化后的字符串内容会被追加到这个内部的 Appendable 中。format() 方法的返回值是 Formatter 实例本身，而不是格式化后的字符串。为了获取格式化后的字符串，通常需要调用 toString() 方法。

在上述问题代码中：

1. Formatter fmt = new Formatter(); 创建了一个新的 Formatter 实例，它内部关联了一个 StringBuilder。
2. String a = fmt.format("%1s %28d", "Subtotal", 400) + "\n";
   • fmt.format(...) 将 "Subtotal 400" 写入 fmt 内部的 StringBuilder。
   • fmt 对象本身被返回。
   • 然后，fmt.toString() 被隐式或显式调用（在字符串拼接时），获取当前 StringBuilder 的内容，即 "Subtotal 400"。
   • 最后，"\n" 被添加到 a 中。
3. String b = fmt.format("%1s %28d", "IVA 21%", 55) + "\n";
   • 关键点： 再次调用 fmt.format(...) 时，它会继续向同一个内部 StringBuilder 追加内容。此时 StringBuilder 中已经有了 "Subtotal 400"。追加 "IVA 21% 55" 后，StringBuilder 的内容变为 "Subtotal 400IVA 21% 55"。
   • fmt.toString() 再次获取当前 StringBuilder 的内容，即 "Subtotal 400IVA 21% 55"。
   • "\n" 被添加到 b 中。
4. String c = fmt.format("%1s %28d", "TOTAL", 555) + "\n"; 依此类推，c 会包含 StringBuilder 中累积的所有内容。

这就是为什么 a、b、c 变量会包含重复的、累积的字符串内容，而不是独立的格式化结果。

3. 正确的字符串格式化与拼接方法

为了避免上述问题，并实现预期的字符串格式化效果，可以采用以下几种策略：

3.1 每次创建新的 Formatter 实例

最直接的解决方案是确保每次需要独立的格式化输出时，都创建一个新的 Formatter 实例。这样可以保证每个格式化操作都在一个干净、独立的环境中进行。

import java.util.Formatter;

public class FormatterSolution1 {

    public static String formatWithNewFormatterPerLine() {
        // 使用 - 标志进行左对齐，例如 %-10s 表示左对齐，宽度为10
        // %5d 表示右对齐，宽度为5
        String a = new Formatter().format("%-10s %5d", "Subtotal", 400).toString() + "\n";
        String b = new Formatter().format("%-10s %5d", "IVA 21%", 55).toString() + "\n";
        String c = new Formatter().format("%-10s %5d", "TOTAL", 555).toString() + "\n";
        return a + b + c;
    }

    public static void main(String[] argv) {
        System.out.println("--- 方案一：每次创建新 Formatter ---");
        System.out.println(formatWithNewFormatterPerLine());
    }
}

输出结果：

--- 方案一：每次创建新 Formatter ---
Subtotal      400
IVA 21%        55
TOTAL         555

3.2 使用 String.format() 方法

String.format() 是一个静态方法，它内部会创建一个 Formatter 实例，执行格式化操作，然后返回结果字符串。每次调用 String.format() 都会独立完成格式化，因此它天然地避免了 Formatter 实例重复使用的问题，并且通常是进行单次字符串格式化的推荐方式。

public class FormatterSolution2 {

    public static String formatWithStringFormat() {
        // 使用 - 标志进行左对齐，例如 %-10s 表示左对齐，宽度为10
        // %5d 表示右对齐，宽度为5
        String a = String.format("%-10s %5d", "Subtotal", 400) + "\n";
        String b = String.format("%-10s %5d", "IVA 21%", 55) + "\n";
        String c = String.format("%-10s %5d", "TOTAL", 555) + "\n";
        return a + b + c;
    }

    public static void main(String[] argv) {
        System.out.println("--- 方案二：使用 String.format() ---");
        System.out.println(formatWithStringFormat());
    }
}

输出结果：

--- 方案二：使用 String.format() ---
Subtotal      400
IVA 21%        55
TOTAL         555

3.3 一次性格式化整个字符串

如果整个输出结构是预先确定的，并且包含多个部分，那么可以将所有内容组织到一个大的格式化字符串中，通过一次 String.format() 调用完成。这通常在生成报表、日志或固定格式文本时非常有用。

public class FormatterSolution3 {

    public static String formatEntireStringAtOnce() {
        // 使用 - 标志进行左对齐，例如 %-10s 表示左对齐，宽度为10
        // %5d 表示右对齐，宽度为5
        // %n 是平台独立的换行符
        return String.format(
            "%-10s %5d%n" +
            "%-10s %5d%n" +
            "%-10s %5d%n",
            "Subtotal", 400,
            "IVA 21%", 55,
            "TOTAL", 555
        );
    }

    public static void main(String[] argv) {
        System.out.println("--- 方案三：一次性格式化整个字符串 ---");
        System.out.println(formatEntireStringAtOnce());
    }
}

输出结果：

--- 方案三：一次性格式化整个字符串 ---
Subtotal      400
IVA 21%        55
TOTAL         555

注意事项： 原始问题答案中提供了一个将所有数据格式化到一行的例子。虽然它也是一次性格式化的方法，但其输出样式与原问题期望的列式对齐不同。例如：

// 原始答案中的示例，将所有内容格式化到一行
String resultSingleLine = String.format(
     "%s %3d %12s %3d %10s %3d %n",
     "Subtotal", 400, "IVA 21%", 55, "TOTAL", 555
);
System.out.println(resultSingleLine);
// 输出: Subtotal 400      IVA 21%  55      TOTAL 555

这种方法适用于需要将多个相关数据项并排显示在一个逻辑行中的场景。关键在于根据实际需求选择合适的格式化字符串和参数。

4. 总结与最佳实践

理解 java.util.Formatter 的状态性是避免字符串格式化陷阱的关键。

• java.util.Formatter 是有状态的： 它的 format() 方法会向内部的 Appendable 追加内容，而不是每次都返回一个新的独立字符串。
• String.format() 是推荐的单次格式化方法： 对于大多数简单的、一次性的字符串格式化需求，String.format() 方法是最佳选择，因为它内部处理了 Formatter 实例的创建和关闭，提供了简洁且无副作用的接口。
• 重复格式化时，确保独立性： 如果确实需要使用 Formatter 实例进行多次格式化（例如，为了控制输出到特定的 Appendable），请确保每次需要独立结果时都创建一个新的 Formatter 实例，或者在每次调用后清空或重置其内部状态（如果 Formatter 提供了这样的机制，但通常不推荐）。
• 利用格式化字符串的强大功能： 熟练掌握格式化字符串中的各种标志、宽度和精度说明符（如 %s、%d、%f、%-Ns、%n 等），可以实现高度灵活和精确的文本对齐和输出。

通过遵循这些原则，开发者可以有效利用Java的字符串格式化功能，生成清晰、准确且符合预期的文本输出。

文中关于的知识介绍，希望对你的学习有所帮助！若是受益匪浅，那就动动鼠标收藏这篇《Java格式化工具详解：解决代码对齐问题》文章吧，也可关注golang学习网公众号了解相关技术文章。