在 Java 編程中，字符串格式化是一項基本且重要的技能。它允許開發(fā)者以特定的方式將各種類型的數(shù)據(jù)（如數(shù)字、日期、字符串等）轉換為字符串，以便于顯示、存儲或傳輸。

Java 提供了多種方法來實現(xiàn)字符串格式化，其中最常用的是 String.format()、Java 15 引入的 string.formatted() 實例方法，以及 PrintStream 和 PrintWriter 類中的 printf() 方法。

這些方法都依賴于 java.util.Formatter 類，該類使用類似于 C 語言 printf() 函數(shù)的格式代碼。

字符串格式化的方法

Java 提供了三種主要的字符串格式化方法，每種方法都有其特定的使用場景：

1.String.format()

這是一個靜態(tài)方法，用于創(chuàng)建一個格式化的字符串。它接受一個格式字符串和一系列參數(shù)，返回一個格式化后的字符串。適用于需要將格式化結果存儲為字符串的場景。

示例：

String str = String.format("Hello %s, today is %tF%n", "World", LocalDate.now());
System.out.println(str);

輸出示例：

Hello World, today is 2025-04-27

2.string.formatted()

從 Java 15 開始，字符串實例提供了一個 formatted() 方法，可以直接對字符串進行格式化。其功能與 String.format() 類似，但語法更簡潔，適合需要快速格式化的場景。

示例：

String str = "Hello %s, today is %tF%n".formatted("World", LocalDate.now());
System.out.println(str);

輸出示例：

Hello World, today is 2025-04-27

3.printf()

PrintStream 和 PrintWriter 類提供了 printf() 方法，可以直接將格式化的字符串輸出到流中（如控制臺或文件）。它適合需要立即輸出的場景。

示例：

System.out.printf("Hello %s, today is %tF%n", "World", LocalDate.now());

輸出示例：

Hello World, today is 2025-04-27

格式字符串的結構

格式字符串由普通字符和格式代碼組成。普通字符按原樣輸出，而格式代碼以 % 開頭，用于指定如何格式化參數(shù)。格式代碼的完整結構如下：

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

• argument_index$：可選，指定要格式化的參數(shù)索引（從 1 開始）。例如，%1$s 表示第一個參數(shù)作為字符串。
• flags：可選，控制輸出格式，如 - 表示左對齊，0 表示用 0 填充。
• width：可選，指定字段的最小寬度。
• .precision：可選，對于浮點數(shù)，指定小數(shù)點后位數(shù)；對于字符串，指定最大字符數(shù)。
• conversion：必須，指定數(shù)據(jù)類型，如 d（十進制整數(shù)）、f（浮點數(shù)）、s（字符串）等。

例如，%04d 表示將整數(shù)格式化為至少 4 位，不足時前面補 0；%4.2f 表示浮點數(shù)總寬度至少 4 位，小數(shù)點后 2 位。

常用格式代碼

以下是 java.util.Formatter 類支持的一些常用格式代碼：

對于某些代碼（如 %b、%c、%s），使用大寫形式（如 %S）會將結果轉換為大寫。

日期和時間格式化

日期和時間格式化使用 %t 前綴，后跟一個字符來指定具體格式。

以下是一些常用的日期/時間格式代碼：

日期格式化通常與 LocalDate、Date 或 Calendar 等對象一起使用。

需要注意的是，當對同一日期對象格式化多個字段時，必須為每個格式代碼指定參數(shù)索引（如 %1$tY）。

代碼示例

以下是一些實際應用中的格式化示例，涵蓋數(shù)字、字符串和日期。

1. 格式化數(shù)字

System.out.printf("%04d - the year of %f%n", 1956, Math.PI);

• 輸出：1956 - the year of 3.141593
• 說明：%04d 確保年份顯示為 4 位，前面補 0；%f 顯示浮點數(shù) Math.PI 的完整值。

2. 控制浮點數(shù)精度

System.out.printf("PI is approximately %4.2f%n", Math.PI);

• 輸出：PI is approximately 3.14
• 說明：%4.2f 指定浮點數(shù)總寬度至少 4 位，小數(shù)點后保留 2 位。

3. 格式化日期

LocalDate today = LocalDate.now();
System.out.printf("Today is %1$tB %1$td, %1$tY%n", today);

• 輸出示例：Today is April 27, 2025
• 說明：%1$tB 顯示月份名稱，%1$td 顯示日期，%1$tY 顯示年份，1$ 確保使用同一個 LocalDate 對象。

4. 使用參數(shù)索引重復格式化

System.out.printf("%1$tY-%1$tm-%1$td%n", LocalDate.now());

• 輸出示例：2025-04-27
• 說明：通過 1$ 指定使用第一個參數(shù)（LocalDate.now()），分別提取年、月、日。

5. 寫入文件

try (Formatter formatter = new Formatter("output.txt")) {
    formatter.format("Price: $%5.2f%n", 27.99);
}

說明：將格式化結果寫入文件 output.txt，內(nèi)容為 Price: $27.99。

最佳實踐和注意事項

• 安全性：避免使用用戶提供的格式字符串，因為格式字符串可能被惡意構造，導致安全漏洞。例如，攻擊者可能利用格式代碼訪問不應訪問的數(shù)據(jù)。始終對用戶輸入進行驗證和清理。
• 國際化：在多語言應用中，直接使用日期格式代碼（如 %tB）可能不適合所有地區(qū)，因為不同語言對日期的顯示順序和格式有不同要求。建議使用 java.time.format.DateTimeFormatter 來處理國際化日期格式化。
• 平臺無關性：使用 %n 作為換行符，而不是硬編碼 \n，因為 %n 會根據(jù)運行平臺自動選擇正確的換行符。
• 性能：對于高性能場景，避免頻繁創(chuàng)建 Formatter 對象。可以復用 Formatter 實例或直接使用 String.format() 和 printf()。

關于 StringTemplate 的說明

Java 21 和 22 引入了 StringTemplate 作為預覽功能，旨在提供更簡潔的字符串插值方式，例如 STR."Hello \{name}"。然而，由于設計上的問題，該功能在 Java 23 中被撤回。根據(jù) Java StringTemplate Discussion，開發(fā)團隊正在探索更安全和優(yōu)雅的實現(xiàn)方案，但目前尚無明確的時間表。

總結

Java 的字符串格式化工具通過 Formatter 類及其相關方法，為開發(fā)者提供了強大的數(shù)據(jù)格式化能力。無論是格式化數(shù)字、字符串還是日期，String.format()、string.formatted() 和 printf() 都能滿足各種需求。通過掌握格式代碼的結構和用法，開發(fā)者可以編寫更清晰、更高效的代碼。然而，在使用時需注意安全性和國際化問題，以確保代碼的健壯性和可移植性。

格式代碼種類繁多，本文僅介紹了最常用的部分。欲了解完整列表，請參閱 Java Formatter Documentation。

以上為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。

最新評論