Java循环打印对齐表格技巧

表格对齐的挑战

在Java中，当我们需要从数组或集合中循环打印数据以形成表格时，一个常见的挑战是确保各列内容能够整齐对齐。如果仅仅依赖制表符\t进行分隔，当列中的字符串长度不一致时，输出的表格就会出现错位，严重影响可读性。

例如，考虑以下代码片段尝试打印股票信息：

System.out.println("Stock Name\t" + "Stock Symbol\t" + "Previous Closing Price\t "
                          + "\t" + "Current Price\t" + "Change Percet\t");
for (int i = 0; i < 3; i++) {
    System.out.println(stockNameList[i] + "\t" + stockSymbol[i] + PreviousClosingPrice[i] 
                        + "\t" + CurrentPrice[i] + "\t" + GetChangePercent(CurrentPrice, PreviousClosingPrice) + "\t");
}

其输出可能如下所示：

Stock Name  Stock Symbol    Previous Closing Price      Current Price   Change Percent  
Saudi Aramco    2222.SR30.91    35.85   -66.3013687133789   
SABIC   2010.SR89.29    88.8    -66.3013687133789   
Alinam Bank 1150.SR12.3 36.5    -66.3013687133789

可以看到，由于“Stock Symbol”和“Previous Closing Price”等列的数据长度差异，导致后续列的内容无法正确对齐，使得表格显得杂乱无章。我们期望的输出效果是每一列都拥有固定的宽度，即使内容不足也用空格填充，从而保持整齐的垂直对齐。

解决方案：字符串填充（String Padding）

解决表格对齐问题的核心在于字符串填充（String Padding）。其基本思想是：为表格中的每一列预设一个固定的宽度。如果某个单元格的内容长度小于这个预设宽度，就用空格填充到该宽度；如果内容长度超出，则可以考虑截断或调整宽度。通过这种方式，无论原始数据长度如何，每个单元格在打印时都占据相同的水平空间，从而实现列的完美对齐。

在Java中，String.format()方法提供了强大的字符串格式化能力，非常适合实现字符串填充。我们可以使用%-Ns格式说明符来指定一个字符串左对齐并填充到N个字符的宽度。

• %: 格式说明符的起始标志。
• -: 表示左对齐。如果省略，则默认右对齐。
• N: 一个整数，指定输出字符串的总宽度。如果原始字符串长度小于N，则用空格填充；如果大于N，则原始字符串将完整输出（不会截断）。
• s: 表示要格式化的是一个字符串。

实现自定义填充方法

为了更好地封装和复用，我们可以创建一个简单的辅助方法来处理字符串填充逻辑：

public static String padString(String s, int len) {
    // "%-len s" 表示左对齐，总宽度为 len 的字符串
    String formatString = "%-" + len + "s";
    return String.format(formatString, s);
}

这个padString方法接收一个字符串s和一个目标长度len，然后返回一个经过填充（如果需要）的字符串。

整合到表格打印逻辑

现在，我们可以将这个padString方法整合到表格的打印循环中，确保每一列都能获得固定的宽度。

以下是一个完整的Java示例，演示如何使用padString方法来打印一个整齐的股票信息表格：

package com.example.tableformatter;

public class TableFormatter {

    public static void main(String[] args) {
        String[] stockNameList = {"Saudi Aramco", "SABIC", "Alinam Bank", "Google Inc."};
        String[] stockSymbols = {"2222.SR", "2010.SR", "1150.SR", "GOOGL"};
        String[] previousClosingPrice = {"30.91", "89.29", "12.3", "1500.50"};
        String[] currentPrice = {"35.85", "88.8", "36.5", "1510.25"};
        // 假设 GetChangePercent 方法返回一个字符串
        String[] changePercent = {"-66.30%", "-0.55%", "197.56%", "0.65%"}; 

        // 定义每列的宽度
        int nameWidth = 20;
        int symbolWidth = 15;
        int prevPriceWidth = 20;
        int currPriceWidth = 15;
        int changePercentWidth = 15;

        // 打印表头
        System.out.println(
            padString("Stock Name", nameWidth) +
            padString("Stock Symbol", symbolWidth) +
            padString("Prev. Close Price", prevPriceWidth) +
            padString("Current Price", currPriceWidth) +
            padString("Change Percent", changePercentWidth)
        );
        // 打印分隔线（可选，增强可读性）
        System.out.println(
            "-".repeat(nameWidth) +
            "-".repeat(symbolWidth) +
            "-".repeat(prevPriceWidth) +
            "-".repeat(currPriceWidth) +
            "-".repeat(changePercentWidth)
        );

        // 循环打印数据行
        for (int i = 0; i < stockNameList.length; i++) {
            System.out.println(
                padString(stockNameList[i], nameWidth) +
                padString(stockSymbols[i], symbolWidth) +
                padString(previousClosingPrice[i], prevPriceWidth) +
                padString(currentPrice[i], currPriceWidth) +
                padString(changePercent[i], changePercentWidth)
            );
        }
    }

    /**
     * 将字符串填充到指定长度，左对齐。
     * 如果字符串长度小于 len，则用空格填充。
     * 如果字符串长度大于 len，则完整输出字符串（不截断）。
     *
     * @param s   要填充的字符串
     * @param len 目标总长度
     * @return 填充后的字符串
     */
    public static String padString(String s, int len) {
        // 使用 %-len s 格式化字符串：- 表示左对齐，len 表示总宽度，s 表示字符串类型
        String formatString = "%-" + len + "s";
        return String.format(formatString, s);
    }
}

运行上述代码，将得到如下整齐对齐的表格输出：

Stock Name          Stock Symbol   Prev. Close Price    Current Price  Change Percent 
-------------------------------------------------------------------------------------
Saudi Aramco        2222.SR        30.91               35.85          -66.30%        
SABIC               2010.SR        89.29               88.8           -0.55%         
Alinam Bank         1150.SR        12.3                36.5           197.56%        
Google Inc.         GOOGL          1500.50             1510.25        0.65%          

注意事项与最佳实践

1. 确定合适的列宽： 列宽的设定是关键。
   • 固定宽度： 对于已知数据范围的列，可以预设一个经验值。
   • 动态宽度： 更健壮的方法是首先遍历所有数据，找出每一列中最长字符串的长度，然后在此基础上增加少量余量作为该列的宽度。这样可以避免内容被截断，并适应不同长度的数据。
2. 处理超长字符串： String.format("%-Ns", s)在s的长度超过N时，不会截断s，而是完整输出。这可能导致该列超出预设宽度，进而影响后续列的对齐。如果需要严格控制宽度并截断超长内容，可以在padString方法内部增加截断逻辑：

   public static String padString(String s, int len) {
       if (s.length() > len) {
           return s.substring(0, len - 3) + "..."; // 截断并添加省略号
       }
       String formatString = "%-" + len + "s";
       return String.format(formatString, s);
   }

3. 可读性和模块化： 将字符串填充逻辑封装成独立的辅助方法（如padString）可以提高代码的复用性和可读性。对于更复杂的表格，可以考虑创建专门的表格打印工具类。
4. 性能考量： 对于极大量的数据，频繁的字符串拼接和格式化可能会有轻微的性能开销。但在大多数常规应用场景下，这种开销是可接受的。

总结

通过利用Java的String.format()方法和自定义的字符串填充函数，我们可以有效地解决在循环打印表格时遇到的列对齐问题。这种方法提供了灵活且精确的控制，使得生成的表格输出不仅数据准确，而且视觉上整洁有序，极大地提升了用户体验和信息的可读性。掌握这一技巧，对于任何需要输出格式化文本数据的Java开发者来说都非常实用。